OrderQuery

Type
Class
Namespace
craft\commerce\elements\db
Inherits
craft\commerce\elements\db\OrderQuery » craft\elements\db\ElementQuery » craft\db\Query » yii\db\Query » yii\base\Component » yii\base\BaseObject
Implements
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
2.0

OrderQuery represents a SELECT SQL statement for orders in a way that is independent of DBMS.

View source

Public Properties

PropertyDescription
$ancestorDistinteger, null – The maximum number of levels that results may be separated from ancestorOf().
$ancestorOfinteger, craft\base\ElementInterface, null – The element (or its ID) that results must be an ancestor of.
$archivedboolean – Whether to return only archived elements.
$asArrayboolean – Whether to return each element as an array.
$behaviorsyii\base\Behavior – List of behaviors attached to this component
$cachedResultcraft\base\ElementInterface, null – $elements The resulting elements, or null if setCachedResult() was never called or the criteria has changed
$contentTablestring, null – The content table that will be joined by this query.
$criteriaarray
$customFieldscraft\base\FieldInterface, null – The fields that may be involved in this query.
$customerIdboolean – The completion status that the resulting orders must have.
$dateCreatedmixed – When the resulting elements must have been created.
$dateOrderedmixed – The Date Ordered date that the resulting orders must have.
$datePaidmixed – The date the order was paid.
$dateUpdatedmixed – When the resulting elements must have been last updated.
$descendantDistinteger, null – The maximum number of levels that results may be separated from descendantOf().
$descendantOfinteger, craft\base\ElementInterface, null – The element (or its ID) that results must be a descendant of.
$distinctboolean – Whether to select distinct rows of data only.
$elementTypestring, null – The name of the \craft\commerce\elements\db\ElementInterface class.
$emailstring – The email address the resulting emails must have.
$emulateExecutionboolean – Whether to emulate the actual query execution, returning empty or false results.
$enabledForSiteboolean – Whether the elements must be enabled for the chosen site.
$expiryDatemixed – The Expiry Date that the resulting orders must have.
$fixedOrderboolean – Whether results should be returned in the order specified by id().
$fromarray – The table(s) to be selected from.
$gatewayIdinteger – The gateway ID that the resulting orders must have.
$groupByarray – How to group the query results.
$hasDescendantsboolean, null – Whether the resulting elements must have descendants.
$hasPurchasablescraft\commerce\base\PurchasableInterface, craft\commerce\base\PurchasableInterface[] – The resulting orders must contain these Purchasables.
$havingstring, array, yii\db\ExpressionInterface – The condition to be applied in the GROUP BY clause.
$idinteger, integer[], false, null – The element ID(s).
$inReverseboolean – Whether the results should be queried in reverse.
$indexBystring, callable – The name of the column by which the query results should be indexed by.
$isCompletedboolean – The completion status that the resulting orders must have.
$isPaidboolean – The payment status the resulting orders must belong to.
$isUnpaidboolean – The payment status the resulting orders must belong to.
$iteratorArrayIterator
$joinarray – How to join with other tables.
$leavesboolean – Whether the elements must be “leaves” in the structure.
$levelmixed – The element’s level within the structure
$limitinteger, yii\db\ExpressionInterface – Maximum number of records to be returned.
$nextSiblingOfinteger, craft\base\ElementInterface, null – The element (or its ID) that the result must be the next sibling of.
$numberstring – The order number of the resulting entry.
$offsetinteger, yii\db\ExpressionInterface – Zero-based offset from where the records are to be returned.
$orderByarray – How to sort the query results.
$orderStatusIdinteger – The Order Status ID that the resulting orders must have.
$paramsarray – List of query parameter values indexed by parameter placeholders.
$positionedAfterinteger, craft\base\ElementInterface, null – The element (or its ID) that the results must be positioned after.
$positionedBeforeinteger, craft\base\ElementInterface, null – The element (or its ID) that the results must be positioned before.
$prevSiblingOfinteger, craft\base\ElementInterface, null – The element (or its ID) that the result must be the previous sibling of.
$querycraft\db\Query, null – The query object created by prepare()
$queryCacheDependencyyii\caching\Dependency – The dependency to be associated with the cached query result for this query
$queryCacheDurationinteger, true – The default number of seconds that query results can remain valid in cache.
$rawSqlstring
$refstring, string[], null – The reference code(s) used to identify the element(s).
$relatedTointeger, array, craft\base\ElementInterface, null – The element relation criteria.
$searchstring, array, craft\search\SearchQuery, null – The search term to filter the resulting elements by.
$selectarray – The columns being selected.
$selectOptionstring – Additional option that should be appended to the 'SELECT' keyword.
$siblingOfinteger, craft\base\ElementInterface, null – The element (or its ID) that the results must be a sibling of.
$siteIdinteger, null – The site ID that the elements should be returned in.
$slugstring, string[], null – The slug that resulting elements must have.
$statusstring, string[], null – The status(es) that the resulting elements must have.
$structureIdinteger, false, null – The structure ID that should be used to join in the structureelements table.
$subQuerycraft\db\Query, null – The subselect’s query object created by prepare()
$tablesUsedInFromstring[] – Table names indexed by aliases
$titlestring, string[], null – The title that resulting elements must have.
$uidstring, string[], null – The element UID(s).
$unionarray – This is used to construct the UNION clause(s) in a SQL statement.
$updatedOnmixed – The Updated On date that the resulting orders must have.
$uristring, string[], null – The URI that the resulting element must have.
$wherestring, array – Query condition.
$withstring, array, null – The eager-loading declaration.
$withStructureboolean, null – Whether element structure data should automatically be left-joined into the query.

