trait DecoratesQueryBuilder mixin Builder (View source)

Traits

Properties

protected Builder $query

The decorated query builder instance.

Methods

mixed
forwardCallTo(mixed $object, string $method, array $parameters)

Forward a method call to the given object.

mixed
forwardDecoratedCallTo(mixed $object, string $method, array $parameters)

Forward a method call to the given object, returning $this if the forwarded call returned itself.

static void
throwBadMethodCallException(string $method)

Throw a bad method call exception for the given method.

toBase()

Get a base query builder instance.

select($columns = ['*'])

{@inheritdoc}

selectSub($query, $as)

{@inheritdoc}

selectRaw($expression, array $bindings = [])

{@inheritdoc}

fromSub($query, $as)

{@inheritdoc}

fromRaw($expression, $bindings = [])

{@inheritdoc}

addSelect($column)

{@inheritdoc}

distinct()

{@inheritdoc}

from($table, $as = null)

{@inheritdoc}

join($table, $first, $operator = null, $second = null, $type = 'inner', $where = false)

{@inheritdoc}

joinWhere($table, $first, $operator, $second, $type = 'inner')

{@inheritdoc}

joinSub($query, $as, $first, $operator = null, $second = null, $type = 'inner', $where = false)

{@inheritdoc}

leftJoin($table, $first, $operator = null, $second = null)

{@inheritdoc}

leftJoinWhere($table, $first, $operator, $second)

{@inheritdoc}

leftJoinSub($query, $as, $first, $operator = null, $second = null)

{@inheritdoc}

rightJoin($table, $first, $operator = null, $second = null)

{@inheritdoc}

rightJoinWhere($table, $first, $operator, $second)

{@inheritdoc}

rightJoinSub($query, $as, $first, $operator = null, $second = null)

{@inheritdoc}

crossJoin($table, $first = null, $operator = null, $second = null)

{@inheritdoc}

crossJoinSub($query, $as)

{@inheritdoc}

mergeWheres($wheres, $bindings)

{@inheritdoc}

where($column, $operator = null, $value = null, $boolean = 'and')

{@inheritdoc}

prepareValueAndOperator($value, $operator, $useDefault = false)

{@inheritdoc}

orWhere($column, $operator = null, $value = null)

{@inheritdoc}

whereColumn($first, $operator = null, $second = null, $boolean = 'and')

{@inheritdoc}

orWhereColumn($first, $operator = null, $second = null)

{@inheritdoc}

whereRaw($sql, $bindings = [], $boolean = 'and')

{@inheritdoc}

orWhereRaw($sql, $bindings = [])

{@inheritdoc}

whereIn($column, $values, $boolean = 'and', $not = false)

{@inheritdoc}

orWhereIn($column, $values)

{@inheritdoc}

whereNotIn($column, $values, $boolean = 'and')

{@inheritdoc}

orWhereNotIn($column, $values)

{@inheritdoc}

whereIntegerInRaw($column, $values, $boolean = 'and', $not = false)

{@inheritdoc}

orWhereIntegerInRaw($column, $values)

{@inheritdoc}

whereIntegerNotInRaw($column, $values, $boolean = 'and')

{@inheritdoc}

orWhereIntegerNotInRaw($column, $values)

{@inheritdoc}

whereNull($columns, $boolean = 'and', $not = false)

{@inheritdoc}

orWhereNull($column)

{@inheritdoc}

whereNotNull($columns, $boolean = 'and')

{@inheritdoc}

whereBetween($column, iterable $values, $boolean = 'and', $not = false)

{@inheritdoc}

whereBetweenColumns($column, array $values, $boolean = 'and', $not = false)

{@inheritdoc}

orWhereBetween($column, iterable $values)

{@inheritdoc}

orWhereBetweenColumns($column, array $values)

{@inheritdoc}

whereNotBetween($column, iterable $values, $boolean = 'and')

{@inheritdoc}

