| Property | Type | Description | |
|---|---|---|---|
| $checkAccess | |||
| $defaultOptions | Options (and their defaults) that may be provided as the 2nd argument to find() | ||
| $extraOrSelectors | |||
| $extraSubSelectors | one from each field must match | ||
| $fieldgroups | |||
| $getQueryNumChildren | |||
| $getTotal | |||
| $getTotalType | whether to find the total number of matches | ||
| $lastOptions | number of times the function has been called | ||
| $limit | |||
| $parent_id | |||
| $start | |||
| $templates_id | |||
| $total | May be: 'calc', 'count', or blank to auto-detect. |
| Method | Description | |
|---|---|---|
| ___find ( Selectors $selectors, array $options = [] ) : array | Return all pages matching the given selector. | |
| __construct ( ) | Construct the PageFinder | |
| findIDs ( Selectors $selectors, array $options = [] ) : array | Same as find() but returns just a simple array of page IDs without any other info | |
| getLimit ( ) | Returns the limit placed upon the last find() operation, or 0 if no limit was specified | |
| getOptions ( ) | Return array of the options provided to PageFinder, as well as those determined at runtime | |
| getParentID ( ) | Returns the parent ID, if it was part of the selector | |
| getStart ( ) | Returns the start placed upon the last find() operation | |
| getTemplatesID ( ) | Returns the templates ID, if it was part of the selector | |
| getTotal ( ) : integer | Returns the total number of results returned from the last find() operation |
| Method | Description | |
|---|---|---|
| ___getQuery ( array $selectors, array $options ) : DatabaseQuerySelect | Given one or more selectors, create the SQL query for finding pages. | |
| ___getQueryAllowedTemplatesWhere ( DatabaseQuerySelect $query, string $where ) : string | Method that allows external hooks to add to or modify the access control WHERE conditions | |
| ___getQueryJoinPath ( DatabaseQuerySelect $query, $selector ) | Special case when requested value is path or URL | |
| arrangeFields ( array $fields ) | Arrange the order of field names where necessary | |
| getQueryAllowedTemplates ( DatabaseQuerySelect $query, $options ) | Determine which templates the user is allowed to view | |
| getQueryHasParent ( DatabaseQuerySelect $query, $selector ) | Make the query specific to all pages below a certain parent (children, grandchildren, great grandchildren, etc.) | |
| getQueryNativeField ( DatabaseQuerySelect $query, Selector $selector, array $fields ) | Special case when field is native to the pages table | |
| getQueryNumChildren ( DatabaseQuerySelect $query, $selector ) | Match a number of children count | |
| getQuerySortSelector ( DatabaseQuerySelect $query, Selector $selector ) | ||
| getQueryStartLimit ( DatabaseQuerySelect $query, $selectors ) | ||
| postProcessQuery ( $parentQuery ) | ||
| preProcessSelector ( Selector $selector ) : boolean | Pre-process the given selector to perform any necessary replacements | |
| setupStatusChecks ( Selectors $selectors, array &$options ) | Pre-process the selectors to add Page status checks | |
| whereEmptyValuePossible ( Field $field, $selector, $query, string $value, string &$where ) : boolean | Generate SQL and modify $query for situations where it should be possible to match empty values |
| protected ___getQuery ( array $selectors, array $options ) : DatabaseQuerySelect | ||
| $selectors | array | Array of selectors. |
| $options | array | |
| return | DatabaseQuerySelect | |
| protected ___getQueryAllowedTemplatesWhere ( DatabaseQuerySelect $query, string $where ) : string | ||
| $query | DatabaseQuerySelect | |
| $where | string | SQL string for WHERE statement, not including the actual "WHERE" |
| return | string | |
| protected ___getQueryJoinPath ( DatabaseQuerySelect $query, $selector ) | ||
| $query | DatabaseQuerySelect | |
| protected arrangeFields ( array $fields ) | ||
| $fields | array | |
| public getLimit ( ) |
| public getOptions ( ) |
| public getParentID ( ) |
| protected getQueryAllowedTemplates ( DatabaseQuerySelect $query, $options ) | ||
| $query | DatabaseQuerySelect | |
| protected getQueryHasParent ( DatabaseQuerySelect $query, $selector ) | ||
| $query | DatabaseQuerySelect | |
| protected getQueryNativeField ( DatabaseQuerySelect $query, Selector $selector, array $fields ) | ||
| $query | DatabaseQuerySelect | |
| $selector | Selector | |
| $fields | array | |
| protected getQueryNumChildren ( DatabaseQuerySelect $query, $selector ) | ||
| $query | DatabaseQuerySelect | |
| protected getQuerySortSelector ( DatabaseQuerySelect $query, Selector $selector ) | ||
| $query | DatabaseQuerySelect | |
| $selector | Selector | |
| protected getQueryStartLimit ( DatabaseQuerySelect $query, $selectors ) | ||
| $query | DatabaseQuerySelect | |
| public getStart ( ) |
| public getTemplatesID ( ) |
| protected preProcessSelector ( Selector $selector ) : boolean | ||
| $selector | Selector | |
| return | boolean | Returns false if selector should be skipped over by getQuery() |
| protected setupStatusChecks ( Selectors $selectors, array &$options ) | ||
| $selectors | Selectors | |
| $options | array | |
| protected whereEmptyValuePossible ( Field $field, $selector, $query, string $value, string &$where ) : boolean | ||
| $field | Field | |
| $selector | ||
| $query | ||
| $value | string | The value presumed to be blank (passed the empty() test) |
| $where | string | SQL where string that will be modified/appended |
| return | boolean | Whether or not the query was handled and modified |
| protected $defaultOptions |
| protected $extraSubSelectors |
| protected $getTotalType |
| protected $lastOptions |