$customerId

Type
boolean

The completion status that the resulting orders must have.

View source

Signature

public boolean $customerId = null

$dateOrdered

Type
mixed

The Date Ordered date that the resulting orders must have.

View source

Signature

public mixed $dateOrdered = null

$datePaid

Type
mixed

The date the order was paid.

View source

Signature

public mixed $datePaid = null

$email

Type
string

The email address the resulting emails must have.

View source

Signature

public string $email = null

$expiryDate

Type
mixed

The Expiry Date that the resulting orders must have.

View source

Signature

public mixed $expiryDate = null

$gatewayId

Type
integer

The gateway ID that the resulting orders must have.

View source

Signature

public integer $gatewayId = null

$hasPurchasables

Type
craft\commerce\base\PurchasableInterface, craft\commerce\base\PurchasableInterface[]

The resulting orders must contain these Purchasables.

View source

Signature

public craft\commerce\base\PurchasableInterface, craft\commerce\base\PurchasableInterface[] $hasPurchasables = null

$isCompleted

Type
boolean

The completion status that the resulting orders must have.

View source

Signature

public boolean $isCompleted = null

$isPaid

Type
boolean

The payment status the resulting orders must belong to.

View source

Signature

public boolean $isPaid = null

$isUnpaid

Type
boolean

The payment status the resulting orders must belong to.

View source

Signature

public boolean $isUnpaid = null

$number

Type
string

The order number of the resulting entry.

View source

Signature

public string $number = null

$orderStatusId

Type
integer

The Order Status ID that the resulting orders must have.

View source

Signature

public integer $orderStatusId = null

$updatedOn

Type
mixed

The Updated On date that the resulting orders must have.

View source

Signature

public mixed $updatedOn = null

Protected Properties

PropertyDescription
$defaultOrderByarray – The default orderBy() value to use if orderBy() is empty but not null.

Public Methods