whereNotBetweenColumns($column, array $values, $boolean = 'and')

{@inheritdoc}

orWhereNotBetween($column, iterable $values)

{@inheritdoc}

orWhereNotBetweenColumns($column, array $values)

{@inheritdoc}

orWhereNotNull($column)

{@inheritdoc}

whereDate($column, $operator, $value = null, $boolean = 'and')

{@inheritdoc}

orWhereDate($column, $operator, $value = null)

{@inheritdoc}

whereTime($column, $operator, $value = null, $boolean = 'and')

{@inheritdoc}

orWhereTime($column, $operator, $value = null)

{@inheritdoc}

whereDay($column, $operator, $value = null, $boolean = 'and')

{@inheritdoc}

orWhereDay($column, $operator, $value = null)

{@inheritdoc}

whereMonth($column, $operator, $value = null, $boolean = 'and')

{@inheritdoc}

orWhereMonth($column, $operator, $value = null)

{@inheritdoc}

whereYear($column, $operator, $value = null, $boolean = 'and')

{@inheritdoc}

orWhereYear($column, $operator, $value = null)

{@inheritdoc}

whereNested(Closure $callback, $boolean = 'and')

{@inheritdoc}

addNestedWhereQuery($query, $boolean = 'and')

{@inheritdoc}

whereExists(Closure $callback, $boolean = 'and', $not = false)

{@inheritdoc}

orWhereExists(Closure $callback, $not = false)

{@inheritdoc}

whereNotExists(Closure $callback, $boolean = 'and')

{@inheritdoc}

orWhereNotExists(Closure $callback)

{@inheritdoc}

whereRowValues($columns, $operator, $values, $boolean = 'and')

{@inheritdoc}

orWhereRowValues($columns, $operator, $values)

{@inheritdoc}

whereJsonContains($column, $value, $boolean = 'and', $not = false)

{@inheritdoc}

orWhereJsonContains($column, $value)

{@inheritdoc}

whereJsonDoesntContain($column, $value, $boolean = 'and')

{@inheritdoc}

orWhereJsonDoesntContain($column, $value)

{@inheritdoc}

whereJsonLength($column, $operator, $value = null, $boolean = 'and')

{@inheritdoc}

orWhereJsonLength($column, $operator, $value = null)

{@inheritdoc}

groupBy(...$groups)

{@inheritdoc}

groupByRaw($sql, array $bindings = [])

{@inheritdoc}

having($column, $operator = null, $value = null, $boolean = 'and')

{@inheritdoc}

orHaving($column, $operator = null, $value = null)

{@inheritdoc}

havingNull($columns, $boolean = 'and', $not = false)

{@inheritdoc}

orHavingNull($column)

{@inheritdoc}

havingNotNull($columns, $boolean = 'and')

No description

orHavingNotNull($column)

No description

havingBetween($column, array $values, $boolean = 'and', $not = false)

No description

havingRaw($sql, array $bindings = [], $boolean = 'and')

No description

orHavingRaw($sql, array $bindings = [])

No description

orderBy($column, $direction = 'asc')

No description

orderByDesc($column)

No description

latest($column = 'created_at')

No description

oldest($column = 'created_at')

No description

inRandomOrder($seed = '')

No description

orderByRaw($sql, $bindings = [])

No description

skip($value)

No description

offset($value)

No description

take($value)

No description

limit($value)

No description

forPage($page, $perPage = 15)

No description

forPageBeforeId($perPage = 15, $lastId = 0, $column = 'id')

No description

forPageAfterId($perPage = 15, $lastId = 0, $column = 'id')

No description

reorder($column = null, $direction = 'asc')

No description

union($query, $all = false)

No description

unionAll($query)

No description

lock($value = true)

No description

lockForUpdate()

No description

sharedLock()

No description

toSql()

No description

find($id, $columns = ['*'])

No description

value($column)

No description

get($columns = ['*'])

