Foundation package for the Pomm database framework.
PHP
Clone or download
chanmix51 Merge pull request #101 from sanpii/test-lowest-requirements
allow tests with lower requirements
Latest commit 53b7261 Feb 22, 2018

README.md

Foundation

Latest Stable Version Scrutinizer Code Quality Build Status Monthly Downloads License

This is the experimental branch of the foundation component of Pomm Project.

What is Foundation ?

Foundation is the main block of Pomm database framework. It makes clients able to communicate either with the database or with each others through a session. One of these clients -- the query manager -- can make Foundation to be used as DBAL replacement. If you are looking for a library to use PostgreSQL in your web development, you might want to look at Pomm’s model manager. If you want to create a custom database access layer or just perform SQL queries, Foundation is the right tool.

Foundation provides out of the box:

  • Converters (all built-in Postgresql types are supported + arrays, HStore etc.) see this SO comment.
  • Prepared Queries.
  • Parametrized queries.
  • Seekable iterators on results.
  • LISTEN / NOTIFY asynchronous messages support.
  • Service manager for easy integration with dependency injection containers.

See more with code examples on this blog post.

Requirements

  • PHP 5.5
    • mod-pgsql (not PDO)
  • Postgresql 9.2 (should be working with 9.1 but it is not tested anymore).

Installation

Pomm components are available on packagist using composer. To install and use Pomm's foundation, add a require line to "pomm-project/foundation" in your composer.json file.

Note: It is important the PHP configuration file defines the correct timezone setting. Pomm also sets the PostgreSQL connection to this timezone to prevent time shifts between the application and the database.

Documentation

Foundation’s documentation is available either online or directly in the documentation folder of the project.

Tests

This package uses Atoum as unit test framework. The tests are located in sources/tests. The test suite needs to access the database to ensure that read and write operations are made in a consistent manner. You need to set up a database for that and fill the sources/tests/config.php file with the according DSN. For convenience, Foundation provides two classes that extend Atoum with a Session:

  • PommProject\Foundation\Tester\VanillaSessionAtoum
  • PommProject\Foundation\Tester\FoundationSessionAtoum

Making your test class to extend one of these will grant them with a buildSession method that returns a newly created session. Clients of these classes must implement a initializeSession(Session $session) method (even a blank one). It is often a good idea to provide a fixture class as a session client, this method is the right place to register it.

Known bugs

Unfortunately there is a bug we can not fix easily or without degrading performances of the whole stack:

  • The ConvertedResultIterator can not recognize custom composite types when they are defined in schemas other than public. This is because the pg_type function does not return the schema the type belongs to. There are not turns around unless the schema is inspected manually by issuing a lot of queries. (see #53)