PHP Class Scalr\Model\Collections\SettingsCollection

Author: N.V.

Inheritance: extends Scalr\Util\ObjectAccess

Public Methods

Method	Description
__clone ( )	Reset referenced fields
__construct ( string $entityClass, array $criteria, array $defaultProperties = [], array $settings = [] )	SettingsCollection
getArrayCopy ( ) : array	Get array copy
getEntity ( string $name ) : Scalr\Model\Entity\Setting	Gets setting entity
getIterator ( )
getSettingsClass ( ) : string	Gets settings class name
load ( )	Loads settings from DB, if some settings already changed - keeps new values
offsetExists ( $offset )
offsetGet ( string $name ) : string \| null	Gets setting value
offsetSet ( string $name, mixed $setting )	Sets setting value, creates internal entity
save ( )	Saves settings entities to DB
saveSettings ( array $settings )	Saves multiply settings
setCriteria ( array $criteria )	Sets search criteria
setDefaultProperties ( array $defaultProperties )	Sets default values for new entities

Reset referenced fields

public __clone ( )

SettingsCollection

public __construct ( string $entityClass, array $criteria, array $defaultProperties = [], array $settings = [] )
$entityClass	string	Entity class name with namespace
$criteria	array	Search criteria
$defaultProperties	array	optional Default values for new entities
$settings	array	optional Initial settings

Get array copy

public getArrayCopy ( ) : array
return	array	A copy of the array, or array of public properties if ArrayIterator refers to an object.

Gets setting entity

public getEntity ( string $name ) : Scalr\Model\Entity\Setting
$name	string	Setting name
return	Scalr\Model\Entity\Setting

Gets settings class name

public getSettingsClass ( ) : string
return	string	Returns the name of settings class

Loads settings from DB, if some settings already changed - keeps new values

public load ( )

public offsetExists ( $offset )

Gets setting value

Sets setting value, creates internal entity

Saves settings entities to DB

public save ( )

Saves multiply settings

public saveSettings ( array $settings )
$settings	array	Name-value settings array

Sets search criteria

public setCriteria ( array $criteria )
$criteria	array	Search criteria

Sets default values for new entities

public setDefaultProperties ( array $defaultProperties )
$defaultProperties	array	Default values for new entities

public offsetGet ( string $name ) : string \| null
$name	string	Setting name
return	string \| null

public offsetSet ( string $name, mixed $setting )
$name	string	Setting name
$setting	mixed	If $setting is array or object - interprets its fields as entity properties, otherwise - as value