Box QuerySubCondition

Box\QuerySubCondition

Query

• Class name: QuerySubCondition
• Namespace: Box
• Parent class: Box\QueryBase
• This class implements: Box\QueryInterfaceCondition

Properties

$_aggregate

private \Box\QueryAggregateCondition $_aggregate

• Visibility: private

$_child

protected \Box\QueryBase $_child

• Visibility: protected

$_token

protected \Box\TokenBase $_token

• Visibility: protected

$_root

protected \Box\Query $_root

• Visibility: protected

Methods

\Box\QuerySubCondition::__construct()

mixed Box\QuerySubCondition::\Box\QuerySubCondition::__construct()()

hello - use ::create

• Visibility: private

\Box\QuerySubCondition::create()

\Box\QuerySubCondition Box\QuerySubCondition::\Box\QuerySubCondition::create()()

Create a new sub query.

• Visibility: public
• This method is static.

\Box\QuerySubCondition::getToken()

\Box\TokenBase|null Box\QuerySubCondition::\Box\QuerySubCondition::getToken()()

Get the first token in the chain this sub query condition translates to.

• Visibility: public

\Box\QuerySubCondition::contains()

\Box\QueryOperation Box\QuerySubCondition::\Box\QuerySubCondition::contains()(string $property, string $value, boolean $caseSensitive)

Set the condition that a string property must contain the given substring.

• Visibility: public

Arguments

• $property string - <p>The property you want to set a condition on.</p>
• $value string - <p>The string you want that property to contain.</p>
• $caseSensitive boolean

\Box\QuerySubCondition::endsWith()

\Box\QueryOperation Box\QuerySubCondition::\Box\QuerySubCondition::endsWith()(string $property, string $value, boolean $caseSensitive)

Set the condition that a string property must end with the given substring.

• Visibility: public

Arguments

• $property string - <p>The property you want to set a condition on.</p>
• $value string - <p>The string you want that property to end with.</p>
• $caseSensitive boolean

\Box\QuerySubCondition::startsWith()

\Box\QueryOperation Box\QuerySubCondition::\Box\QuerySubCondition::startsWith()(string $property, string $value, boolean $caseSensitive)

Set the condition that a string property must start with the given substring.

• Visibility: public

Arguments

• $property string - <p>The property you want to set a condition on.</p>
• $value string - <p>The string you want that property to start with.</p>
• $caseSensitive boolean

\Box\QuerySubCondition::equals()

\Box\QueryOperation Box\QuerySubCondition::\Box\QuerySubCondition::equals()(string $property, string|float|boolean|integer|string[]|float[]|boolean[]|integer[]|null $value)

Set the condition that a property must have a given value.

• Visibility: public

Arguments

• $property string - <p>The property you want to set a condition on.</p>
• $value string|float|boolean|integer|string[]|float[]|boolean[]|integer[]|null - <p>The value the property should have to satisfy the condition.</p>

\Box\QuerySubCondition::notEquals()

\Box\QueryOperation Box\QuerySubCondition::\Box\QuerySubCondition::notEquals()(string $property, string|float|boolean|integer|string[]|float[]|boolean[]|integer[]|null $value)

Set the condition that a property must not have a given value.

• Visibility: public

Arguments

• $property string - <p>The property you want to set a condition on.</p>
• $value string|float|boolean|integer|string[]|float[]|boolean[]|integer[]|null - <p>The value the property should not have to satisfy the condition.</p>

\Box\QuerySubCondition::greaterThan()

\Box\QueryOperation Box\QuerySubCondition::\Box\QuerySubCondition::greaterThan()(string $property, float|integer $value)

Set the condition that a numerical property must be greater than a given value.

• Visibility: public

Arguments

• $property string - <p>The property you want to set a condition on.</p>
• $value float|integer - <p>The value the property should be greater than to satisfy the condition.</p>

\Box\QuerySubCondition::greaterThanOrEquals()

\Box\QueryOperation Box\QuerySubCondition::\Box\QuerySubCondition::greaterThanOrEquals()(string $property, float|integer $value)

