Illuminate\Database\Query\Builder::decrement PHP Method

decrement() public method

Decrement a column's value by a given amount.
public decrement ( string $column, integer $amount = 1, array $extra = [] ) : integer
$column string
$amount integer
$extra array
return integer
    public function decrement($column, $amount = 1, array $extra = [])
    {
        if (!is_numeric($amount)) {
            throw new InvalidArgumentException('Non-numeric value passed to decrement method.');
        }
        $wrapped = $this->grammar->wrap($column);
        $columns = array_merge([$column => $this->raw("{$wrapped} - {$amount}")], $extra);
        return $this->update($columns);
    }

Usage Example

Example #1
0
 /**
  * Decrement a column's value by a given amount.
  *
  * @param  string  $column
  * @param  int     $amount
  * @param  array   $extra
  * @return int
  */
 public function decrement($column, $amount = 1, array $extra = array())
 {
     $extra = $this->addUpdatedAtColumn($extra);
     return $this->query->decrement($column, $amount, $extra);
 }