Class waSettings

This file is part of Webasyst framework.

Licensed under the terms of the GNU Lesser General Public License (LGPL). http://www.webasyst.com/framework/license/

waSettings implements Countable, ArrayAccess, Iterator, Serializable

Direct known subclasses

Abstract
Package: wa-apps\blog
Copyright: 2011 Webasyst LLC
Author: Webasyst LLC
Link: http://www.webasyst.com/
Located at wa-apps/blog/lib/classes/settings/waSettings.class.php

Methods summary
`protected`	# `__construct( mixed $name = __CLASS__ )`
`public`	# `__destruct( )`
`public`	# `initSettingsParams( mixed & $settingsParams )` Parameters `$settingsParams` `mixed` $settingsParams Todo check data structure
`abstract protected`	# `load( )`
`final protected`	# `loadSetting( mixed $name, mixed $value )` Parameters `$name` `mixed` $name `$value` `mixed` $value Todo use Cast to check type
`abstract protected`	# `saveSetting( string $name, mixed $value )` Parameters `$name` `string` $name `$value` `mixed` $value
`public`	# `save( boolean $force = false )` Store settings at storage Store settings at storage Parameters `$force` `boolean` $force
`abstract protected`	# `onDelete( string $name = null )` Remove specified or all settings values from storage Remove specified or all settings values from storage Parameters `$name` `string` $name
`public`	# `delete( )` Remove all settings from storage Remove all settings from storage
`public`	# `revert( )` Ignore changed settings - not store them at storage Ignore changed settings - not store them at storage
`abstract public`	# `reset( )` Load default settings if it aviable Load default settings if it aviable
`private mixed`	# `cast( string $field, mixed $value )` Parameters `$field` `string` $field `$value` `mixed` $value Returns `mixed` Throws `waException`
`public string`	# `getControl( string $type, string $name, array $params = array() )` Get control html code Get control html code Parameters `$type` `string` $type Type of control (use standard or try to found registered control types) `$name` `string` $name `$params` `array` $params Returns `string` Throws `waException` See waHtmlControl#getControl()
`abstract public`	# `flush( )` Flush settings cache Flush settings cache
`public Boolean`	# `offsetExists( string $name )` Returns true if the parameter exists (implements the ArrayAccess interface). Returns true if the parameter exists (implements the ArrayAccess interface). Parameters `$name` `string` $name The parameter name Returns `Boolean` true if the parameter exists, false otherwise Implementation of `ArrayAccess::offsetExists()`
`public mixed`	# `offsetGet( string $name )` Returns a parameter value (implements the ArrayAccess interface). Returns a parameter value (implements the ArrayAccess interface). Parameters `$name` `string` $name The parameter name Returns `mixed` The parameter value Throws `waException` `InvalidArgumentException` Implementation of `ArrayAccess::offsetGet()`
`public`	# `offsetSet( string $name, mixed $value )` Sets a parameter (implements the ArrayAccess interface). Sets a parameter (implements the ArrayAccess interface). Parameters `$name` `string` $name The parameter name `$value` `mixed` $value The parameter value Implementation of `ArrayAccess::offsetSet()`
`public`	# `offsetUnset( string $name )` Removes a parameter (implements the ArrayAccess interface). Removes a parameter (implements the ArrayAccess interface). Parameters `$name` `string` $name The parameter name Implementation of `ArrayAccess::offsetUnset()`
`public`	# `rewind( )` Implementation of `Iterator::rewind()`
`public`	# `current( )` Implementation of `Iterator::current()`
`public`	# `key( )` Implementation of `Iterator::key()`
`public`	# `next( )` Implementation of `Iterator::next()`
`public`	# `valid( )` Implementation of `Iterator::valid()`
`public`	# `count( )` Implementation of `Countable::count()`
`public`	# `serialize( )` Implementation of `Serializable::serialize()`
`public`	# `unserialize( mixed $data )` Implementation of `Serializable::unserialize()`

Constants summary
`string`	`TYPE_INT`	`'int'`	#
`string`	`TYPE_FLOAT`	`'float'`	#
`string`	`TYPE_POSITIVE`	`'positive'`	#
`string`	`TYPE_TEXT`	`'text'`	#
`string`	`TYPE_BOOLEAN`	`'boolean'`	#
`string`	`TYPE_CUSTOM`	`'custom'`	#

Properties summary
`protected array`	`$settings`	`null`	# Array of settings Array of settings
`protected array`	`$settingsChanged`	`array()`	# Array of flags for changed settings Array of flags for changed settings
`protected boolean`	`$approvedSettings`	`false`	# store setting at storage on destroy store setting at storage on destroy
`protected array`	`$settingsParams`	`null`	# Pointer to custom properties of settings Pointer to custom properties of settings
`protected integer`	`$settingsCounter`	`0`	#
`protected string`	`$name`		# Name of settings instance Name of settings instance

Packages

Classes

Class waSettings

Direct known subclasses

Parameters

Todo

Parameters

Todo

Parameters

Parameters

Parameters

Parameters

Returns

Throws

Parameters

Returns

Throws

See

Parameters

Returns

Implementation of

Parameters

Returns

Throws

Implementation of

Parameters

Implementation of

Parameters

Implementation of

Implementation of

Implementation of

Implementation of

Implementation of

Implementation of

Implementation of

Implementation of

Implementation of