No description

cursor()

No description

pluck($column, $key = null)

No description

implode($column, $glue = '')

No description

exists()

No description

doesntExist()

No description

existsOr(Closure $callback)

No description

doesntExistOr(Closure $callback)

No description

count($columns = '*')

No description

min($column)

No description

max($column)

No description

sum($column)

No description

avg($column)

No description

average($column)

No description

aggregate($function, $columns = ['*'])

No description

numericAggregate($function, $columns = ['*'])

No description

insert(array $values)

No description

insertOrIgnore(array $values)

No description

insertGetId(array $values, $sequence = null)

No description

insertUsing(array $columns, $query)

No description

update(array $values)

No description

updateOrInsert(array $attributes, array $values = [])

No description

upsert(array $values, $uniqueBy, $update = null)

No description

increment($column, $amount = 1, array $extra = [])

No description

decrement($column, $amount = 1, array $extra = [])

No description

delete($id = null)

No description

truncate()

No description

newQuery()

No description

raw($value)

No description

getBindings()

No description

getRawBindings()

No description

setBindings(array $bindings, $type = 'where')

No description

addBinding($value, $type = 'where')

No description

mergeBindings(Builder $query)

No description

cleanBindings(array $bindings)

No description

getConnection()

No description

getProcessor()

No description

getGrammar()

No description

useWritePdo()

No description

clone()

No description

cloneWithout(array $properties)

No description

cloneWithoutBindings(array $except)

No description

mixed
__call(string $method, array $parameters)

Handle dynamic method calls to the query builder.

Details

protected mixed forwardCallTo(mixed $object, string $method, array $parameters)

Forward a method call to the given object.

Parameters

mixed $object
string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

protected mixed forwardDecoratedCallTo(mixed $object, string $method, array $parameters)

Forward a method call to the given object, returning $this if the forwarded call returned itself.

Parameters

mixed $object
string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

static protected void throwBadMethodCallException(string $method)

Throw a bad method call exception for the given method.

Parameters

string $method

Return Value

void

Exceptions

BadMethodCallException

abstract Builder toBase()

Get a base query builder instance.

Return Value

Builder

select($columns = ['*'])

{@inheritdoc}

Parameters

$columns

selectSub($query, $as)

{@inheritdoc}

Parameters

$query
$as

selectRaw($expression, array $bindings = [])

{@inheritdoc}

Parameters

$expression
array $bindings

fromSub($query, $as)

{@inheritdoc}

Parameters

$query
$as

fromRaw($expression, $bindings = [])

{@inheritdoc}

Parameters

$expression
$bindings

addSelect($column)

{@inheritdoc}

Parameters

$column

distinct()

{@inheritdoc}

from($table, $as = null)

{@inheritdoc}

Parameters

$table
$as

join($table, $first, $operator = null, $second = null, $type = 'inner', $where = false)

{@inheritdoc}

Parameters

$table
$first
$operator
$second
$type
$where

joinWhere($table, $first, $operator, $second, $type = 'inner')

{@inheritdoc}

Parameters

$table
$first
$operator
$second
$type

joinSub($query, $as, $first, $operator = null, $second = null, $type = 'inner', $where = false)

{@inheritdoc}

Parameters

$query
$as
$first
$operator
$second
$type
$where

leftJoin($table, $first, $operator = null, $second = null)

{@inheritdoc}

Parameters

$table
$first
$operator
$second

leftJoinWhere($table, $first, $operator, $second)

{@inheritdoc}

Parameters

$table
$first
$operator
$second

leftJoinSub($query, $as, $first, $operator = null, $second = null)

{@inheritdoc}

Parameters

$query
$as
$first
$operator
$second

rightJoin($table, $first, $operator = null, $second = null)

{@inheritdoc}

Parameters

$table
$first
$operator
$second

rightJoinWhere($table, $first, $operator, $second)

{@inheritdoc}

Parameters

