DatabaseQuerySelect class

A wrapper for SELECT SQL queries.

The intention behind these classes is to have a query that can safely be passed between methods and objects that add to it without knowledge of what other methods/objects have done to it. It also means being able to build a complex query without worrying about correct syntax placement.

This file is licensed under the MIT license

Below are Properties populated by DatabaseQuerySelect objects created by PageFinder. This is what gets passed to Fieldtype::getMatchQuery() method calls as properties available from the $query argument.

Click any linked item for full usage details and examples. Hookable methods are indicated with the icon. In addition to those shown below, the DatabaseQuerySelect class also inherits all the methods and properties of: DatabaseQuery, WireData and Wire.

Common
Properties

Common

Name	Return	Summary
DatabaseQuerySelect::from() DatabaseQuerySelect::from($sql) DatabaseQuerySelect::from($sql)	`$this`	Can also be used as property: DatabaseQuerySelect::from
DatabaseQuerySelect::getQuery() DatabaseQuerySelect::getQuery() DatabaseQuerySelect::getQuery()	None	Return the resulting SQL ready for execution with the database
DatabaseQuerySelect::groupby() DatabaseQuerySelect::groupby($sql) DatabaseQuerySelect::groupby($sql)	`$this`	Can also be used as property: DatabaseQuerySelect::groupby
DatabaseQuerySelect::join() DatabaseQuerySelect::join($sql) DatabaseQuerySelect::join($sql, $params = [])	`$this`	Can also be used as property: DatabaseQuerySelect::join
DatabaseQuerySelect::leftjoin() DatabaseQuerySelect::leftjoin($sql) DatabaseQuerySelect::leftjoin($sql, $params = [])	`$this`	Can also be used as property: DatabaseQuerySelect::leftjoin
DatabaseQuerySelect::limit() DatabaseQuerySelect::limit($sql) DatabaseQuerySelect::limit($sql)	`$this`	Can also be used as property: DatabaseQuerySelect::limit
DatabaseQuerySelect::orderby() DatabaseQuerySelect::orderby($value) DatabaseQuerySelect::orderby($value, bool $prepend = false)	`$this`	Add an ORDER BY section to the query Can also be used as property: DatabaseQuerySelect::orderby
DatabaseQuerySelect::select() DatabaseQuerySelect::select($sql) DatabaseQuerySelect::select($sql, $params = [])	`$this`	Can also be used as property: DatabaseQuerySelect::select
DatabaseQuerySelect::where() DatabaseQuerySelect::where($sql) DatabaseQuerySelect::where($sql, $params = [])	`$this`	Can also be used as property: DatabaseQuerySelect::where

Properties

Name	Return	Summary
DatabaseQuerySelect::comment	`string`	Comments for query
DatabaseQuerySelect::field	`Field`	Field object that is referenced by this query.
DatabaseQuerySelect::group	`string`	Selector group (for OR-groups) if applicable.
DatabaseQuerySelect::parentQuery	`DatabaseQuerySelect`	Parent query object, if applicable.
DatabaseQuerySelect::selector	`Selector`	Selector object referenced by this query.
DatabaseQuerySelect::selectors	`Selectors`	Original selectors (all) that $selector is part of.

Additional methods and properties

In addition to the methods and properties above, DatabaseQuerySelect also inherits the methods and properties of these classes:

API reference based on ProcessWire core version 3.0.251