README

http://j4mie.github.com/idiormandparis/

Feature complete

Idiorm is now considered to be feature complete as of version 1.5.0. Whilst it will continue to be maintained with bug fixes there will be no further new features added from this point on.

Please do not submit feature requests or pull requests adding new features as they will be closed without ceremony.

A lightweight nearly-zero-configuration object-relational mapper and fluent query builder for PHP5.

Tested on PHP 5.2.0+ - may work on earlier versions with PDO and the correct database drivers.

Released under a BSD license.

See Also: Paris, an Active Record implementation built on top of Idiorm.

Features

Makes simple queries and simple CRUD operations completely painless.
Gets out of the way when more complex SQL is required.
Built on top of PDO.
Uses prepared statements throughout to protect against SQL injection attacks.
Requires no model classes, no XML configuration and no code generation: works out of the box, given only a connection string.
Consists of one main class called ORM. Additional classes are prefixed with Idiorm. Minimal global namespace pollution.
Database agnostic. Currently supports SQLite, MySQL, Firebird and PostgreSQL. May support others, please give it a try!
Supports collections of models with method chaining to filter or apply actions to multiple results at once.
Multiple connections supported
PSR-1 compliant methods (any method can be called in camelCase instead of underscores eg. find_many() becomes findMany()) - you'll need PHP 5.3+

Documentation

The documentation is hosted on Read the Docs: idiorm.rtfd.org

Building the Docs

You will need to install Sphinx and then in the docs folder run:

make html

The documentation will now be in docs/_build/html/index.html

Let's See Some Code

$user = ORM::for_table('user')
    ->where_equal('username', 'j4mie')
    ->find_one();

$user->first_name = 'Jamie';
$user->save();

$tweets = ORM::for_table('tweet')
    ->select('tweet.*')
    ->join('user', array(
        'user.id', '=', 'tweet.user_id'
    ))
    ->where_equal('user.username', 'j4mie')
    ->find_many();

foreach ($tweets as $tweet) {
    echo $tweet->text;
}

Changelog

1.5.1 - release 2014-06-23

Binding of named parameters was broken [cainmi] - issue #221

1.5.0 - release 2014-06-22

Multiple OR'ed conditions support [lrlopez] - issue #201
where_id_in() for selecting multiple records by primary key [lrlopez] - issue #202
Add compound primary key support [lrlopez] - issue #171
Add a RAW JOIN source to the query [moiseevigor] - issue #163
offsetExists() should return true for null values, resolves #181 [cainmi] - issue #214
Custom cache callback functions [peter-mw] - issue #216
Restrict null primary keys on update/delete, resolves #203 [cainmi] - issue #205
Ensure parameters treated by type correctly [charsleysa] & [SneakyBobito] - issue #206 & issue #208
Reduce the type casting on aggregate functions to allow characters [herroffizier] - issue #150
Prevent invalid method calls from triggering infinite recursion [michaelward82] - issue #152
Add time to query logging - adds query time parameter to external logger callback function [AgelxNash] - issue #180
Changed database array access to ensure it's always properly setup [falmp] - issue #159
Allow unsetting the db (ORM::set_db(null)) to make the test work again [borrel] - issue #160
Correct issue #176: Ensure database setup before building select [kendru] - issue #197
Add HHVM to travis-ci build matrix [ptarjan] - issue #168
Improve where statement precendence documentation [thomasahle] - issue #190
Improve testing checks [charsleysa] - issue #173

1.4.1 - release 2013-12-12

Patch update to remove a broken pull request - may have consequences for users of 1.4.0 that exploited the "find_many() now returns an associative array with the databases primary ID as the array keys" change that was merged in 1.4.0.

Back out pull request/issue #133 as it breaks backwards compatibility in previously unexpected ways (see #162, #156 and #133) - sorry for merging this change into Idiorm - closes issue 156

1.4.0 - release 2013-09-05