$table
$first
$operator
$second

rightJoinSub($query, $as, $first, $operator = null, $second = null)

{@inheritdoc}

Parameters

$query
$as
$first
$operator
$second

crossJoin($table, $first = null, $operator = null, $second = null)

{@inheritdoc}

Parameters

$table
$first
$operator
$second

crossJoinSub($query, $as)

{@inheritdoc}

Parameters

$query
$as

mergeWheres($wheres, $bindings)

{@inheritdoc}

Parameters

$wheres
$bindings

where($column, $operator = null, $value = null, $boolean = 'and')

{@inheritdoc}

Parameters

$column
$operator
$value
$boolean

prepareValueAndOperator($value, $operator, $useDefault = false)

{@inheritdoc}

Parameters

$value
$operator
$useDefault

orWhere($column, $operator = null, $value = null)

{@inheritdoc}

Parameters

$column
$operator
$value

whereColumn($first, $operator = null, $second = null, $boolean = 'and')

{@inheritdoc}

Parameters

$first
$operator
$second
$boolean

orWhereColumn($first, $operator = null, $second = null)

{@inheritdoc}

Parameters

$first
$operator
$second

whereRaw($sql, $bindings = [], $boolean = 'and')

{@inheritdoc}

Parameters

$sql
$bindings
$boolean

orWhereRaw($sql, $bindings = [])

{@inheritdoc}

Parameters

$sql
$bindings

whereIn($column, $values, $boolean = 'and', $not = false)

{@inheritdoc}

Parameters

$column
$values
$boolean
$not

orWhereIn($column, $values)

{@inheritdoc}

Parameters

$column
$values

whereNotIn($column, $values, $boolean = 'and')

{@inheritdoc}

Parameters

$column
$values
$boolean

orWhereNotIn($column, $values)

{@inheritdoc}

Parameters

$column
$values

whereIntegerInRaw($column, $values, $boolean = 'and', $not = false)

{@inheritdoc}

Parameters

$column
$values
$boolean
$not

orWhereIntegerInRaw($column, $values)

{@inheritdoc}

Parameters

$column
$values

whereIntegerNotInRaw($column, $values, $boolean = 'and')

{@inheritdoc}

Parameters

$column
$values
$boolean

orWhereIntegerNotInRaw($column, $values)

{@inheritdoc}

Parameters

$column
$values

whereNull($columns, $boolean = 'and', $not = false)

{@inheritdoc}

Parameters

$columns
$boolean
$not

orWhereNull($column)

{@inheritdoc}

Parameters

$column

whereNotNull($columns, $boolean = 'and')

{@inheritdoc}

Parameters

$columns
$boolean

whereBetween($column, iterable $values, $boolean = 'and', $not = false)

{@inheritdoc}

Parameters

$column
iterable $values
$boolean
$not

whereBetweenColumns($column, array $values, $boolean = 'and', $not = false)

{@inheritdoc}

Parameters

$column
array $values
$boolean
$not

orWhereBetween($column, iterable $values)

{@inheritdoc}

Parameters

$column
iterable $values

orWhereBetweenColumns($column, array $values)

{@inheritdoc}

Parameters

$column
array $values

whereNotBetween($column, iterable $values, $boolean = 'and')

{@inheritdoc}

Parameters

$column
iterable $values
$boolean

whereNotBetweenColumns($column, array $values, $boolean = 'and')

{@inheritdoc}

Parameters

$column
array $values
$boolean

orWhereNotBetween($column, iterable $values)

{@inheritdoc}

Parameters

$column
iterable $values

orWhereNotBetweenColumns($column, array $values)

{@inheritdoc}

Parameters

$column
array $values

orWhereNotNull($column)

{@inheritdoc}

Parameters

$column

whereDate($column, $operator, $value = null, $boolean = 'and')

{@inheritdoc}

Parameters

$column
$operator
$value
$boolean