Set the condition that a numerical property must be greater than or equal to a given value.

• Visibility: public

Arguments

• $property string - <p>The property you want to set a condition on.</p>
• $value float|integer - <p>The value the property should be greater than or equal to to satisfy the condition.</p>

\Box\QuerySubCondition::lessThan()

\Box\QueryOperation Box\QuerySubCondition::\Box\QuerySubCondition::lessThan()(string $property, float|integer $value)

Set the condition that a numerical property must be greater than a given value.

• Visibility: public

Arguments

• $property string - <p>The property you want to set a condition on.</p>
• $value float|integer - <p>The value the property should be less than to satisfy the condition.</p>

\Box\QuerySubCondition::lessThanOrEquals()

\Box\QueryOperation Box\QuerySubCondition::\Box\QuerySubCondition::lessThanOrEquals()(string $property, float|integer $value)

Set the condition that a numerical property must be greater than or equal to a given value.

• Visibility: public

Arguments

• $property string - <p>The property you want to set a condition on.</p>
• $value float|integer - <p>The value the property should be less than or equal to to satisfy the condition.</p>

\Box\QuerySubCondition::in()

\Box\QueryOperation Box\QuerySubCondition::\Box\QuerySubCondition::in()(string $property, string[]|float[]|boolean[]|integer[] $values)

Set the condition that a property must be equal to any value in a given set.

• Visibility: public

Arguments

• $property string - <p>The property you want to set a condition on.</p>
• $values string[]|float[]|boolean[]|integer[] - <p>The values the property should be equal to any of to satisfy the condition.</p>

\Box\QuerySubCondition::notIn()

\Box\QueryOperation Box\QuerySubCondition::\Box\QuerySubCondition::notIn()(string $property, string[]|float[]|boolean[]|integer[] $values)

Set the condition that a property must not be equal to any value in a given set.

• Visibility: public

Arguments

• $property string - <p>The property you want to set a condition on.</p>
• $values string[]|float[]|boolean[]|integer[] - <p>The values the property should not be equal to any of to satisfy the condition.</p>

\Box\QueryBase::_getToken()

\Box\TokenBase Box\QuerySubCondition::\Box\QueryBase::_getToken()()

Get the token this query element translates to.

• Visibility: protected

\Box\QueryBase::getToken()

\Box\TokenRoot Box\QuerySubCondition::\Box\QueryBase::getToken()()

Get the token representing the root of the query this query part belongs to, if any.

• Visibility: public

\Box\QueryInterfaceCondition::contains()

mixed Box\QueryInterfaceCondition::\Box\QueryInterfaceCondition::contains()(string $property, string $value, boolean $caseSensitive)

Set the condition that a string property must contain the given substring.

• Visibility: public
• This method is defined by Box\QueryInterfaceCondition

Arguments

• $property string - <p>The property you want to set a condition on.</p>
• $value string - <p>The string you want that property to contain.</p>
• $caseSensitive boolean

\Box\QueryInterfaceCondition::endsWith()

mixed Box\QueryInterfaceCondition::\Box\QueryInterfaceCondition::endsWith()(string $property, string $value, boolean $caseSensitive)

Set the condition that a string property must end with the given substring.

• Visibility: public
• This method is defined by Box\QueryInterfaceCondition

Arguments

• $property string - <p>The property you want to set a condition on.</p>
• $value string - <p>The string you want that property to end with.</p>
• $caseSensitive boolean

\Box\QueryInterfaceCondition::startsWith()

mixed Box\QueryInterfaceCondition::\Box\QueryInterfaceCondition::startsWith()(string $property, string $value, boolean $caseSensitive)

Set the condition that a string property must start with the given substring.

• Visibility: public
• This method is defined by Box\QueryInterfaceCondition

Arguments

• $property string - <p>The property you want to set a condition on.</p>
• $value string - <p>The string you want that property to start with.</p>
• $caseSensitive boolean

\Box\QueryInterfaceCondition::equals()

