PHP Class RedBeanPHP\Finder

Service class to find beans. For the most part this class offers user friendly utility methods for interacting with the OODB::find() method, which is rather complex. This class can be used to find beans using plain old SQL queries.

Author: Gabor de Mooij and the RedBeanPHP Community

Show file Open project: gabordemooij/redbean Class Usage Examples

Protected Properties

Property	Type	Description
$redbean	redbeanphp\OODB
$toolbox	ToolBox

Public Methods

Method	Description
__construct ( ToolBox $toolbox )	Constructor.
find ( string $type, string $sql = NULL, array $bindings = [] ) : array	Finds a bean using a type and a where clause (SQL).
findAndExport ( string $type, string $sql = NULL, array $bindings = [] ) : array	Like find() but also exports the beans as an array.
findCollection ( string $type, string $sql, array $bindings = [] ) : redbeanphp\BeanCollection	Finds a BeanCollection using the repository.
findLast ( string $type, string $sql = NULL, array $bindings = [] ) : redbeanphp\OODBBean	Like find() but returns the last bean of the result array.
findLike ( string $type, array $conditions = [], string $sql = '' ) : array	Finds beans by its type and a certain criteria set.
findMulti ( string \| array $types, $sql, array $bindings = [], array $remappings = [], string $queryTemplate = ' %s.%s AS %s__%s' ) : array	Returns a hashmap with bean arrays keyed by type using an SQL query as its resource. Given an SQL query like 'SELECT movie., review. FROM movie.
findOne ( string $type, string $sql = NULL, array $bindings = [] ) : redbeanphp\OODBBean	Like find() but returns just one bean instead of an array of beans.
findOrCreate ( string $type, array $like = [] ) : redbeanphp\OODBBean	Finds or creates a bean.
findOrDispense ( string $type, string $sql = NULL, array $bindings = [] ) : array	Tries to find beans of a certain type, if no beans are found, it dispenses a bean of that type.

Method Details

__construct() public method

The Finder requires a toolbox.

public __construct ( ToolBox $toolbox )
$toolbox	ToolBox

find() public method

As with most Query tools in RedBean you can provide values to be inserted in the SQL statement by populating the value array parameter; you can either use the question mark notation or the slot-notation (:keyname).

public find ( string $type, string $sql = NULL, array $bindings = [] ) : array
$type	string	type the type of bean you are looking for
$sql	string	sql SQL query to find the desired bean, starting right after WHERE clause
$bindings	array	values array of values to be bound to parameters in query
return	array

findAndExport() public method

This method will perform a find-operation. For every bean in the result collection this method will call the export() method. This method returns an array containing the array representations of every bean in the result set.

See also: Finder::find

public findAndExport ( string $type, string $sql = NULL, array $bindings = [] ) : array
$type	string	type the type of bean you are looking for
$sql	string	sql SQL query to find the desired bean, starting right after WHERE clause
$bindings	array	values array of values to be bound to parameters in query
return	array

findCollection() public method

A bean collection can be used to retrieve one bean at a time using cursors - this is useful for processing large datasets. A bean collection will not load all beans into memory all at once, just one at a time.

public findCollection ( string $type, string $sql, array $bindings = [] ) : redbeanphp\BeanCollection
$type	string	the type of bean you are looking for
$sql	string	SQL query to find the desired bean, starting right after WHERE clause
$bindings	array	values array of values to be bound to parameters in query
return	redbeanphp\BeanCollection

findLast() public method

Opposite of Finder::findLast(). If no beans are found, this method will return NULL.

See also: Finder::find

public findLast ( string $type, string $sql = NULL, array $bindings = [] ) : redbeanphp\OODBBean
$type	string	the type of bean you are looking for
$sql	string	SQL query to find the desired bean, starting right after WHERE clause
$bindings	array	values array of values to be bound to parameters in query
return	redbeanphp\OODBBean

findLike() public method

