Maslosoft Mangan API

Name: Mangan
Brand: Maslosoft

Class Modifier

\Maslosoft\Mangan\Modifier

Helper for building MongoDB atomic updates.

addCond method $criteriaObject->addCond($fieldName, $operator, $vale); // this will produce fieldName value

For modifiers list \Maslosoft\Mangan\Modifier::$modifiers

Namespace: Maslosoft\Mangan
Author: Ianaré Sévi
Author: Philippe Gaultier pgaultier@ibitux.com
Copyright: 2011 Ibitux http://www.ibitux.com
Since: v1.3.6
Located at Modifier.php

Methods summary

`public`	# `__construct( array $modifier = null )` Constructor. Constructor. Modifier sample: 'modifier' = array( 'fieldName1'=>array('inc' => $incValue), 'fieldName2'=>array('set' => $targetValue), 'fieldName3'=>array('unset' => 1), 'fieldName4'=>array('push' => $pushedValue), 'fieldName5'=>array('pushAll' => array($pushedValue1, $pushedValue2)), 'fieldName6'=>array('addToSet' => $addedValue), 'fieldName7'=>array('pop' => 1), 'fieldName8'=>array('pop' => -1), 'fieldName9'=>array('pull' => $removedValue), 'fieldName10'=>array('pullAll' => array($removedValue1, $removedValue2)), 'fieldName11'=>array('rename' => $newFieldName), ); Parameters `$modifier` basic definition of modifiers Since v1.3.6
`public`	# `__call( $name, $arguments )`
`public array`	# `getModifiers( )` Compute modifier to be able to initiate request. Compute modifier to be able to initiate request. Returns array
`public array`	# `getFields( )` Returns array
`public Maslosoft\Mangan\Modifier`	# `mergeWith( Maslosoft\Mangan\Modifier $modifier )` Add a new set of modifiers to current modifiers. If modifiers has already been added for specific field, they will be overwritten. Add a new set of modifiers to current modifiers. If modifiers has already been added for specific field, they will be overwritten. Parameters `$modifier` modifier to merge into current object Returns `Maslosoft\Mangan\Modifier`
`public Maslosoft\Mangan\Modifier`	# `addModifier( string $fieldName, string $modifier, mixed $value )` Add a new modifier rule to specific field. Add a new modifier rule to specific field. Parameters `$fieldName` name of the field we want to update `$modifier` type of the modifier @see \Maslosoft\Mangan\Modifier::$modifiers `$value` value used by the modifier Returns `Maslosoft\Mangan\Modifier`
`public boolean`	# `canApply( )` Check if we have modifiers to apply. Check if we have modifiers to apply. Returns boolean

Magic methods summary

`public`	# `inc( string $fieldName, mixed $value )` inc shorthand inc shorthand Parameters `$fieldName` `$value`
`public`	# `set( string $fieldName, mixed $value )` set shorthand set shorthand Parameters `$fieldName` `$value`
`public`	# `unset( string $fieldName, mixed $value )` unset shorthand unset shorthand Parameters `$fieldName` `$value`
`public`	# `push( string $fieldName, mixed $value )` push shorthand push shorthand Parameters `$fieldName` `$value`
`public`	# `pushAll( string $fieldName, mixed $value )` pushAll shorthand pushAll shorthand Parameters `$fieldName` `$value`
`public`	# `addToSet( string $fieldName, mixed $value )` addToSet shorthand addToSet shorthand Parameters `$fieldName` `$value`
`public`	# `pop( string $fieldName, mixed $value )` pop shorthand pop shorthand Parameters `$fieldName` `$value`
`public`	# `pull( string $fieldName, mixed $value )` pull shorthand pull shorthand Parameters `$fieldName` `$value`
`public`	# `pullAll( string $fieldName, mixed $value )` pullAll shorthand pullAll shorthand Parameters `$fieldName` `$value`
`public`	# `rename( string $fieldName, mixed $value )` rename shorthand rename shorthand Parameters `$fieldName` `$value`

Properties summary

`public static array`	`$modifiers` $modifiers supported modifiers $modifiers supported modifiers Since v1.3.6	# `[ 'inc' => '$inc', 'set' => '$set', 'unset' => '$unset', 'push' => '$push', 'pushAll' => '$pushAll', 'addToSet' => '$addToSet', 'pop' => '$pop', 'pull' => '$pull', 'pullAll' => '$pullAll', 'rename' => '$rename', ]`

API documentation generated by ApiGen

Maslosoft Mangan API

Namespaces

Classes

Class Modifier

Methods summary

Parameters

Since

Returns

Returns

Parameters

Returns

Parameters

Returns

Returns

Magic methods summary

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Properties summary

Since

Contact us