• Home
• Cake
• ORM
• Query

PHP Class Cake\ORM\Query

Show file Open project: cakephp/orm Class Usage Examples

Protected Properties

Property	Type	Description
$_autoFields	boolean	Tracks whether or not the original query should include fields from the top level table.
$_beforeFindFired	boolean	True if the beforeFind event has already been triggered for this query
$_counter	callable	A callable function that can be used to calculate the total amount of records this query will match when not using limit
$_eagerLoader	Cake\ORM\EagerLoader	Instance of a class responsible for storing association containments and for eager loading them when this query is executed
$_hasFields	boolean	Whether the user select any fields before being executed, this is used to determined if any fields should be automatically be selected.
$_hydrate	boolean	Whether to hydrate results into entity objects
$_resultsCount	integer	When set, count query execution will be bypassed.

Public Methods

Method	Description
__call ( $method, $arguments )	{@inheritDoc}
__clone ( ) : void	Object clone hook.
__construct ( Cake\Datasource\ConnectionInterface $connection, Table $table )	Constructor
__debugInfo ( )	{@inheritDoc}
addDefaultTypes ( Table $table )	Hints this object to associate the correct types when casting conditions for the database. This is done by extracting the field types from the schema associated to the passed table object. This prevents the user from repeating himself when specifying conditions.
all ( )	{@inheritDoc}
applyOptions ( array $options )	{@inheritDoc}
autoFields ( boolean | null $value = null ) : boolean | $this	Get/Set whether or not the ORM should automatically append fields.
cache ( $key, $config = 'default' )	{@inheritDoc}
cleanCopy ( ) : Query	Creates a copy of this current query, triggers beforeFind and resets some state.
contain ( array | string | null $associations = null, boolean $override = false ) : array | $this	Sets the list of associations that should be eagerly loaded along with this query. The list of associated tables passed must have been previously set as associations using the Table API.
count ( )	{@inheritDoc}
counter ( callable | null $counter )	Registers a callable function that will be executed when the count method in this query is called. The return value for the function will be set as the return value of the count method.
delete ( string | null $table = null )	Create a delete query.
eagerLoader ( Cake\ORM\EagerLoader $instance = null ) : Cake\ORM\EagerLoader | $this	Sets the instance of the eager loader class to use for loading associations and storing containments. If called with no arguments, it will return the currently configured instance.
find ( $finder, array $options = [] )	{@inheritDoc}
hydrate ( boolean | null $enable = null ) : boolean | $this	Toggle hydrating entities.
innerJoinWith ( string $assoc, callable $builder = null )	Creates an INNER JOIN with the passed association table while preserving the foreign key matching and the custom conditions that were originally set for it.
insert ( array $columns, array $types = [] )	Create an insert query.
jsonSerialize ( ) : Cake\Datasource\ResultSetInterface	Executes the query and converts the result set into JSON.
leftJoinWith ( string $assoc, callable $builder = null )	Creates a LEFT JOIN with the passed association table while preserving the foreign key matching and the custom conditions that were originally set for it.
matching ( string $assoc, callable $builder = null )	Adds filtering conditions to this query to only bring rows that have a relation to another from an associated table, based on conditions in the associated table.
notMatching ( string $assoc, callable $builder = null )	Adds filtering conditions to this query to only bring rows that have no match to another from an associated table, based on conditions in the associated table.
select ( array | Cake\Database\ExpressionInterface | string | Table | Cake\ORM\Association $fields = [], boolean $overwrite = false )	{@inheritDoc}
sql ( ValueBinder $binder = null )	{@inheritDoc}
triggerBeforeFind ( ) : void	Trigger the beforeFind event on the query's repository object.
update ( string | null $table = null )	Create an update query.

Protected Methods

Method	Description
_addAssociationsToTypeMap ( Table $table, Cake\Database\TypeMap $typeMap, array $associations ) : void	Used to recursively add contained association column types to the query.
_addDefaultFields ( ) : void	Inspects if there are any set fields for selecting, otherwise adds all the fields for the default table.
_addDefaultSelectTypes ( ) : void	Sets the default types for converting the fields in the select clause
_decorateResults ( Traversable $result ) : Cake\Datasource\ResultSetInterface	Decorates the results iterator with MapReduce routines and formatters
_dirty ( ) : void	Marks a query as dirty, removing any preprocessed information from in memory caching such as previous results
_execute ( ) : Cake\ORM\ResultSet	Executes this query and returns a ResultSet object containing the results.
_performCount ( ) : integer	Performs and returns the COUNT(*) for the query.
_transformQuery ( ) : void	Applies some defaults to the query object before it is executed.

Private Methods

Method	Description
_all ( )
_applyDecorators ( )
_cache ( )
_call ( )

Method Details

Property Details