Format of criteria set: property => value The criteria set also supports OR-conditions: property => array( value1, orValue2 ) If the additional SQL is a condition, this condition will be glued to the rest of the query using an AND operator. Note that this is as far as this method can go, there is no way to glue additional SQL using an OR-condition. This method provides access to an underlying mechanism in the RedBeanPHP architecture to find beans using criteria sets. However, please do not use this method for complex queries, use plain SQL instead ( the regular find method ) as it is more suitable for the job. This method is meant for basic search-by-example operations.

public findLike ( string $type, array $conditions = [], string $sql = '' ) : array
$type	string	type of bean to search for
$conditions	array	criteria set describing the bean to search for
$sql	string	additional SQL (for sorting)
return	array

findMulti() public method

.. JOIN review' this method will return movie and review beans. Example:


$stuff = $finder->findMulti('movie,review', '
         SELECT movie.*, review.* FROM movie
         LEFT JOIN review ON review.movie_id = movie.id');

After this operation, $stuff will contain an entry 'movie' containing all movies and an entry named 'review' containing all reviews (all beans). You can also pass bindings. If you want to re-map your beans, so you can use $movie->ownReviewList without having RedBeanPHP executing an SQL query you can use the fourth parameter to define a selection of remapping closures. The remapping argument (optional) should contain an array of arrays. Each array in the remapping array should contain the following entries:


array(
	'a'       => TYPE A
   'b'       => TYPE B
   'matcher' => MATCHING FUNCTION ACCEPTING A, B and ALL BEANS
   'do'      => OPERATION FUNCTION ACCEPTING A, B, ALL BEANS, ALL REMAPPINGS
)

Using this mechanism you can build your own 'preloader' with tiny function snippets (and those can be re-used and shared online of course). Example:


array(
	'a'       => 'movie'     //define A as movie
   'b'       => 'review'    //define B as review
   'matcher' => function( $a, $b ) {
      return ( $b->movie_id == $a->id );  //Perform action if review.movie_id equals movie.id
   }
   'do'      => function( $a, $b ) {
      $a->noLoad()->ownReviewList[] = $b; //Add the review to the movie
      $a->clearHistory();                 //optional, act 'as if these beans have been loaded through ownReviewList'.
   }
)

The Query Template parameter is optional as well but can be used to set a different SQL template (sprintf-style) for processing the original query.

public findMulti ( string \| array $types, $sql, array $bindings = [], array $remappings = [], string $queryTemplate = ' %s.%s AS %s__%s' ) : array
$types	string \| array	a list of types (either array or comma separated string)
$bindings	array	optional, bindings for SQL query
$remappings	array	optional, an array of remapping arrays
$queryTemplate	string	optional, query template
return	array

findOne() public method

This method will return only the first bean of the array. If no beans are found, this method will return NULL.

See also: Finder::find

public findOne ( string $type, string $sql = NULL, array $bindings = [] ) : redbeanphp\OODBBean
$type	string	type the type of bean you are looking for
$sql	string	sql SQL query to find the desired bean, starting right after WHERE clause
$bindings	array	values array of values to be bound to parameters in query
return	redbeanphp\OODBBean

findOrCreate() public method

Tries to find a bean with certain properties specified in the second parameter ($like). If the bean is found, it will be returned. If multiple beans are found, only the first will be returned. If no beans match the criteria, a new bean will be dispensed, the criteria will be imported as properties and this new bean will be stored and returned. Format of criteria set: property => value The criteria set also supports OR-conditions: property => array( value1, orValue2 )

public findOrCreate ( string $type, array $like = [] ) : redbeanphp\OODBBean
$type	string	type of bean to search for
$like	array	criteria set describing bean to search for
return	redbeanphp\OODBBean

findOrDispense() public method

Note that this function always returns an array.

See also: Finder::find

public findOrDispense ( string $type, string $sql = NULL, array $bindings = [] ) : array
$type	string	the type of bean you are looking for
$sql	string	SQL query to find the desired bean, starting right after WHERE clause
$bindings	array	values array of values to be bound to parameters in query
return	array

Property Details

$redbean protected property

protected OODB,redbeanphp $redbean
return	redbeanphp\OODB

$toolbox protected property

protected ToolBox,redbeanphp $toolbox
return	ToolBox