orWhereDate($column, $operator, $value = null)

{@inheritdoc}

Parameters

$column
$operator
$value

whereTime($column, $operator, $value = null, $boolean = 'and')

{@inheritdoc}

Parameters

$column
$operator
$value
$boolean

orWhereTime($column, $operator, $value = null)

{@inheritdoc}

Parameters

$column
$operator
$value

whereDay($column, $operator, $value = null, $boolean = 'and')

{@inheritdoc}

Parameters

$column
$operator
$value
$boolean

orWhereDay($column, $operator, $value = null)

{@inheritdoc}

Parameters

$column
$operator
$value

whereMonth($column, $operator, $value = null, $boolean = 'and')

{@inheritdoc}

Parameters

$column
$operator
$value
$boolean

orWhereMonth($column, $operator, $value = null)

{@inheritdoc}

Parameters

$column
$operator
$value

whereYear($column, $operator, $value = null, $boolean = 'and')

{@inheritdoc}

Parameters

$column
$operator
$value
$boolean

orWhereYear($column, $operator, $value = null)

{@inheritdoc}

Parameters

$column
$operator
$value

whereNested(Closure $callback, $boolean = 'and')

{@inheritdoc}

Parameters

Closure $callback
$boolean

addNestedWhereQuery($query, $boolean = 'and')

{@inheritdoc}

Parameters

$query
$boolean

whereExists(Closure $callback, $boolean = 'and', $not = false)

{@inheritdoc}

Parameters

Closure $callback
$boolean
$not

orWhereExists(Closure $callback, $not = false)

{@inheritdoc}

Parameters

Closure $callback
$not

whereNotExists(Closure $callback, $boolean = 'and')

{@inheritdoc}

Parameters

Closure $callback
$boolean

orWhereNotExists(Closure $callback)

{@inheritdoc}

Parameters

Closure $callback

whereRowValues($columns, $operator, $values, $boolean = 'and')

{@inheritdoc}

Parameters

$columns
$operator
$values
$boolean

orWhereRowValues($columns, $operator, $values)

{@inheritdoc}

Parameters

$columns
$operator
$values

whereJsonContains($column, $value, $boolean = 'and', $not = false)

{@inheritdoc}

Parameters

$column
$value
$boolean
$not

orWhereJsonContains($column, $value)

{@inheritdoc}

Parameters

$column
$value

whereJsonDoesntContain($column, $value, $boolean = 'and')

{@inheritdoc}

Parameters

$column
$value
$boolean

orWhereJsonDoesntContain($column, $value)

{@inheritdoc}

Parameters

$column
$value

whereJsonLength($column, $operator, $value = null, $boolean = 'and')

{@inheritdoc}

Parameters

$column
$operator
$value
$boolean

orWhereJsonLength($column, $operator, $value = null)

{@inheritdoc}

Parameters

$column
$operator
$value

groupBy(...$groups)

{@inheritdoc}

Parameters

...$groups

groupByRaw($sql, array $bindings = [])

{@inheritdoc}

Parameters

$sql
array $bindings

having($column, $operator = null, $value = null, $boolean = 'and')

{@inheritdoc}

Parameters

$column
$operator
$value
$boolean

orHaving($column, $operator = null, $value = null)

{@inheritdoc}

Parameters

$column
$operator
$value

havingNull($columns, $boolean = 'and', $not = false)

{@inheritdoc}

Parameters

$columns
$boolean
$not

orHavingNull($column)

{@inheritdoc}

Parameters

$column

havingNotNull($columns, $boolean = 'and')

No description

Parameters

$columns
$boolean

orHavingNotNull($column)

No description

Parameters

$column

havingBetween($column, array $values, $boolean = 'and', $not = false)

No description

Parameters

$column
array $values
$boolean
$not

havingRaw($sql, array $bindings = [], $boolean = 'and')

No description

Parameters

$sql
array $bindings
$boolean

