AssetQuery
- Type
- Class
- Namespace
- craft\elements\db
- Inherits
- craft\elements\db\AssetQuery » 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
- 3.0.0
AssetQuery represents a SELECT SQL statement for assets in a way that is independent of DBMS.
Public Properties
Property | Description |
---|---|
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\elements\db\TElement[] , null – $elements The resulting elements, or null if setCachedResult() was never called or the criteria has changed |
contentTable | string, null – The content table that will be joined by this query. |
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. |
dateModified | mixed – The Date Modified that the resulting assets must have. |
dateUpdated | mixed – When the resulting elements must have been last updated. |
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. |
editable | boolean, null – Whether to only return assets that the user has permission to view. |
elementType | class-string<\craft\elements\db\TElement> – The name of the craft\base\ElementInterface class. |
emulateExecution | boolean – Whether to emulate the actual query execution, returning empty or false results. |
filename | mixed – The filename(s) that the resulting assets must have. |
fixedOrder | boolean – Whether results should be returned in the order specified by id(). |
folderId | mixed – The asset folder ID(s) that the resulting assets must be in. |
folderPath | string, null – The folder path that resulting assets must live within |
from | array, null – The table(s) to be selected from. |
groupBy | array, null – How to group the query results. |
hasAlt | boolean, null – Whether the query should filter assets depending on whether they have alternative text. |
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. |
height | mixed – The height (in pixels) that the resulting assets must have. |
id | mixed – The element ID(s). |
ignorePlaceholders | boolean – Whether to ignore placeholder elements when populating the results. |
inReverse | boolean – Whether the results should be queried in reverse. |
includeSubfolders | boolean – Whether the query should search the subfolders of folderId(). |
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. |
kind | mixed – The file kind(s) that the resulting assets must be. |
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. |
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. |
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. |
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. |
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. |
savable | boolean, null – Whether to only return entries that the user has permission to save. |
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. |
size | mixed – The size (in bytes) that the resulting assets must have. |
slug | mixed – The slug that resulting elements must 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. |
uploaderId | integer, null – The user ID that the resulting assets must have been uploaded by. |
uri | mixed – The URI that the resulting element must have. |
volume | string, string[], craft\models\Volume, null – The volume(s) that resulting assets must belong to |
volumeId | mixed – The volume ID(s) that the resulting assets must be in. |
where | string, array, yii\db\ExpressionInterface, null – Query condition. |
width | mixed – The width (in pixels) that the resulting assets must have. |
with | string, array, null – The eager-loading declaration. |
withCustomFields | boolean – Whether custom fields should be factored into the query. |
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. |
withTransforms | mixed – The asset transform indexes that should be eager-loaded, if they exist |
dateModified
- Type
mixed
- Default value
null
The Date Modified that the resulting assets must have.
editable
Whether to only return assets that the user has permission to view.
filename
- Type
mixed
- Default value
null
The filename(s) that the resulting assets must have.
folderId
- Type
mixed
- Default value
null
The asset folder ID(s) that the resulting assets must be in.
folderPath
The folder path that resulting assets must live within
hasAlt
Whether the query should filter assets depending on whether they have alternative text.
height
- Type
mixed
- Default value
null
The height (in pixels) that the resulting assets must have.
Example
// fetch images that are at least 500 pixels high
$images = \craft\elements\Asset::find()
->kind('image')
->height('>= 500')
->all();
{# fetch images that are at least 500 pixes high #}
{% set logos = craft.assets()
.kind('image')
.height('>= 500')
.all() %}
includeSubfolders
- Type
- boolean
- Default value
false
Whether the query should search the subfolders of folderId().
kind
- Type
mixed
- Default value
null
The file kind(s) that the resulting assets must be.
Supported file kinds:
- access
- audio
- compressed
- excel
- flash
- html
- illustrator
- image
- javascript
- json
- photoshop
- php
- powerpoint
- text
- video
- word
- xml
- unknown
Example
// fetch only images
$logos = \craft\elements\Asset::find()
->kind('image')
->all();
{# fetch only images #}
{% set logos = craft.assets()
.kind('image')
.all() %}
savable
Whether to only return entries that the user has permission to save.
size
- Type
mixed
- Default value
null
The size (in bytes) that the resulting assets must have.
uploaderId
The user ID that the resulting assets must have been uploaded by.
volume
- Type
- string, string[], craft\models\Volume, null
- Default value
null
The volume(s) that resulting assets must belong to
volumeId
- Type
mixed
- Default value
null
The volume ID(s) that the resulting assets must be in.
Example
// fetch assets in the Logos volume
$logos = \craft\elements\Asset::find()
->volume('logos')
->all();
{# fetch assets in the Logos volume #}
{% set logos = craft.assets()
.volume('logos')
.all() %}
width
- Type
mixed
- Default value
null
The width (in pixels) that the resulting assets must have.
Example
// fetch images that are at least 500 pixels wide
$images = \craft\elements\Asset::find()
->kind('image')
->width('>= 500')
->all();
{# fetch images that are at least 500 pixes wide #}
{% set logos = craft.assets()
.kind('image')
.width('>= 500')
.all() %}
withTransforms
- Type
mixed
- Default value
null
The asset transform indexes that should be eager-loaded, if they exist
Example
// fetch images with their 'thumb' transforms preloaded
$images = \craft\elements\Asset::find()
->kind('image')
->withTransforms(['thumb'])
->all();
{# fetch images with their 'thumb' transforms preloaded #}
{% set logos = craft.assets()
.kind('image')
.withTransforms(['thumb'])
.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. |
afterPopulate() | Performs any post-population processing on elements. |
all() | Executes the query and returns all results as an array. |
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. |
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() | Converts a found row into an element instance. |
criteriaAttributes() | Returns the query's criteria attributes. |
dateCreated() | Narrows the query results based on the {elements}’ creation dates. |
dateModified() | Narrows the query results based on the assets’ files’ last-modified dates. |
dateUpdated() | Narrows the query results based on the {elements}’ last-updated dates. |
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. |
editable() | Sets the editable property. |
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(). |
fields() | Returns the list of fields that should be returned by default by toArray() when no specific fields are specified. |
filename() | Narrows the query results based on the assets’ filenames. |
filterHaving() | Sets the HAVING part of the query but ignores empty operands. |
filterWhere() | Sets the WHERE part of the query but ignores empty operands. |
fixedOrder() | Causes the query results to be returned in the order specified by id(). |
folderId() | Narrows the query results based on the folders the assets belong to, per the folders’ IDs. |
folderPath() | Narrows the query results based on the folders the assets belong to, per the folders’ paths. |
from() | Sets the FROM part of the query. |
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. |
hasAlt() | Narrows the query results based on whether the assets have alternative text. |
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. |
height() | Narrows the query results based on the assets’ image heights. |
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(). |
inReverse() | Causes the query results to be returned in reverse order. |
includeSubfolders() | Broadens the query results to include assets from any of the subfolders of the folder specified by folderId(). |
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. |
kind() | Narrows the query results based on the assets’ file kinds. |
language() | Determines which site(s) the {elements} should be queried in, based on their language. |
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. |
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() | Executes the query and returns a single row of result at a given offset. |
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() | Executes the query and returns a single row of result. |
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 category group if the \craft\elements\db\group() or \craft\elements\db\groupId() params are set to a single group.) |
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. |
preferSites() | If unique() is set, this determines which site should be selected when querying multi-site elements. |
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. |
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. |
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. |
savable() | Sets the savable property. |
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. |
size() | Narrows the query results based on the assets’ file sizes (in bytes). |
slug() | Narrows the query results based on the {elements}’ slugs. |
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. |
uploader() | Narrows the query results based on the user the assets were uploaded by, per the user’s IDs. |
uri() | Narrows the query results based on the {elements}’ URIs. |
volume() | Narrows the query results based on the volume the assets belong to. |
volumeId() | Narrows the query results based on the volumes the assets belong to, per the volumes’ IDs. |
where() | Sets the WHERE part of the query. |
width() | Narrows the query results based on the assets’ image widths. |
with() | Causes the query to return matching {elements} eager-loaded with related elements. |
withCustomFields() | Sets whether custom fields should be factored into the query. |
withQuery() | Prepends a SQL statement using WITH syntax. |
withStructure() | Explicitly determines whether the query should join in the structure data. |
withTransforms() | Causes the query to return matching assets eager-loaded with image transform indexes. |
__set()
Sets the value of a component property.
This method will check in the following order and act accordingly:
- a property defined by a setter: set the property value
- an event in the format of "on xyz": attach the handler to the event "xyz"
- a behavior in the format of "as xyz": attach the behavior named as "xyz"
- a property of a behavior: set the behavior property value
Do not call this method directly as it is a PHP magic method that will be implicitly called when executing $component->property = $value;
.
Arguments
$name
(string) – The property name or the event name$value
(mixed
) – The property value
Throws
- yii\base\UnknownPropertyException
if the property is not defined - yii\base\InvalidCallException
if the property is read-only.
afterPopulate()
- Since
- 3.6.0
Performs any post-population processing on elements.
Arguments
$elements
(craft\base\ElementInterface[], array[]) – The populated elements
Returns
craft\base\ElementInterface[], array[]
dateModified()
Narrows the query results based on the assets’ files’ last-modified dates.
Possible values include:
Value | Fetches assets… |
---|---|
'>= 2018-04-01' | that were modified on or after 2018-04-01. |
'< 2018-05-01' | that were modified before 2018-05-01. |
['and', '>= 2018-04-04', '< 2018-05-01'] | that were modified between 2018-04-01 and 2018-05-01. |
now /today /tomorrow /yesterday | that were modified at midnight of the specified relative date. |
Arguments
$value
(mixed
) – The property value
Returns
self
– Self reference
Example
{# Fetch assets modified in the last month #}
{% set start = date('30 days ago')|atom %}
{% set {elements-var} = {twig-method}
.dateModified(">= #{start}")
.all() %}
// Fetch assets modified in the last month
$start = (new \DateTime('30 days ago'))->format(\DateTime::ATOM);
${elements-var} = {php-method}
->dateModified(">= {$start}")
->all();
editable()
- Since
- 4.4.0
Sets the editable property.
Arguments
Returns
self
– Self reference
filename()
Narrows the query results based on the assets’ filenames.
Possible values include:
Value | Fetches assets… |
---|---|
'foo.jpg' | with a filename of foo.jpg . |
'foo*' | with a filename that begins with foo . |
'*.jpg' | with a filename that ends with .jpg . |
'*foo*' | with a filename that contains foo . |
'not *foo*' | with a filename that doesn’t contain foo . |
['*foo*', '*bar*'] | with a filename that contains foo or bar . |
['not', '*foo*', '*bar*'] | with a filename that doesn’t contain foo or bar . |
Arguments
$value
(mixed
) – The property value
Returns
self
– Self reference
Example
{# Fetch all the hi-res images #}
{% set {elements-var} = {twig-method}
.filename('*@2x*')
.all() %}
// Fetch all the hi-res images
${elements-var} = {php-method}
->filename('*@2x*')
->all();
folderId()
Narrows the query results based on the folders the assets belong to, per the folders’ IDs.
Possible values include:
Value | Fetches assets… |
---|---|
1 | in a folder with an ID of 1. |
'not 1' | not in a folder with an ID of 1. |
[1, 2] | in a folder with an ID of 1 or 2. |
['not', 1, 2] | not in a folder with an ID of 1 or 2. |
TIP
This can be combined with includeSubfolders() if you want to include assets in all the subfolders of a certain folder.
Arguments
$value
(mixed
) – The property value
Returns
self
– Self reference
Example
{# Fetch assets in the folder with an ID of 1 #}
{% set {elements-var} = {twig-method}
.folderId(1)
.all() %}
// Fetch assets in the folder with an ID of 1
${elements-var} = {php-method}
->folderId(1)
->all();
folderPath()
- Since
- 3.7.39
Narrows the query results based on the folders the assets belong to, per the folders’ paths.
Possible values include:
Value | Fetches assets… |
---|---|
foo/ | in a foo/ folder (excluding nested folders). |
foo/* | in a foo/ folder (including nested folders). |
'not foo/*' | not in a foo/ folder (including nested folders). |
['foo/*', 'bar/*'] | in a foo/ or bar/ folder (including nested folders). |
['not', 'foo/*', 'bar/*'] | not in a foo/ or bar/ folder (including nested folders). |
Arguments
$value
(mixed
) – The property value
Returns
self
– Self reference
Example
{# Fetch assets in the foo/ folder or its nested folders #}
{% set {elements-var} = {twig-method}
.folderPath('foo/*')
.all() %}
// Fetch assets in the foo/ folder or its nested folders
${elements-var} = {php-method}
->folderPath('foo/*')
->all();
hasAlt()
Narrows the query results based on whether the assets have alternative text.
Arguments
Returns
self
– Self reference
height()
Narrows the query results based on the assets’ image heights.
Possible values include:
Value | Fetches assets… |
---|---|
100 | with a height of 100. |
'>= 100' | with a height of at least 100. |
['>= 100', '<= 1000'] | with a height between 100 and 1,000. |
Arguments
$value
(mixed
) – The property value
Returns
self
– Self reference
Example
{# Fetch XL images #}
{% set {elements-var} = {twig-method}
.kind('image')
.height('>= 1000')
.all() %}
// Fetch XL images
${elements-var} = {php-method}
->kind('image')
->height('>= 1000')
->all();
includeSubfolders()
Broadens the query results to include assets from any of the subfolders of the folder specified by folderId().
WARNING
This will only work if folderId() was set to a single folder ID.
Arguments
$value
(boolean) – The property value (defaults to true)
Returns
self
– Self reference
Example
{# Fetch assets in the folder with an ID of 1 (including its subfolders) #}
{% set {elements-var} = {twig-method}
.folderId(1)
.includeSubfolders()
.all() %}
// Fetch assets in the folder with an ID of 1 (including its subfolders)
${elements-var} = {php-method}
->folderId(1)
->includeSubfolders()
->all();
kind()
Narrows the query results based on the assets’ file kinds.
Supported file kinds:
access
audio
compressed
excel
flash
html
illustrator
image
javascript
json
pdf
photoshop
php
powerpoint
text
video
word
xml
unknown
Possible values include:
Value | Fetches assets… |
---|---|
'image' | with a file kind of image . |
'not image' | not with a file kind of image .. |
['image', 'pdf'] | with a file kind of image or pdf . |
['not', 'image', 'pdf'] | not with a file kind of image or pdf . |
Arguments
$value
(mixed
) – The property value
Returns
self
– Self reference
Example
{# Fetch all the images #}
{% set {elements-var} = {twig-method}
.kind('image')
.all() %}
// Fetch all the images
${elements-var} = {php-method}
->kind('image')
->all();
savable()
- Since
- 4.4.0
Sets the savable property.
Arguments
Returns
self
– Self reference
size()
Narrows the query results based on the assets’ file sizes (in bytes).
Possible values include:
Value | Fetches assets… |
---|---|
1000 | with a size of 1,000 bytes (1KB). |
'< 1000000' | with a size of less than 1,000,000 bytes (1MB). |
['>= 1000', '< 1000000'] | with a size between 1KB and 1MB. |
Arguments
$value
(mixed
) – The property value
Returns
self
– Self reference
Example
{# Fetch assets that are smaller than 1KB #}
{% set {elements-var} = {twig-method}
.size('< 1000')
.all() %}
// Fetch assets that are smaller than 1KB
${elements-var} = {php-method}
->size('< 1000')
->all();
uploader()
- Since
- 3.4.0
Narrows the query results based on the user the assets were uploaded by, per the user’s IDs.
Possible values include:
Value | Fetches assets… |
---|---|
1 | uploaded by the user with an ID of 1. |
a craft\elements\User object | uploaded by the user represented by the object. |
Arguments
$value
(integer, craft\elements\User, null) – The property value
Returns
self
– Self reference
Example
{# Fetch assets uploaded by the user with an ID of 1 #}
{% set {elements-var} = {twig-method}
.uploader(1)
.all() %}
// Fetch assets uploaded by the user with an ID of 1
${elements-var} = {php-method}
->uploader(1)
->all();
volume()
Narrows the query results based on the volume the assets belong to.
Possible values include:
Value | Fetches assets… |
---|---|
'foo' | in a volume with a handle of foo . |
'not foo' | not in a volume with a handle of foo . |
['foo', 'bar'] | in a volume with a handle of foo or bar . |
['not', 'foo', 'bar'] | not in a volume with a handle of foo or bar . |
a craft\models\Volume object | in a volume represented by the object. |
Arguments
$value
(mixed
) – The property value
Returns
self
– Self reference
Example
{# Fetch assets in the Foo volume #}
{% set {elements-var} = {twig-method}
.volume('foo')
.all() %}
// Fetch assets in the Foo group
${elements-var} = {php-method}
->volume('foo')
->all();
volumeId()
Narrows the query results based on the volumes the assets belong to, per the volumes’ IDs.
Possible values include:
Value | Fetches assets… |
---|---|
1 | in a volume with an ID of 1. |
'not 1' | not in a volume with an ID of 1. |
[1, 2] | in a volume with an ID of 1 or 2. |
['not', 1, 2] | not in a volume with an ID of 1 or 2. |
':empty:' | that haven’t been stored in a volume yet |
Arguments
$value
(mixed
) – The property value
Returns
self
– Self reference
Example
{# Fetch assets in the volume with an ID of 1 #}
{% set {elements-var} = {twig-method}
.volumeId(1)
.all() %}
// Fetch assets in the volume with an ID of 1
${elements-var} = {php-method}
->volumeId(1)
->all();
width()
Narrows the query results based on the assets’ image widths.
Possible values include:
Value | Fetches assets… |
---|---|
100 | with a width of 100. |
'>= 100' | with a width of at least 100. |
['>= 100', '<= 1000'] | with a width between 100 and 1,000. |
Arguments
$value
(mixed
) – The property value
Returns
self
– Self reference
Example
{# Fetch XL images #}
{% set {elements-var} = {twig-method}
.kind('image')
.width('>= 1000')
.all() %}
// Fetch XL images
${elements-var} = {php-method}
->kind('image')
->width('>= 1000')
->all();
withTransforms()
Causes the query to return matching assets eager-loaded with image transform indexes.
This can improve performance when displaying several image transforms at once, if the transforms have already been generated.
Transforms can be specified as their handle or an object that contains width
and/or height
properties.
You can include srcset
-style sizes (e.g. 100w
or 2x
) following a normal transform definition, for example:
::: code
[{width: 1000, height: 600}, '1.5x', '2x', '3x']
[['width' => 1000, 'height' => 600], '1.5x', '2x', '3x']
:::
When a srcset
-style size is encountered, the preceding normal transform definition will be used as a reference when determining the resulting transform dimensions.
Arguments
Returns
self
– The query object itself
Example
{# Fetch assets with the 'thumbnail' and 'hiResThumbnail' transform data preloaded #}
{% set {elements-var} = {twig-method}
.kind('image')
.withTransforms(['thumbnail', 'hiResThumbnail'])
.all() %}
// Fetch assets with the 'thumbnail' and 'hiResThumbnail' transform data preloaded
${elements-var} = {php-method}
->kind('image')
->withTransforms(['thumbnail', 'hiResThumbnail'])
->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. |
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[]