AddressQuery
- Type
- Class
- Namespace
- craft\elements\db
- Inherits
- craft\elements\db\AddressQuery » craft\elements\db\ElementQuery » craft\db\Query » yii\db\Query » yii\base\Component » yii\base\BaseObject
- Implements
- ArrayAccess, IteratorAggregate, craft\elements\db\ElementQueryInterface, yii\base\Configurable, yii\db\ExpressionInterface, yii\db\QueryInterface
- Uses traits
- craft\base\ClonefixTrait, yii\base\ArrayableTrait, yii\db\QueryTrait
- Since
- 4.0.0
AddressQuery represents a SELECT SQL statement for categories in a way that is independent of DBMS.
Public Properties
| Property | Description |
|---|---|
| addressLine1 | string, null – Narrows the query results based on the first address line the addresses have. |
| addressLine2 | string, null – Narrows the query results based on the second address line the addresses have. |
| addressLine3 | string, null – Narrows the query results based on the third address line the addresses have. |
| administrativeArea | mixed – Narrows the query results based on the administrative areas the addresses belongs to. |
| allowOwnerDrafts | boolean, null – Whether the owner elements can be drafts. |
| allowOwnerRevisions | boolean, null – Whether the owner elements can be revisions. |
| ancestorDist | integer, null – The maximum number of levels that results may be separated from ancestorOf(). |
| ancestorOf | integer, craft\base\ElementInterface, null – The element (or its ID) that results must be an ancestor of. |
| archived | boolean – Whether to return only archived elements. |
| asArray | boolean – Whether to return each element as an array. |
| behaviors | yii\base\Behavior – List of behaviors attached to this component. |
| cacheTags | string[] |
| cachedResult | craft\base\ElementInterface[], null – $elements The resulting elements, or null if setCachedResult() was never called or the criteria has changed |
| countryCode | mixed – The address countryCode(s) that the resulting address must be in. |
| criteria | array |
| customFields | craft\base\FieldInterface[], null – The fields that may be involved in this query. |
| dateCreated | mixed – When the resulting elements must have been created. |
| dateUpdated | mixed – When the resulting elements must have been last updated. |
| dependentLocality | string, null – Narrows the query results based on the dependent locality the addresses belong to. |
| descendantDist | integer, null – The maximum number of levels that results may be separated from descendantOf(). |
| descendantOf | integer, craft\base\ElementInterface, null – The element (or its ID) that results must be a descendant of. |
| distinct | boolean – Whether to select distinct rows of data only. |
| draftCreator | integer, null – The drafts’ creator ID |
| draftId | integer, null – The ID of the draft to return (from the drafts table) |
| draftOf | mixed – The source element ID that drafts should be returned for. |
| drafts | boolean, null – Whether draft elements should be returned. |
| eagerLoadAlias | string, null – The eager-loading alias that should be used. |
| eagerLoadHandle | string, null – The handle that could be used to eager-load the query's target elmeents. |
| eagerLoadSourceElement | craft\base\ElementInterface, null – The source element that this query is fetching relations for. |
| eagerly | boolean – Whether the query should be used to eager-load results for the $eagerSourceElement and any other elements in its collection. |
| elementType | string – The name of the craft\base\ElementInterface class. |
| emulateExecution | boolean – Whether to emulate the actual query execution, returning empty or false results. |
| fieldId | mixed – The field ID(s) that the resulting addresses must belong to. |
| firstName | string, null – Narrows the query results based on the first name the addresses have. |
| fixedOrder | boolean – Whether results should be returned in the order specified by id(). |
| from | array, null – The table(s) to be selected from. |
| fullName | string, null – Narrows the query results based on the full name the addresses have. |
| groupBy | array, null – How to group the query results. |
| hasDescendants | boolean, null – Whether the resulting elements must have descendants. |
| having | string, array, yii\db\ExpressionInterface, null – The condition to be applied in the GROUP BY clause. |
| id | mixed – The element ID(s). |
| ignorePlaceholders | boolean – Whether to ignore placeholder elements when populating the results. |
| inBulkOp | string, null – The bulk element operation key that the resulting elements were involved in. |
| inReverse | boolean – Whether the results should be queried in reverse. |
| indexBy | string, callable, null – The name of the column by which the query results should be indexed by. |
| iterator | ArrayIterator |
| join | array, null – How to join with other tables. |
| lastName | string, null – Narrows the query results based on the last name the addresses have. |
| leaves | boolean – Whether the elements must be “leaves” in the structure. |
| level | mixed – The element’s level within the structure |
| limit | integer, yii\db\ExpressionInterface, null – Maximum number of records to be returned. |
| locality | string, null – Narrows the query results based on the locality the addresses belong to. |
| nextSiblingOf | integer, craft\base\ElementInterface, null – The element (or its ID) that the result must be the next sibling of. |
| offset | integer, yii\db\ExpressionInterface, null – Zero-based offset from where the records are to be returned. |
| orderBy | array, null – How to sort the query results. |
| organization | string, null – Narrows the query results based on the organization the addresses have. |
| organizationTaxId | string, null – Narrows the query results based on the tax ID the addresses have. |
| ownerId | mixed – The owner element ID(s) that the resulting addresses must belong to. |
| params | array, null – List of query parameter values indexed by parameter placeholders. |
| positionedAfter | integer, craft\base\ElementInterface, null – The element (or its ID) that the results must be positioned after. |
| positionedBefore | integer, craft\base\ElementInterface, null – The element (or its ID) that the results must be positioned before. |
| postalCode | string, null – Narrows the query results based on the postal code the addresses belong to. |
| preferSites | array, null – Determines which site should be selected when querying multi-site elements. |
| prevSiblingOf | integer, craft\base\ElementInterface, null – The element (or its ID) that the result must be the previous sibling of. |
| primaryOwnerId | mixed – The primary owner element ID(s) that the resulting addresses must belong to. |
| provisionalDrafts | boolean, null – Whether provisional drafts should be returned. |
| query | craft\db\Query, null – The query object created by prepare() |
| queryCacheDependency | yii\caching\Dependency, null – The dependency to be associated with the cached query result for this query |
| queryCacheDuration | integer, boolean, null – The default number of seconds that query results can remain valid in cache. |
| rawSql | string |
| ref | mixed – The reference code(s) used to identify the element(s). |
| relatedTo | mixed – The element relation criteria. |
| revisionCreator | integer, null – The revisions’ creator ID |
| revisionId | integer, null – The ID of the revision to return (from the revisions table) |
| revisionOf | integer, null – The source element ID that revisions should be returned for |
| revisions | boolean, null – Whether revision elements should be returned. |
| savedDraftsOnly | boolean – Whether only unpublished drafts which have been saved after initial creation should be included in the results. |
| search | mixed – The search term to filter the resulting elements by. |
| select | array, null – The columns being selected. |
| selectOption | string, null – Additional option that should be appended to the 'SELECT' keyword. |
| siblingOf | integer, craft\base\ElementInterface, null – The element (or its ID) that the results must be a sibling of. |
| site | string, string[], craft\models\Site – The site(s) that resulting elements must be returned in |
| siteId | mixed – The site ID(s) that the elements should be returned in, or '*' if elements should be returned in all supported sites. |
| siteSettingsId | mixed – The element ID(s) in the elements_sites table. |
| slug | mixed – The slug that resulting elements must have. |
| sortingCode | string, null – Narrows the query results based on the sorting code the addresses have. |
| status | string, string[], null – The status(es) that the resulting elements must have. |
| structureId | mixed – The structure ID that should be used to join in the structureelements table. |
| subQuery | craft\db\Query, null – The subselect’s query object created by prepare() |
| tablesUsedInFrom | string[] – Table names indexed by aliases. |
| title | mixed – The title that resulting elements must have. |
| trashed | boolean, null – Whether to return trashed (soft-deleted) elements. |
| uid | mixed – The element UID(s). |
| union | array, null – This is used to construct the UNION clause(s) in a SQL statement. |
| unique | boolean – Whether only elements with unique IDs should be returned by the query. |
| uri | mixed – The URI that the resulting element must have. |
| where | string, array, yii\db\ExpressionInterface, null – Query condition. |
| with | string, array, null – The eager-loading declaration. |
| withQueries | array, null – This is used to construct the WITH section in a SQL query. |
| withStructure | boolean, null – Whether element structure data should automatically be left-joined into the query. |
addressLine1
Narrows the query results based on the first address line the addresses have.
Example
php
// fetch addresses by address line 1
$addresses = \craft\elements\Address::find()
->addressLine1('23 Craft st')
->all();twig
{# fetch addresses by address line 1 #}
{% set addresses = craft.addresses()
.addressLine1('23 Craft st')
.all() %}addressLine2
Narrows the query results based on the second address line the addresses have.
Example
php
// fetch addresses by address line 2
$addresses = \craft\elements\Address::find()
->addressLine2('Apt 5B')
->all();twig
{# fetch addresses by address line 2 #}
{% set addresses = craft.addresses()
.addressLine2('Apt 5B')
.all() %}addressLine3
Narrows the query results based on the third address line the addresses have.
Example
php
// fetch addresses by address line 3
$addresses = \craft\elements\Address::find()
->addressLine3('Suite 212')
->all();twig
{# fetch addresses by address line 3 #}
{% set addresses = craft.addresses()
.addressLine3('Suite 212')
.all() %}administrativeArea
- Type
mixed- Default value
null- Since
- 5.0.0
Narrows the query results based on the administrative areas the addresses belongs to.
Example
php
// fetch addresses that are located in Western Australia
$addresses = \craft\elements\Address::find()
->administrativeArea('WA')
->all();twig
{# fetch addresses that are located in Western Australia #}
{% set addresses = craft.addresses()
.administrativeArea('WA')
.all() %}allowOwnerDrafts
Whether the owner elements can be drafts.
allowOwnerRevisions
Whether the owner elements can be revisions.
countryCode
- Type
mixed- Default value
null- Since
- 5.0.0
The address countryCode(s) that the resulting address must be in.
Example
php
// fetch addresses that are located in AU
$addresses = \craft\elements\Address::find()
->countryCode('AU')
->all();twig
{# fetch addresses that are located in AU #}
{% set addresses = craft.addresses()
.countryCode('AU')
.all() %}dependentLocality
Narrows the query results based on the dependent locality the addresses belong to.
Example
php
// fetch addresses by dependent locality
$addresses = \craft\elements\Address::find()
->dependentLocality('Darlington')
->all();twig
{# fetch addresses by dependent locality #}
{% set addresses = craft.addresses()
.dependentLocality('Darlington')
.all() %}fieldId
- Type
mixed- Default value
null- Since
- 5.0.0
The field ID(s) that the resulting addresses must belong to.
firstName
Narrows the query results based on the first name the addresses have.
Example
php
// fetch addresses by first name
$addresses = \craft\elements\Address::find()
->firstName('Doe')
->all();twig
{# fetch addresses by first name #}
{% set addresses = craft.addresses()
.firstName('Doe')
.all() %}fullName
Narrows the query results based on the full name the addresses have.
Example
php
// fetch addresses by full name
$addresses = \craft\elements\Address::find()
->fullName('John Doe')
->all();twig
{# fetch addresses by full name #}
{% set addresses = craft.addresses()
.fullName('John Doe')
.all() %}lastName
Narrows the query results based on the last name the addresses have.
Example
php
// fetch addresses by last name
$addresses = \craft\elements\Address::find()
->lastName('Doe')
->all();twig
{# fetch addresses by last name #}
{% set addresses = craft.addresses()
.lastName('Doe')
.all() %}locality
Narrows the query results based on the locality the addresses belong to.
Example
php
// fetch addresses by locality
$addresses = \craft\elements\Address::find()
->locality('Perth')
->all();twig
{# fetch addresses by locality #}
{% set addresses = craft.addresses()
.locality('Perth')
.all() %}organization
Narrows the query results based on the organization the addresses have.
Example
php
// fetch addresses by organization
$addresses = \craft\elements\Address::find()
->organization('Pixel & Tonic')
->all();twig
{# fetch addresses by organization #}
{% set addresses = craft.addresses()
.organization('Pixel & Tonic')
.all() %}organizationTaxId
Narrows the query results based on the tax ID the addresses have.
Example
php
// fetch addresses by organization tax ID
$addresses = \craft\elements\Address::find()
->organizationTaxId('123-456-789')
->all();twig
{# fetch addresses by organization tax ID #}
{% set addresses = craft.addresses()
.organizationTaxId('123-456-789')
.all() %}ownerId
- Type
mixed- Default value
null
The owner element ID(s) that the resulting addresses must belong to.
postalCode
Narrows the query results based on the postal code the addresses belong to.
Example
php
// fetch addresses by postal code
$addresses = \craft\elements\Address::find()
->postalCode('10001')
->all();twig
{# fetch addresses by postal code #}
{% set addresses = craft.addresses()
.postalCode('10001')
.all() %}primaryOwnerId
- Type
mixed- Default value
null- Since
- 5.0.0
The primary owner element ID(s) that the resulting addresses must belong to.
sortingCode
Narrows the query results based on the sorting code the addresses have.
Example
php
// fetch addresses by sorting code
$addresses = \craft\elements\Address::find()
->sortingCode('ABCD')
->all();twig
{# fetch addresses by sorting code #}
{% set addresses = craft.addresses()
.sortingCode('ABCD')
.all() %}Protected Properties
| Property | Description |
|---|---|
| defaultOrderBy | array – The default orderBy() value to use if orderBy() is empty but not null. |
Public Methods
| Method | Description |
|---|---|
| __call() | Calls the named method which is not a class method. |
| __clone() | This method is called after the object is created by cloning an existing one. |
| __construct() | Constructor |
| __get() | Returns the value of a component property. |
| __isset() | Checks if a property is set, i.e. defined and not null. |
| __set() | Sets the value of a component property. |
| __toString() | Returns the SQL representation of Query |
| __unset() | Sets a component property to be null. |
| addGroupBy() | Adds additional group-by columns to the existing ones. |
| addOrderBy() | Adds additional ORDER BY columns to the query. |
| addParams() | Adds additional parameters to be bound to the query. |
| addSelect() | Add more columns to the SELECT part of the query. |
| addressLine1() | Narrows the query results based on the first address line the addresses have. |
| addressLine2() | Narrows the query results based on the second address line the addresses have. |
| addressLine3() | Narrows the query results based on the third address line the addresses have. |
| administrativeArea() | Narrows the query results based on the administrative areas the addresses belongs to. |
| afterPopulate() | Performs any post-population processing on elements. |
| all() | |
| allowOwnerDrafts() | Narrows the query results based on whether the addresses’ owners are drafts. |
| allowOwnerRevisions() | Narrows the query results based on whether the addresses’ owners are revisions. |
| ancestorDist() | Narrows the query results to only {elements} that are up to a certain distance away from the {element} specified by ancestorOf(). |
| ancestorOf() | Narrows the query results to only {elements} that are ancestors of another {element} in its structure. |
| andFilterCompare() | Adds a filtering condition for a specific column and allow the user to choose a filter operator. |
| andFilterHaving() | Adds an additional HAVING condition to the existing one but ignores empty operands. |
| andFilterWhere() | Adds an additional WHERE condition to the existing one but ignores empty operands. |
| andHaving() | Adds an additional HAVING condition to the existing one. |
| andRelatedTo() | Narrows the query results to only {elements} that are related to certain other elements. |
| andWhere() | Adds an additional WHERE condition to the existing one. |
| andWith() | Causes the query to return matching {elements} eager-loaded with related elements, in addition to the elements that were already specified by with(). |
| anyStatus() | Sets the status param to null. |
| archived() | Sets the archived property. |
| asArray() | Causes the query to return matching {elements} as arrays of data, rather than [[{element-class}]] objects. |
| attachBehavior() | Attaches a behavior to this component. |
| attachBehaviors() | Attaches a list of behaviors to the component. |
| average() | Returns the average of the specified column values. |
| batch() | Starts a batch query. |
| behaviors() | Returns a list of behaviors that this component should behave as. |
| cache() | Enables query cache for this Query. |
| canGetProperty() | Returns a value indicating whether a property can be read. |
| canSetProperty() | Returns a value indicating whether a property can be set. |
| className() | Returns the fully qualified name of this class. |
| clearCachedResult() | Clears the cached result. |
| collect() | |
| column() | Executes the query and returns the first column of the result. |
| count() | Returns the number of records. |
| countryCode() | Narrows the query results based on the country the addresses belong to. |
| create() | Creates a new Query object and copies its property values from an existing one. |
| createCommand() | Creates a DB command that can be used to execute this query. |
| createElement() | |
| criteriaAttributes() | Returns the query's criteria attributes. |
| dateCreated() | Narrows the query results based on the {elements}’ creation dates. |
| dateUpdated() | Narrows the query results based on the {elements}’ last-updated dates. |
| dependentLocality() | Narrows the query results based on the dependent locality the addresses belong to. |
| descendantDist() | Narrows the query results to only {elements} that are up to a certain distance away from the {element} specified by descendantOf(). |
| descendantOf() | Narrows the query results to only {elements} that are descendants of another {element} in its structure. |
| detachBehavior() | Detaches a behavior from the component. |
| detachBehaviors() | Detaches all behaviors from the component. |
| distinct() | Sets the value indicating whether to SELECT DISTINCT or not. |
| draftCreator() | Narrows the query results to only drafts created by a given user. |
| draftId() | Narrows the query results based on the {elements}’ draft’s ID (from the drafts table). |
| draftOf() | Narrows the query results to only drafts of a given {element}. |
| drafts() | Narrows the query results to only drafts {elements}. |
| each() | Starts a batch query and retrieves data row by row. |
| eagerly() | Causes the query to be used to eager-load results for the query’s source element and any other elements in its collection. |
| emulateExecution() | Sets whether to emulate query execution, preventing any interaction with data storage. |
| ensureBehaviors() | Makes sure that the behaviors declared in behaviors() are attached to this component. |
| exists() | Returns a value indicating whether the query result contains any row of data. |
| extraFields() | Returns the list of fields that can be expanded further and returned by toArray(). |
| field() | Narrows the query results based on the field the addresses are contained by. |
| fieldId() | Narrows the query results based on the field the addresses are contained by, per the fields’ IDs. |
| fields() | Returns the list of fields that should be returned by default by toArray() when no specific fields are specified. |
| filterHaving() | Sets the HAVING part of the query but ignores empty operands. |
| filterWhere() | Sets the WHERE part of the query but ignores empty operands. |
| firstName() | Narrows the query results based on the first name the addresses have. |
| fixedOrder() | Causes the query results to be returned in the order specified by id(). |
| from() | Sets the FROM part of the query. |
| fullName() | Narrows the query results based on the full name the addresses have. |
| getBehavior() | Returns the named behavior object. |
| getBehaviors() | Returns all behaviors attached to this component. |
| getCacheTags() | |
| getCachedResult() | Returns the resulting elements set by setCachedResult(), if the criteria params haven’t changed since then. |
| getCriteria() | Returns an array of the current criteria attribute values. |
| getIterator() | Required by the IteratorAggregate interface. |
| getRawSql() | Shortcut for createCommand()->getRawSql(). |
| getTablesUsedInFrom() | Returns table names used in from() indexed by aliases. |
| groupBy() | Sets the GROUP BY part of the query. |
| hasDescendants() | Narrows the query results based on whether the {elements} have any descendants in their structure. |
| hasEventHandlers() | Returns a value indicating whether there is any handler attached to the named event. |
| hasMethod() | Returns a value indicating whether a method is defined. |
| hasProperty() | Returns a value indicating whether a property is defined for this component. |
| having() | Sets the HAVING part of the query. |
| id() | Narrows the query results based on the {elements}’ IDs. |
| ids() | Executes the query and returns the IDs of the resulting elements. |
| ignorePlaceholders() | Causes the query to return matching {elements} as they are stored in the database, ignoring matching placeholder elements that were set by craft\services\Elements::setPlaceholderElement(). |
| inBulkOp() | Narrows the query results to only {elements} that were involved in a bulk element operation. |
| inReverse() | Causes the query results to be returned in reverse order. |
| indexBy() | Sets the indexBy() property. |
| init() | Initializes the object. |
| innerJoin() | Appends an INNER JOIN part to the query. |
| isJoined() | Returns whether a given table has been joined in this query. |
| join() | Appends a JOIN part to the query. |
| language() | Determines which site(s) the {elements} should be queried in, based on their language. |
| lastName() | Narrows the query results based on the last name the addresses have. |
| leaves() | Narrows the query results based on whether the {elements} are “leaves” ({elements} with no descendants). |
| leftJoin() | Appends a LEFT OUTER JOIN part to the query. |
| level() | Narrows the query results based on the {elements}’ level within the structure. |
| limit() | Determines the number of {elements} that should be returned. |
| locality() | Narrows the query results based on the locality the addresses belong to. |
| max() | Returns the maximum of the specified column values. |
| min() | Returns the minimum of the specified column values. |
| nextSiblingOf() | Narrows the query results to only the {element} that comes immediately after another {element} in its structure. |
| noCache() | Disables query cache for this Query. |
| nth() | |
| off() | Detaches an existing event handler from this component. |
| offset() | Determines how many {elements} should be skipped in the results. |
| offsetExists() | Required by the ArrayAccess interface. |
| offsetGet() | Required by the ArrayAccess interface. |
| offsetSet() | Required by the ArrayAccess interface. |
| offsetUnset() | Required by the ArrayAccess interface. |
| on() | Attaches an event handler to an event. |
| one() | |
| orFilterHaving() | Adds an additional HAVING condition to the existing one but ignores empty operands. |
| orFilterWhere() | Adds an additional WHERE condition to the existing one but ignores empty operands. |
| orHaving() | Adds an additional HAVING condition to the existing one. |
| orWhere() | Adds an additional WHERE condition to the existing one. |
| orderBy() | Determines the order that the {elements} should be returned in. (If empty, defaults to {default-order-by}, or the order defined by the section if the \craft\elements\db\section() or \craft\elements\db\sectionId params are set to a single Structure section.) |
| organization() | Narrows the query results based on the organization the addresses have. |
| organizationTaxId() | Narrows the query results based on the tax ID the addresses have. |
| owner() | Sets the ownerId() parameter based on a given owner element. |
| ownerId() | Narrows the query results based on the addresses’ owner elements, per their IDs. |
| pairs() | Executes the query and returns the first two columns in the results as key/value pairs. |
| params() | Sets the parameters to be bound to the query. |
| populate() | Converts the raw query results into the format as specified by this query. |
| positionedAfter() | Narrows the query results to only {elements} that are positioned after another {element} in its structure. |
| positionedBefore() | Narrows the query results to only {elements} that are positioned before another {element} in its structure. |
| postalCode() | Narrows the query results based on the postal code the addresses belong to. |
| preferSites() | If unique() is set, this determines which site should be selected when querying multi-site elements. |
| prepForEagerLoading() | Prepares the query for lazy eager loading. |
| prepare() | Prepares for building SQL. |
| prepareSubquery() | Prepares the element query and returns its subquery (which determines what elements will be returned). |
| prevSiblingOf() | Narrows the query results to only the {element} that comes immediately before another {element} in its structure. |
| primaryOwner() | Sets the primaryOwnerId() and siteId() parameters based on a given element. |
| primaryOwnerId() | Narrows the query results based on the primary owner element of the addresses, per the owners’ IDs. |
| provisionalDrafts() | Narrows the query results to only provisional drafts. |
| ref() | Narrows the query results based on a reference string. |
| relatedTo() | Narrows the query results to only {elements} that are related to certain other elements. |
| render() | Executes the query and renders the resulting elements using their partial templates. |
| revisionCreator() | Narrows the query results to only revisions created by a given user. |
| revisionId() | Narrows the query results based on the {elements}’ revision’s ID (from the revisions table). |
| revisionOf() | Narrows the query results to only revisions of a given {element}. |
| revisions() | Narrows the query results to only revision {elements}. |
| rightJoin() | Appends a RIGHT OUTER JOIN part to the query. |
| savedDraftsOnly() | Narrows the query results to only unpublished drafts which have been saved after initial creation. |
| scalar() | Returns the query result as a scalar value. |
| search() | Narrows the query results to only {elements} that match a search query. |
| select() | Sets the SELECT part of the query. |
| setCachedResult() | Sets the resulting elements. |
| siblingOf() | Narrows the query results to only {elements} that are siblings of another {element} in its structure. |
| site() | Determines which site(s) the {elements} should be queried in. |
| siteId() | Determines which site(s) the {elements} should be queried in, per the site’s ID. |
| siteSettingsId() | Narrows the query results based on the {elements}’ IDs in the elements_sites table. |
| slug() | Narrows the query results based on the {elements}’ slugs. |
| sortingCode() | Narrows the query results based on the sorting code the addresses have. |
| status() | Narrows the query results based on the {elements}’ statuses. |
| structureId() | Determines which structure data should be joined into the query. |
| sum() | Returns the sum of the specified column values. |
| title() | Narrows the query results based on the {elements}’ titles. |
| toArray() | Converts the model into an array. |
| trashed() | Narrows the query results to only {elements} that have been soft-deleted. |
| trigger() | Triggers an event. |
| uid() | Narrows the query results based on the {elements}’ UIDs. |
| union() | Appends a SQL statement using UNION operator. |
| unique() | Determines whether only elements with unique IDs should be returned by the query. |
| uri() | Narrows the query results based on the {elements}’ URIs. |
| wasCountEagerLoaded() | Returns whether the query result count was already eager loaded by the query's source element. |
| wasEagerLoaded() | Returns whether the query results were already eager loaded by the query's source element. |
| where() | Sets the WHERE part of the query. |
| with() | Causes the query to return matching {elements} eager-loaded with related elements. |
| withQuery() | Prepends a SQL statement using WITH syntax. |
| withStructure() | Explicitly determines whether the query should join in the structure data. |
addressLine1()
- Since
- 5.0.0
Narrows the query results based on the first address line the addresses have.
Possible values include:
| Value | Fetches addresses… |
|---|---|
'23 Craft st' | with a addressLine1 of 23 Craft st. |
'*23*' | with a addressLine1 containing 23. |
'23*' | with a addressLine1 beginning with 23. |
Arguments
Returns
static – Self reference
Example
twig
{# Fetch addresses at 23 Craft st #}
{% set {elements-var} = {twig-method}
.addressLine1('23 Craft st')
.all() %}php
// Fetch addresses at 23 Craft st
${elements-var} = {php-method}
->addressLine1('23 Craft st')
->all();addressLine2()
- Since
- 5.0.0
Narrows the query results based on the second address line the addresses have.
Possible values include:
| Value | Fetches addresses… |
|---|---|
'Apt 5B' | with an addressLine2 of Apt 5B. |
'*5B*' | with an addressLine2 containing 5B. |
'5B*' | with an addressLine2 beginning with 5B. |
Arguments
Returns
static – Self reference
Example
twig
{# Fetch addresses at Apt 5B #}
{% set {elements-var} = {twig-method}
.addressLine2('Apt 5B')
.all() %}php
// Fetch addresses at Apt 5B
${elements-var} = {php-method}
->addressLine2('Apt 5B')
->all();addressLine3()
- Since
- 5.0.0
Narrows the query results based on the third address line the addresses have.
Possible values include:
| Value | Fetches addresses… |
|---|---|
'Suite 212' | with an addressLine3 of Suite 212. |
'*Suite*' | with an addressLine3 containing Suite. |
'Suite*' | with an addressLine3 beginning with Suite. |
Arguments
Returns
static – Self reference
Example
twig
{# Fetch addresses at Suite 212 #}
{% set {elements-var} = {twig-method}
.addressLine3('Suite 212')
.all() %}php
// Fetch addresses at Suite 212
${elements-var} = {php-method}
->addressLine3('Suite 212')
->all();administrativeArea()
- Since
- 5.0.0
Narrows the query results based on the administrative areas the addresses belongs to.
Possible values include:
| Value | Fetches addresses… |
|---|---|
'WA' | with a administrative area of WA. |
'not WA' | not in a administrative area of WA. |
['WA', 'SA'] | in a administrative area of WA or SA. |
['not', 'WA', 'SA'] | not in a administrative area of WA or SA. |
Arguments
Returns
static – Self reference
Example
twig
{# Fetch addresses in Western Australia #}
{% set {elements-var} = {twig-method}
.administrativeArea('WA')
.all() %}php
// Fetch addresses in Western Australia
${elements-var} = {php-method}
->administrativeArea('WA')
->all();all()
Arguments
$db
Returns
craft\elements\Address[], array –
allowOwnerDrafts()
- Since
- 5.0.0
Narrows the query results based on whether the addresses’ owners are drafts.
Possible values include:
| Value | Fetches addresses… |
|---|---|
true | which can belong to a draft. |
false | which cannot belong to a draft. |
Arguments
Returns
static – Self reference
allowOwnerRevisions()
- Since
- 5.0.0
Narrows the query results based on whether the addresses’ owners are revisions.
Possible values include:
| Value | Fetches addresses… |
|---|---|
true | which can belong to a revision. |
false | which cannot belong to a revision. |
Arguments
Returns
static – Self reference
collect()
Arguments
$db
Returns
\craft\elements\ElementCollection<\craft\elements\Address> –
countryCode()
Narrows the query results based on the country the addresses belong to.
Possible values include:
| Value | Fetches addresses… |
|---|---|
'AU' | with a countryCode of AU. |
'not US' | not in a countryCode of US. |
['AU', 'US'] | in a countryCode of AU or US. |
['not', 'AU', 'US'] | not in a countryCode of AU or US. |
Arguments
Returns
static – Self reference
Example
twig
{# Fetch Australian addresses #}
{% set {elements-var} = {twig-method}
.countryCode('AU')
.all() %}php
// Fetch Australian addresses
${elements-var} = {php-method}
->countryCode('AU')
->all();createElement()
Arguments
$row
dependentLocality()
- Since
- 5.0.0
Narrows the query results based on the dependent locality the addresses belong to.
Possible values include:
| Value | Fetches addresses… |
|---|---|
'Darlington' | with a dependentLocality of Darlington. |
'*Darling*' | with a dependentLocality containing Darling. |
'Dar*' | with a dependentLocality beginning with Dar. |
Arguments
Returns
static – Self reference
Example
twig
{# Fetch addresses in Darlington #}
{% set {elements-var} = {twig-method}
.dependentLocality('Darlington')
.all() %}php
// Fetch addresses in Darlington
${elements-var} = {php-method}
->dependentLocality('Darlington')
->all();field()
- Since
- 5.0.0
Narrows the query results based on the field the addresses are contained by.
Possible values include:
| Value | Fetches {elements}… |
|---|---|
'foo' | in a field with a handle of foo. |
['foo', 'bar'] | in a field with a handle of foo or bar. |
an \craft\elements\db\craft\fields\Addresses object | in a field represented by the object. |
Arguments
$value(mixed) – The property value
Returns
static – Self reference
Example
twig
{# Fetch {elements} in the Foo field #}
{% set {elements-var} = {twig-method}
.field('foo')
.all() %}php
// Fetch {elements} in the Foo field
${elements-var} = {php-method}
->field('foo')
->all();fieldId()
- Since
- 5.0.0
Narrows the query results based on the field the addresses are contained by, per the fields’ IDs.
Possible values include:
| Value | Fetches addresses… |
|---|---|
1 | in a field with an ID of 1. |
'not 1' | not in a field with an ID of 1. |
[1, 2] | in a field with an ID of 1 or 2. |
['not', 1, 2] | not in a field with an ID of 1 or 2. |
Arguments
$value(mixed) – The property value
Returns
static – Self reference
Example
twig
{# Fetch addresses in the field with an ID of 1 #}
{% set {elements-var} = {twig-method}
.fieldId(1)
.all() %}php
// Fetch addresses in the field with an ID of 1
${elements-var} = {php-method}
->fieldId(1)
->all();firstName()
- Since
- 5.0.0
Narrows the query results based on the first name the addresses have.
Possible values include:
| Value | Fetches addresses… |
|---|---|
'John' | with a firstName of John. |
'*Joh*' | with a firstName containing Joh. |
'Joh*' | with a firstName beginning with Joh. |
Arguments
Returns
static – Self reference
Example
twig
{# Fetch addresses with first name John #}
{% set {elements-var} = {twig-method}
.firstName('John')
.all() %}php
// Fetch addresses with first name John
${elements-var} = {php-method}
->firstName('John')
->all();fullName()
- Since
- 5.0.0
Narrows the query results based on the full name the addresses have.
Possible values include:
| Value | Fetches addresses… |
|---|---|
'John Doe' | with a fullName of John Doe. |
'*Doe*' | with a fullName containing Doe. |
'John*' | with a fullName beginning with John. |
Arguments
Returns
static – Self reference
Example
twig
{# Fetch addresses for John Doe #}
{% set {elements-var} = {twig-method}
.fullName('John Doe')
.all() %}php
// Fetch addresses for John Doe
${elements-var} = {php-method}
->fullName('John Doe')
->all();lastName()
- Since
- 5.0.0
Narrows the query results based on the last name the addresses have.
Possible values include:
| Value | Fetches addresses… |
|---|---|
'Doe' | with a lastName of Doe. |
'*Do*' | with a lastName containing Do. |
'Do*' | with a lastName beginning with Do. |
Arguments
Returns
static – Self reference
Example
twig
{# Fetch addresses with last name Doe #}
{% set {elements-var} = {twig-method}
.lastName('Doe')
.all() %}php
// Fetch addresses with last name Doe
${elements-var} = {php-method}
->lastName('Doe')
->all();locality()
- Since
- 5.0.0
Narrows the query results based on the locality the addresses belong to.
Possible values include:
| Value | Fetches addresses… |
|---|---|
'Perth' | with a locality of Perth. |
'*Perth*' | with a locality containing Perth. |
'Ner*' | with a locality beginning with Per. |
Arguments
Returns
static – Self reference
Example
twig
{# Fetch addresses in Perth #}
{% set {elements-var} = {twig-method}
.locality('Perth')
.all() %}php
// Fetch addresses in Perth
${elements-var} = {php-method}
->locality('Perth')
->all();nth()
Arguments
$n$db
Returns
craft\elements\Address, array, null –
one()
Arguments
$db
Returns
craft\elements\Address, array, null –
organization()
- Since
- 5.0.0
Narrows the query results based on the organization the addresses have.
Possible values include:
| Value | Fetches addresses… |
|---|---|
'Pixel & Tonic' | with an organization of Pixel & Tonic. |
'*Pixel*' | with an organization containing Pixel. |
'Pixel*' | with an organization beginning with Pixel. |
Arguments
Returns
static – Self reference
Example
twig
{# Fetch addresses for Pixel & Tonic #}
{% set {elements-var} = {twig-method}
.organization('Pixel & Tonic')
.all() %}php
// Fetch addresses for Pixel & Tonic
${elements-var} = {php-method}
->organization('Pixel & Tonic')
->all();organizationTaxId()
- Since
- 5.0.0
Narrows the query results based on the tax ID the addresses have.
Possible values include:
| Value | Fetches addresses… |
|---|---|
'123-456-789' | with an organizationTaxId of 123-456-789. |
'*456*' | with an organizationTaxId containing 456. |
'123*' | with an organizationTaxId beginning with 123. |
Arguments
$value(string) – The property value
Returns
static – Self reference
Example
twig
{# Fetch addresses with tax ID 123-456-789 #}
{% set {elements-var} = {twig-method}
.organizationTaxId('123-456-789')
.all() %}php
// Fetch addresses with tax ID 123-456-789
${elements-var} = {php-method}
->organizationTaxId('123-456-789')
->all();owner()
Sets the ownerId() parameter based on a given owner element.
Arguments
$owner(craft\base\ElementInterface) – The owner element
Returns
static – Self reference
Example
twig
{# Fetch addresses for the current user #}
{% set {elements-var} = {twig-method}
.owner(currentUser)
.all() %}php
// Fetch addresses created for the current user
${elements-var} = {php-method}
->owner(Craft::$app->user->identity)
->all();ownerId()
Narrows the query results based on the addresses’ owner elements, per their IDs.
Possible values include:
| Value | Fetches addresses… |
|---|---|
1 | created for an element with an ID of 1. |
[1, 2] | created for an element with an ID of 1 or 2. |
Arguments
Returns
static – Self reference
Example
twig
{# Fetch addresses created for an element with an ID of 1 #}
{% set {elements-var} = {twig-method}
.ownerId(1)
.all() %}php
// Fetch addresses created for an element with an ID of 1
${elements-var} = {php-method}
->ownerId(1)
->all();postalCode()
- Since
- 5.0.0
Narrows the query results based on the postal code the addresses belong to.
Possible values include:
| Value | Fetches addresses… |
|---|---|
'10001' | with a postalCode of 10001. |
'*001*' | with a postalCode containing 001. |
'100*' | with a postalCode beginning with 100. |
Arguments
Returns
static – Self reference
Example
twig
{# Fetch addresses with postal code 10001 #}
{% set {elements-var} = {twig-method}
.postalCode('10001')
.all() %}php
// Fetch addresses with postal code 10001
${elements-var} = {php-method}
->postalCode('10001')
->all();primaryOwner()
- Since
- 5.0.0
Sets the primaryOwnerId() and siteId() parameters based on a given element.
Arguments
$primaryOwner(craft\base\ElementInterface) – The primary owner element
Returns
static – Self reference
Example
twig
{# Fetch addresses created for this entry #}
{% set {elements-var} = {twig-method}
.primaryOwner(myEntry)
.all() %}php
// Fetch addresses created for this entry
${elements-var} = {php-method}
->primaryOwner($myEntry)
->all();primaryOwnerId()
- Since
- 5.0.0
Narrows the query results based on the primary owner element of the addresses, per the owners’ IDs.
Possible values include:
| Value | Fetches addresses… |
|---|---|
1 | created for an element with an ID of 1. |
'not 1' | not created for an element with an ID of 1. |
[1, 2] | created for an element with an ID of 1 or 2. |
['not', 1, 2] | not created for an element with an ID of 1 or 2. |
Arguments
$value(mixed) – The property value
Returns
static – Self reference
Example
twig
{# Fetch addresses created for an element with an ID of 1 #}
{% set {elements-var} = {twig-method}
.primaryOwnerId(1)
.all() %}php
// Fetch addresses created for an element with an ID of 1
${elements-var} = {php-method}
->primaryOwnerId(1)
->all();sortingCode()
- Since
- 5.0.0
Narrows the query results based on the sorting code the addresses have.
Possible values include:
| Value | Fetches addresses… |
|---|---|
'ABCD' | with a sortingCode of ABCD. |
'*BC*' | with a sortingCode containing BC. |
'AB*' | with a sortingCode beginning with AB. |
Arguments
Returns
static – Self reference
Example
twig
{# Fetch addresses with sorting code ABCD #}
{% set {elements-var} = {twig-method}
.sortingCode('ABCD')
.all() %}php
// Fetch addresses with sorting code ABCD
${elements-var} = {php-method}
->sortingCode('ABCD')
->all();Protected Methods
| Method | Description |
|---|---|
| afterPrepare() | This method is called at the end of preparing an element query for the query builder. |
| beforePrepare() | This method is called at the beginning of preparing an element query for the query builder. |
| cacheTags() | Returns any cache invalidation tags that caches involving this element query should use as dependencies. |
| cleanUpTableNames() | Clean up table names and aliases Both aliases and names are enclosed into . |
| customFields() | Returns the fields that should take part in an upcoming elements query. |
| extractFieldsFor() | Extract nested fields from a fields collection for a given root field Nested fields are separated with dots (.). e.g: "item.id" The previous example would extract "id". |
| extractRootFields() | Extracts the root field names from nested fields. |
| fieldLayouts() | Returns the field layouts whose custom fields should be returned by customFields(). |
| filterCondition() | Removes empty operands from the given query condition. |
| getUnaliasedColumnsFromSelect() | |
| getUniqueColumns() | Returns unique column names excluding duplicates. |
| isEmpty() | Returns a value indicating whether the give value is "empty". |
| joinElementTable() | Joins in a table with an id column that has a foreign key pointing to elements.id. |
| normalizeOrderBy() | Normalizes format of ORDER BY data. |
| normalizeSelect() | Normalizes the SELECT columns passed to select() or addSelect(). |
| queryScalar() | Queries a scalar value by setting select() first. |
| resolveFields() | Determines which fields can be returned by toArray(). |
| setCommandCache() | Sets $command cache, if this query has enabled caching. |
| statusCondition() | Returns the condition that should be applied to the element query for a given status. |
beforePrepare()
This method is called at the beginning of preparing an element query for the query builder.
The main Query object being prepared for the query builder is available via query. The subselect’s Query object being prepared is available via subQuery. The role of the subselect query is to apply conditions to the query and narrow the result set down to just the elements that should actually be returned. The role of the main query is to join in any tables that should be included in the results, and select all of the columns that should be included in the results.
Returns
boolean – Whether the query should be prepared and returned to the query builder. If false, the query will be cancelled and no results will be returned.
Throws
cacheTags()
- Since
- 3.5.0
Returns any cache invalidation tags that caches involving this element query should use as dependencies.
Use the most specific tag(s) possible, to reduce the likelihood of pointless cache clearing.
When elements are created/updated/deleted, their craft\base\ElementInterface::getCacheTags() method will be called, and any caches that have those tags listed as dependencies will be invalidated.
Returns
string[]
fieldLayouts()
- Since
- 5.0.0
Returns the field layouts whose custom fields should be returned by customFields().