orHavingRaw($sql, array $bindings = [])

No description

Parameters

$sql
array $bindings

orderBy($column, $direction = 'asc')

No description

Parameters

$column
$direction

orderByDesc($column)

No description

Parameters

$column

latest($column = 'created_at')

No description

Parameters

$column

oldest($column = 'created_at')

No description

Parameters

$column

inRandomOrder($seed = '')

No description

Parameters

$seed

orderByRaw($sql, $bindings = [])

No description

Parameters

$sql
$bindings

skip($value)

No description

Parameters

$value

offset($value)

No description

Parameters

$value

take($value)

No description

Parameters

$value

limit($value)

No description

Parameters

$value

forPage($page, $perPage = 15)

No description

Parameters

$page
$perPage

forPageBeforeId($perPage = 15, $lastId = 0, $column = 'id')

No description

Parameters

$perPage
$lastId
$column

forPageAfterId($perPage = 15, $lastId = 0, $column = 'id')

No description

Parameters

$perPage
$lastId
$column

reorder($column = null, $direction = 'asc')

No description

Parameters

$column
$direction

union($query, $all = false)

No description

Parameters

$query
$all

unionAll($query)

No description

Parameters

$query

lock($value = true)

No description

Parameters

$value

lockForUpdate()

No description

sharedLock()

No description

toSql()

No description

find($id, $columns = ['*'])

No description

Parameters

$id
$columns

value($column)

No description

Parameters

$column

get($columns = ['*'])

No description

Parameters

$columns

cursor()

No description

pluck($column, $key = null)

No description

Parameters

$column
$key

implode($column, $glue = '')

No description

Parameters

$column
$glue

exists()

No description

doesntExist()

No description

existsOr(Closure $callback)

No description

Parameters

Closure $callback

doesntExistOr(Closure $callback)

No description

Parameters

Closure $callback

count($columns = '*')

No description

Parameters

$columns

min($column)

No description

Parameters

$column

max($column)

No description

Parameters

$column

sum($column)

No description

Parameters

$column

avg($column)

No description

Parameters

$column

average($column)

No description

Parameters

$column

aggregate($function, $columns = ['*'])

No description

Parameters

$function
$columns

numericAggregate($function, $columns = ['*'])

No description

Parameters

$function
$columns

insert(array $values)

No description

Parameters

array $values

insertOrIgnore(array $values)

No description

Parameters

array $values

insertGetId(array $values, $sequence = null)

No description

Parameters

array $values
$sequence

insertUsing(array $columns, $query)

No description

Parameters

array $columns
$query

update(array $values)

No description

Parameters

array $values

updateOrInsert(array $attributes, array $values = [])

No description

Parameters

array $attributes
array $values

upsert(array $values, $uniqueBy, $update = null)

No description

Parameters

array $values
$uniqueBy
$update

increment($column, $amount = 1, array $extra = [])

No description

Parameters

$column
$amount
array $extra

decrement($column, $amount = 1, array $extra = [])

No description

Parameters

$column
$amount
array $extra

delete($id = null)

No description

Parameters

$id

truncate()

No description

newQuery()

No description

raw($value)

No description

Parameters

$value

getBindings()

No description

getRawBindings()

No description

setBindings(array $bindings, $type = 'where')

No description

Parameters

array $bindings
$type

addBinding($value, $type = 'where')

No description

Parameters

$value
$type

mergeBindings(Builder $query)

No description

Parameters

Builder $query

cleanBindings(array $bindings)

No description

Parameters

array $bindings

getConnection()

No description

getProcessor()

No description

getGrammar()

No description

useWritePdo()

No description

clone()

No description

cloneWithout(array $properties)

No description

Parameters

array $properties

cloneWithoutBindings(array $except)

No description

Parameters

array $except

mixed __call(string $method, array $parameters)

Handle dynamic method calls to the query builder.

Parameters

string $method
array $parameters

Return Value

mixed