mixed Box\QueryInterfaceCondition::\Box\QueryInterfaceCondition::equals()(string $property, string|float|boolean|integer|string[]|float[]|boolean[]|integer[]|null $value)

Set the condition that a property must have a given value.

• Visibility: public
• This method is defined by Box\QueryInterfaceCondition

Arguments

• $property string - <p>The property you want to set a condition on.</p>
• $value string|float|boolean|integer|string[]|float[]|boolean[]|integer[]|null - <p>The value the property should have to satisfy the condition.</p>

\Box\QueryInterfaceCondition::notEquals()

mixed Box\QueryInterfaceCondition::\Box\QueryInterfaceCondition::notEquals()(string $property, string|float|boolean|integer|string[]|float[]|boolean[]|integer[]|null $value)

Set the condition that a property must not have a given value.

• Visibility: public
• This method is defined by Box\QueryInterfaceCondition

Arguments

• $property string - <p>The property you want to set a condition on.</p>
• $value string|float|boolean|integer|string[]|float[]|boolean[]|integer[]|null - <p>The value the property should not have to satisfy the condition.</p>

\Box\QueryInterfaceCondition::greaterThan()

mixed Box\QueryInterfaceCondition::\Box\QueryInterfaceCondition::greaterThan()(string $property, float|integer $value)

Set the condition that a numerical property must be greater than a given value.

• Visibility: public
• This method is defined by Box\QueryInterfaceCondition

Arguments

• $property string - <p>The property you want to set a condition on.</p>
• $value float|integer - <p>The value the property should be greater than to satisfy the condition.</p>

\Box\QueryInterfaceCondition::greaterThanOrEquals()

mixed Box\QueryInterfaceCondition::\Box\QueryInterfaceCondition::greaterThanOrEquals()(string $property, float|integer $value)

Set the condition that a numerical property must be greater than or equal to a given value.

• Visibility: public
• This method is defined by Box\QueryInterfaceCondition

Arguments

• $property string - <p>The property you want to set a condition on.</p>
• $value float|integer - <p>The value the property should be greater than or equal to to satisfy the condition.</p>

\Box\QueryInterfaceCondition::lessThan()

mixed Box\QueryInterfaceCondition::\Box\QueryInterfaceCondition::lessThan()(string $property, float|integer $value)

Set the condition that a numerical property must be greater than a given value.

• Visibility: public
• This method is defined by Box\QueryInterfaceCondition

Arguments

• $property string - <p>The property you want to set a condition on.</p>
• $value float|integer - <p>The value the property should be less than to satisfy the condition.</p>

\Box\QueryInterfaceCondition::lessThanOrEquals()

mixed Box\QueryInterfaceCondition::\Box\QueryInterfaceCondition::lessThanOrEquals()(string $property, float|integer $value)

Set the condition that a numerical property must be greater than or equal to a given value.

• Visibility: public
• This method is defined by Box\QueryInterfaceCondition

Arguments

• $property string - <p>The property you want to set a condition on.</p>
• $value float|integer - <p>The value the property should be less than or equal to to satisfy the condition.</p>

\Box\QueryInterfaceCondition::in()

mixed Box\QueryInterfaceCondition::\Box\QueryInterfaceCondition::in()(string $property, string[]|float[]|boolean[]|integer[] $values)

Set the condition that a property must be equal to any value in a given set.

• Visibility: public
• This method is defined by Box\QueryInterfaceCondition

Arguments

• $property string - <p>The property you want to set a condition on.</p>
• $values string[]|float[]|boolean[]|integer[] - <p>The values the property should be equal to any of to satisfy the condition.</p>

\Box\QueryInterfaceCondition::notIn()

mixed Box\QueryInterfaceCondition::\Box\QueryInterfaceCondition::notIn()(string $property, array $values)

Set the condition that a property must not be equal to any value in a given set.

• Visibility: public
• This method is defined by Box\QueryInterfaceCondition

Arguments

• $property string - <p>The property you want to set a condition on.</p>
• $values array