Cake\ORM\Query::applyOptions PHP Method

Query Class Documentation Usage Examples Of Cake\ORM\Query::applyOptions Show file Open project: cakephp/orm

applyOptions() public method

Populates or adds parts to current query clauses using an array. This is handy for passing all query clauses at once. The option array accepts: - fields: Maps to the select method - conditions: Maps to the where method - limit: Maps to the limit method - order: Maps to the order method - offset: Maps to the offset method - group: Maps to the group method - having: Maps to the having method - contain: Maps to the contain options for eager loading - join: Maps to the join method - page: Maps to the page method ### Example: $query->applyOptions([ 'fields' => ['id', 'name'], 'conditions' => [ 'created >=' => '2013-01-01' ], 'limit' => 10 ]); Is equivalent to: $query ->select(['id', 'name']) ->where(['created >=' => '2013-01-01']) ->limit(10)

public applyOptions ( array $options )
$options	array

    public function applyOptions(array $options)
    {
        $valid = ['fields' => 'select', 'conditions' => 'where', 'join' => 'join', 'order' => 'order', 'limit' => 'limit', 'offset' => 'offset', 'group' => 'group', 'having' => 'having', 'contain' => 'contain', 'page' => 'page'];
        ksort($options);
        foreach ($options as $option => $values) {
            if (isset($valid[$option], $values)) {
                $this->{$valid[$option]}($values);
            } else {
                $this->_options[$option] = $values;
            }
        }
        return $this;
    }

Usage Example

Example #1

Show file

File: QueryTest.php Project: neilan35/betterwindow1

 /**
  * Tests getOptions() method
  *
  * @return void
  */
 public function testGetOptions()
 {
     $options = ['doABarrelRoll' => true, 'fields' => ['id', 'name']];
     $query = new Query($this->connection, $this->table);
     $query->applyOptions($options);
     $expected = ['doABarrelRoll' => true];
     $this->assertEquals($expected, $query->getOptions());
     $expected = ['doABarrelRoll' => false, 'doAwesome' => true];
     $query->applyOptions($expected);
     $this->assertEquals($expected, $query->getOptions());
 }

All Usage Examples Of Cake\ORM\Query::applyOptions

Query

__call

__clone

__construct

__debugInfo

_addAssociationsToTypeMap

_addDefaultFields

_addDefaultSelectTypes

_all

_applyDecorators

_cache