find_many() now returns an associative array with the databases primary ID as the array keys [Surt] - issue #133
Calls to set() and set_expr() return $this allowing them to be chained [Surt]
Add PSR-1 compliant camelCase method calls to Idiorm (PHP 5.3+ required) [crhayes] - issue #108
Add static method get_config() to access current configuration [javierd] - issue #141
Add logging callback functionality [lalop] - issue #130
Add support for MS SQL TOP limit style (automatically used for PDO drivers: sqlsrv, dblib and mssql) [numkem] - issue #116
Uses table aliases in WHERE clauses [vicvicvic] - issue #140
Ignore result columns when calling an aggregate function [tassoevan] - issue #120
Improve documentation [bruston] - issue #111
Improve PHPDoc on get_db() [mailopl] - issue #106
Improve documentation [sjparsons] - issue #103
Make tests/bootstrap.php HHVM compatible [JoelMarcey] - issue #143
Fix docblock [ulrikjohansson] - issue #147
Fix incorrect variable name in querying documentation [fridde] - issue #146

1.3.0 - release 2013-01-31

Documentation moved to idiorm.rtfd.org and now built using Sphinx
Add support for multiple database connections - closes issue #15 [tag]
Add in raw_execute - closes issue #40 [tag]
Add get_last_statement() - closes issue #84 [tag]
Add HAVING clause functionality - closes issue #50
Add is_new method - closes issue #85
Add ArrayAccess support to the model instances allowing property access via $model['field'] as well as $model->field - issue #51
Add a result set object for collections of models that can support method chains to filter or apply actions to multiple results at once - issue #51 and #22
Add support for Firebird with ROWS and TO result set limiting and identifier quoting [mapner] - issue #98
Fix last insert ID for PostgreSQL using RETURNING - closes issues #62 and #89 [laacz]
Reset Idiorm after performing a query to allow for calling count() and then find_many() [fayland] - issue #97
Change Composer to use a classmap so that autoloading is better supported [javierd] - issue #96
Add query logging to delete_many [tag]
Fix when using set_expr alone it doesn't trigger query creation - closes issue #90
Escape quote symbols in "_quote_identifier_part" - close issue #74
Fix issue with aggregate functions always returning int when is float sometimes required - closes issue #92
Move testing into PHPUnit to unify method testing and query generation testing

1.2.3 - release 2012-11-28

Fix issue #78 - remove use of PHP 5.3 static call

1.2.2 - release 2012-11-15

Fix bug where input parameters were sent as part-indexed, part associative

1.2.1 - release 2012-11-15

Fix minor bug caused by IdiormStringException not extending Exception

1.2.0 - release 2012-11-14

Setup composer for installation via packagist (j4mie/idiorm)
Add order_by_expr method [sandermarechal]
Add support for raw queries without parameters argument [sandermarechal]
Add support to set multiple properties at once by passing an associative array to set method [sandermarechal]
Allow an associative array to be passed to configure method [jordanlev]
Patch to allow empty Paris models to be saved ([j4mie/paris]) - issue #58
Add select_many and select_many_expr - closing issues #49 and #69
Add support for MIN, AVG, MAX and SUM - closes issue #16
Add group_by_expr - closes issue #24
Add set_expr to allow database expressions to be set as ORM properties - closes issues #59 and #43 [brianherbert]
Prevent ambiguous column names when joining tables - issue #66 [hellogerard]
Add delete_many method [CBeerta]
Allow unsetting of ORM parameters [CBeerta]
Add find_array to get the records as associative arrays [Surt] - closes issue #17
Fix bug in _log_query with ? and % supplied in raw where statements etc. - closes issue #57 [ridgerunner]

1.1.1 - release 2011-01-30

Fix bug in quoting column wildcard. j4mie/paris#12
Small documentation improvements

1.1.0 - released 2011-01-24

Add is_dirty method
Add basic query caching
Add distinct method
Add group_by method

1.0.0 - released 2010-12-01

Initial release

yftzeng / idiorm

Maintainers

Details