MethodDescription
__call()Calls the named method which is not a class method.
__clone()
__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 an object property to 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.
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}.
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.
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()Clears out the status() and enabledForSite() parameters.
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.
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.
criteriaAttributes()Returns the query's criteria attributes.
customer()Narrows the query results based on the customer.
customerId()Narrows the query results based on the customer, per their ID.
dateCreated()Narrows the query results based on the {elements}’ creation dates.
dateOrdered()Narrows the query results based on the orders’ completion dates.
datePaid()Narrows the query results based on the orders’ paid 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}.
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.
each()Starts a batch query and retrieves data row by row.
email()Narrows the query results based on the customers’ email addresses.
emulateExecution()Sets whether to emulate query execution, preventing any interaction with data storage.
enabledForSite()Narrows the query results based on whether the {elements} are enabled in the site they’re being queried in, per the site() parameter.
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.
expiryDate()Narrows the query results based on the orders’ expiry dates.
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.
filterHaving()Sets the HAVING part of the query but ignores empty operands.
filterWhere()Sets the WHERE part of the query but ignores empty operands.
find()Returns all elements that match the criteria.
first()Returns the first element that matches the criteria.
fixedOrder()Causes the query results to be returned in the order specified by id().
from()Sets the FROM part of the query.
gateway()Narrows the query results based on the gateway.
gatewayId()Narrows the query results based on the gateway, per its ID.
getBehavior()Returns the named behavior object.
getBehaviors()Returns all behaviors attached to this component.
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.
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.
hasPurchasables()Narrows the query results to only orders that have certain purchasables.
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.
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.
isCompleted()Narrows the query results to only orders that are completed.
isJoined()Returns whether a given table has been joined in this query.
isPaid()Narrows the query results to only orders that are paid.
isUnpaid()Narrows the query results to only orders that are not paid.
join()Appends a JOIN part to the query.
last()Returns the last element that matches the criteria.
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()Sets the LIMIT part of the query.
locale()Sets the \craft\commerce\elements\db\$site property.
localeEnabled()Sets the $enabledForSite property.
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}.
noCache()Disables query cache for this Query.
nth()Executes the query and returns a single row of result at a given offset.
number()Narrows the query results based on the order number.
off()Detaches an existing event handler from this component.
offset()Sets the OFFSET part of the query.
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.
order()Sets the $orderBy property.
orderBy()Sets the ORDER BY part of the query.
orderStatus()Narrows the query results based on the order statuses.
orderStatusId()Narrows the query results based on the order statuses, 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}.
positionedBefore()Narrows the query results to only {elements} that are positioned before another {element}.
prepare()Prepares for building SQL.
prevSiblingOf()Narrows the query results to only the {element} that comes immediately before another {element}.
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.
rightJoin()Appends a RIGHT OUTER JOIN part to the query.
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}.
site()Determines which site the {elements} should be queried in.
siteId()Determines which site the {elements} should be queried in, per the site’s ID.
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.
total()Returns the total elements that match the criteria.
trigger()Triggers an event.
uid()Narrows the query results based on the {elements}’ UIDs.
union()Appends a SQL statement using UNION operator.
updatedAfter()Narrows the query results based on the {elements}’ last-updated dates.
updatedBefore()Narrows the query results based on the {elements}’ last-updated dates.
uri()Narrows the query results based on the {elements}’ URIs.
user()Narrows the query results based on the customer’s user account.
where()Sets the WHERE part of the query.
with()Causes the query to return matching {elements} eager-loaded with related elements.
withStructure()Explicitly determines whether the query should join in the structure data.

__construct()

Constructor

View source

Arguments

  • $elementType (string) – The element type class associated with this query
  • $config (array) – Configurations to be applied to the newly created query object

Signature

public void __construct ( $elementType, array $config = [] )

__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;.

View source

Arguments

  • $name (string) – The property name or the event name
  • $value (mixed) – The property value

Throws

Signature

public void __set ( $name, $value )

customer()

Narrows the query results based on the customer. Possible values include:

ValueFetches {elements}…
a Customer objectwith a customer represented by the object.

View source

Arguments

Returns

static – Self reference

Signature

public static customer ( craft\commerce\models\Customer $value = null )

Example

customerId()

Narrows the query results based on the customer, per their ID. Possible values include:

ValueFetches {elements}…
1with a customer with an ID of 1.
'not 1'not with a customer with an ID of 1.
[1, 2]with a customer with an ID of 1 or 2.
['not', 1, 2]not with a customer with an ID of 1 or 2.

View source

Arguments

  • $value (mixed) – The property value

Returns

static – Self reference

Signature

public static customerId ( $value )

Example

dateOrdered()

Narrows the query results based on the orders’ completion dates. Possible values include:

ValueFetches {elements}…
'>= 2018-04-01'that were completed on or after 2018-04-01.
'< 2018-05-01'that were completed before 2018-05-01
['and', '>= 2018-04-04', '< 2018-05-01']that were completed between 2018-04-01 and 2018-05-01.

View source

Arguments

  • $value (mixed) – The property value

Returns

static – Self reference

Signature

public static dateOrdered ( $value )

Example

datePaid()

Narrows the query results based on the orders’ paid dates. Possible values include:

ValueFetches {elements}…
'>= 2018-04-01'that were paid on or after 2018-04-01.
'< 2018-05-01'that were paid before 2018-05-01
['and', '>= 2018-04-04', '< 2018-05-01']that were completed between 2018-04-01 and 2018-05-01.

View source

Arguments

  • $value (mixed) – The property value

Returns

static – Self reference

Signature

public static datePaid ( $value )

Example

email()

Narrows the query results based on the customers’ email addresses. Possible values include:

ValueFetches {elements} with customers…
'foo@bar.baz'with an email of foo@bar.baz.
'not foo@bar.baz'not with an email of foo@bar.baz.
'*@bar.baz'with an email that ends with @bar.baz.

View source

Arguments

Returns

static – Self reference

Signature

public static email ( \craft\commerce\elements\db\string $value )

Example

expiryDate()

