sad_spirit/pg_wrapper

This package has two parts and purposes

• Converter of PostgreSQL data types to their PHP equivalents and back and

• An object oriented wrapper around PHP’s native pgsql extension.

While the converter part can be used separately e.g. with PDO, features like transparent conversion of query results work only with the wrapper.

A similar wrapper for PDO is possible, but is neither implemented nor planned as it will have to depend on highly inefficient handling of column metadata in PDO_pgsql driver.

Contents:

• Overview
  • Usage examples
  • Requirements
  • Installation
  • Related packages
• Classes for complex PostgreSQL types
  • ArrayRepresentable interface
  • Range types
  • Multirange types
  • Geometric types
    • Box and LineSegment
    • Path and Polygon
    • Circle
    • Line
  • Tid
• Type converters
  • TypeConverter and related interfaces
  • Type converter implementations
  • Creating custom converters
    • BaseConverter
    • ContainerConverter
• Type converter factories
  • Common interface
  • StubTypeConverterFactory
  • DefaultTypeConverterFactory
    • Type specifications accepted
    • Additional methods
    • Type names supported out of the box
    • Classes mapped to database types
    • Converting enums
  • TypeOIDMapper interface and its implementation
    • CachedTypeOIDMapper
    • Why use OIDs and not type names directly?
• Setting up a database connection
  • Establishing connection
  • Connection-related methods
  • Configuration methods
• Executing queries
  • Passing query parameters
  • Specifying parameter types
  • Specifying result column types
  • Query-related methods of Connection
  • PreparedStatement API
    • Two ways to supply parameters
    • Fetching parameter types automatically
    • Specifying types manually
• Working with a query result
  • Result public API
  • Getting result metadata
  • Configuring row format
  • Getting the whole result as array
  • Custom iterators
• Transactions
  • Running a callable atomically
  • Performing actions after transaction
  • Transaction-related methods of Connection
    • Methods for manual transaction handling
    • Methods related to atomic()
• Exception classes
  • Base exception interface
  • Exceptions hierarchy
  • SqlState enum
• Adding functionality via decorators
  • Base classes for decorators
  • Logging decorators