Download the PHP package granadaorm/granada without Composer

Granada

Granada is a easy to use Active Record implementation, and ORM based on Idiorm/Paris.

A quick view

You can read the Paris Docs on paris.readthedocs.org but be sure to read the additions below.

Install

Using composer:

Configure it:

As always, you can check it in detail on Paris documentation

Additions

Eager loading

You can use the "with" method to add relationships eager loading to the query.

will use 3 querys to fetch the users and the relationships:

It is possible to get the relationships results for each result, this way

Lazy loading

Triying to access to a not fetched relationship will call and return it

Notice that if there is no result for avatar on the above example it will throw a Notice: Trying to get property of non-object... Note: Maybe worth the effort to create a NULL object for this use case and others.

Lazy finds

find_many_lazy() is find_many() for big tables. Use it when the result is too big to hold in memory, for example a report over many thousands of rows. The loop looks the same, but your script holds one model at a time:

The order and the array keys are the same as find_many() gives you.

The chunk size

The method loads the rows in chunks. The first argument is the chunk size. The default is 1000:

A smaller chunk uses less memory and runs more queries. A bigger chunk does the opposite. The results you get are identical.

Eager loading

with() works as usual. The relationship query runs once per chunk, not once per model:

Loop only once

The method returns a generator. A generator cannot restart. To loop again, call find_many_lazy() again. Each call runs the queries again, so the data may have changed.

Queries the method refuses

The method throws an exception when the query has one of these:

• group_by() - the method loads each row by its id, and a grouped row has no single id
• raw_query() - the method loads the rows by rebuilding the query, and it cannot rebuild raw SQL
• a join() plus a custom select() - the rows are loaded from the table alone, so the select may only name that table's columns

If you turned on return_result_sets, it does not apply here: the method always returns a generator.

For small results, keep using find_many().

Eager loading with query control

Use with_{relation}() to eager-load a relationship and optionally configure the query via a callback:

Mix with the existing with() method:

Nested eager loading via with_* inside the callback:

Auto-included columns. You don't need to specify the columns the ORM uses for matching. They are added automatically:

If you already include these columns in your select(), they won't be added twice.

Column names. Use comma-separated strings for multiple columns: select('id, name'). Do not use select('id', 'name') - the second argument is an alias.

has_many_through. Qualify column names with the table because the query involves a join:

Chained relationships with arguments for eager loading

It is possible to chain relationships and add arguments to the relationships calls

Custom query actions

We use a query class to build filters for a query. To add custom filters to a Query model, create a Query<ModelName> class that extends \Granada\Query.

and call it through q():

Multiple additions names for Granada

• select_raw
• group_by_raw
• order_by_raw
• raw_join
• insert : To create and save multiple elements from an array
• pluck : returns a single column from the result.
• find_pairs : Return array of key=>value as result
• delete_many (accept join clauses)
• update_many : writes the same values to every row the query matches

Overload SET

Mass assignment

create() and set() write every key they are given. There is no fillable or guarded list to declare: Granada does not know what is safe to write, and the model does not filter for you.

If the array comes from a request, keep only the fields the request was meant to set before it reaches the model:

Unknown keys are not dropped. They are stored like any other field, and the save fails with a database error if the column does not exist. Filtering request data is the caller's job, because the caller is the one who knows the fields the form offered.

Overload GET and MISSING property

Of course, you still can define functions with the property name if you want to overload it completely.

Define resultSet (collection type) class on Model

Now is possible to define the resultSet class returned for a model instances result. (if return_result_sets config variable is set to true) Notice that the resultSet class defined must extends Granada\ResultSet and must be loaded

ResultSets are defined by the model in the result, as you can see above. On eager load, the results are consistent. For example, if we have a Content model, with $resultSetClass = 'TreeResultSet' and a has_many relationship defined as media:

will return a TreeResultSet with instances of Content each with a property $media containing Granada\ResultSet (the default resultSet if none if defined on the Model)

Basic Documentation comes from Paris

Paris

Feature complete

Paris is now considered to be feature complete as of version 1.4.0. Whilst it will continue to be maintained with bug fixes there will be no further new features added.

A lightweight Active Record implementation for PHP5.

Built on top of Idiorm.

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

Released under a BSD license.

Features

• Extremely simple configuration.
• Exposes the full power of Idiorm's fluent query API.
• Supports associations.
• Simple mechanism to encapsulate common queries in filter methods.
• Built on top of PDO.
• Uses prepared statements throughout to protect against SQL injection attacks.
• 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 are supported

History

Granada was originally developed by Erik Wiesenthal, up to version 1.5. Further development started by Josh Marshall to release version 2.0