Narrows the query results based on the orders’ expiry dates. Possible values include:

ValueFetches {elements}…
'>= 2020-04-01'that will expire on or after 2020-04-01.
'< 2020-05-01'that will expire before 2020-05-01
['and', '>= 2020-04-04', '< 2020-05-01']that will expire between 2020-04-01 and 2020-05-01.

View source

Arguments

  • $value (mixed) – The property value

Returns

static – Self reference

Signature

public static expiryDate ( $value )

Example

gateway()

Narrows the query results based on the gateway. Possible values include:

ValueFetches {elements}…
a Gateway objectwith a gateway represented by the object.

View source

Arguments

Returns

static – Self reference

Signature

public static gateway ( craft\commerce\base\GatewayInterface $value = null )

gatewayId()

Narrows the query results based on the gateway, per its ID. Possible values include:

ValueFetches {elements}…
1with a gateway with an ID of 1.
'not 1'not with a gateway with an ID of 1.
[1, 2]with a gateway with an ID of 1 or 2.
['not', 1, 2]not with a gateway with an ID of 1 or 2.

View source

Arguments

  • $value (mixed) – The property value

Returns

static – Self reference

Signature

public static gatewayId ( $value )

hasPurchasables()

Narrows the query results to only orders that have certain purchasables. Possible values include:

ValueFetches {elements}…
a PurchasableInterface objectwith a purchasable represented by the object.
an array of PurchasableInterface objectswith all the purchasables represented by the objects.

View source

Arguments

Returns

static – Self reference

Signature

public static hasPurchasables ( $value )

isCompleted()

Narrows the query results to only orders that are completed.

View source

Arguments

  • $value (boolean) – The property value

Returns

static – Self reference

Signature

public static isCompleted ( \craft\commerce\elements\db\bool $value = true )

Example

isPaid()

Narrows the query results to only orders that are paid.

View source

Arguments

  • $value (boolean) – The property value

Returns

static – Self reference

Signature

public static isPaid ( \craft\commerce\elements\db\bool $value = true )

Example

isUnpaid()

Narrows the query results to only orders that are not paid.

View source

Arguments

  • $value (boolean) – The property value

Returns

static – Self reference

Signature

public static isUnpaid ( \craft\commerce\elements\db\bool $value = true )

Example

number()

Narrows the query results based on the order number. Possible values include:

ValueFetches {elements}…
'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'with a matching order number

View source

Arguments

Returns

static – Self reference

Signature

public static number ( \craft\commerce\elements\db\string $value = null )

Example

orderStatus()

Narrows the query results based on the order statuses. Possible values include:

ValueFetches {elements}…
'foo'with an order status with a handle of foo.
'not foo'not with an order status with a handle of foo.
['foo', 'bar']with an order status with a handle of foo or bar.
['not', 'foo', 'bar']not with an order status with a handle of foo or bar.
a OrderStatus objectwith an order status represented by the object.

View source

Arguments

Returns

static – Self reference

Signature

public static orderStatus ( $value )

Example

orderStatusId()

Narrows the query results based on the order statuses, per their IDs. Possible values include:

ValueFetches {elements}…
1with an order status with an ID of 1.
'not 1'not with an order status with an ID of 1.
[1, 2]with an order status with an ID of 1 or 2.
['not', 1, 2]not with an order status with an ID of 1 or 2.

View source

Arguments

  • $value (mixed) – The property value

Returns

static – Self reference

Signature

public static orderStatusId ( $value )

Example

updatedAfter()

DEPRECATED

Deprecated in 2.0. Use dateUpdated() instead.

Narrows the query results based on the {elements}’ last-updated dates.

View source

Arguments

Returns

static – Self reference

Signature

public static updatedAfter ( $value )

updatedBefore()

DEPRECATED

Deprecated in 2.0. Use dateUpdated() instead.

Narrows the query results based on the {elements}’ last-updated dates.

View source

Arguments

Returns

static – Self reference

Signature

public static updatedBefore ( $value )

user()

Narrows the query results based on the customer’s user account. Possible values include:

ValueFetches {elements}…
1with a customer with a user account ID of 1.
a User objectwith a customer with a user account represented by the object.

View source

Arguments

Returns

static – Self reference

Signature

public static user ( $value )

Example

Protected Methods

MethodDescription
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.
cleanUpTableNames()Clean up table names and aliases Both aliases and names are enclosed into {{ and }}.
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 craft_elements.id.
normalizeOrderBy()Normalizes format of ORDER BY data.
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.

View source

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.

Signature

protected boolean beforePrepare ( )