Skip to content

Box QueryCondition

Jump to bottom Edit New page
Travis edited this page Mar 13, 2014 · 9 revisions

Box\QueryCondition

Query

Properties

$_aggregate

private mixed $_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\QueryCondition::__construct()

mixed Box\QueryCondition::\Box\QueryCondition::__construct()()

Use ::create if you can find it. Otherwise this.

  • Visibility: public

\Box\QueryCondition::contains()

\Box\QueryOperation Box\QueryCondition::\Box\QueryCondition::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\QueryCondition::endsWith()

\Box\QueryOperation Box\QueryCondition::\Box\QueryCondition::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\QueryCondition::startsWith()

\Box\QueryOperation Box\QueryCondition::\Box\QueryCondition::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\QueryCondition::equals()

\Box\QueryOperation Box\QueryCondition::\Box\QueryCondition::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\QueryCondition::notEquals()

\Box\QueryOperation Box\QueryCondition::\Box\QueryCondition::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\QueryCondition::greaterThan()

\Box\QueryOperation Box\QueryCondition::\Box\QueryCondition::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\QueryCondition::greaterThanOrEquals()

\Box\QueryOperation Box\QueryCondition::\Box\QueryCondition::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\QueryCondition::lessThan()

\Box\QueryOperation Box\QueryCondition::\Box\QueryCondition::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\QueryCondition::lessThanOrEquals()

\Box\QueryOperation Box\QueryCondition::\Box\QueryCondition::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\QueryCondition::in()

\Box\QueryOperation Box\QueryCondition::\Box\QueryCondition::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\QueryCondition::notIn()

\Box\QueryOperation Box\QueryCondition::\Box\QueryCondition::notIn()(string $property, array $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 array

\Box\QueryBase::_getToken()

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

Get the token this query element translates to.

  • Visibility: protected

\Box\QueryBase::getToken()

\Box\TokenRoot Box\QueryCondition::\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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

Arguments

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

Clone this wiki locally