Class ConfigurationAbstract

Provide a standard mechanism for a runtime registry for key/value pairs, useful for attributes and parameters.

ArrayObject implements IteratorAggregate, Traversable, ArrayAccess, Serializable, Countable

Xoops\Core\Text\Sanitizer\ConfigurationAbstract implements Xoops\Core\AttributeInterface

Direct known subclasses

Xoops\Core\Text\Sanitizer\Configuration, Xoops\Core\Text\Sanitizer\DefaultConfiguration

Abstract
Namespace: Xoops\Core\Text\Sanitizer
Package: Xoops\Core\Text
Category: Sanitizer
Copyright: 2013-2015 XOOPS Project (http://xoops.org)
License: GPL 2 or later (http://www.gnu.org/licenses/gpl-2.0.html)
Author: Richard Griffith richard@geekwright.com
Link: http://xoops.org
Located at oops_lib/Xoops/Core/Text/Sanitizer/ConfigurationAbstract.php

Methods summary
`public mixed`	# `get( string $name, mixed $default = null )` Retrieve an attribute value. Retrieve an attribute value. Parameters `$name` Name of an attribute `$default` A default value returned if the requested named attribute is not set. Returns mixed The value of the attribute, or $default if not set. Implementation of `Xoops\Core\AttributeInterface::get()`
`public`	# `set( string $name, mixed $value )` Set an attribute value. Set an attribute value. Parameters `$name` Name of the attribute option `$value` Value of the attribute option Implementation of `Xoops\Core\AttributeInterface::set()`
`public array`	# `getAll( )` Get a copy of all attributes Get a copy of all attributes Returns array An array of attributes
`public array`	# `getNames( )` Get a list of all attribute names Get a list of all attribute names Returns array An array of attribute names/keys
`public boolean`	# `has( string $name )` Determine if an attribute exists. Determine if an attribute exists. Parameters `$name` An attribute name. Returns boolean TRUE if the given attribute exists, otherwise FALSE. Implementation of `Xoops\Core\AttributeInterface::has()`
`public mixed`	# `remove( string $name )` Remove an attribute. Remove an attribute. Parameters `$name` An attribute name. Returns mixed An attribute value, if the named attribute existed and has been removed, otherwise NULL. Implementation of `Xoops\Core\AttributeInterface::remove()`
`public array`	# `clear( )` Remove all attributes. Remove all attributes. Returns array old values Implementation of `Xoops\Core\AttributeInterface::clear()`
`public array`	# `setAll( mixed $values )` Replace all attribute with new set Replace all attribute with new set Parameters `$values` array (or object) of new attributes Returns array old values
`public`	# `setMerge( array $values )` Set multiple attributes by using an associative array Set multiple attributes by using an associative array Parameters `$values` array of new attributes
`public`	# `setArrayItem( string $stem, string $name, mixed $value )` Set an element attribute array Set an element attribute array This allows an attribute which is an array to be built one element at a time. Parameters `$stem` An attribute array name. `$name` An attribute array item name. If empty, the value will be appended to the end of the array rather than added with the key $name. `$value` An attribute array item value.
`public array`	# `getAllLike( string\|null $nameLike = null )` Retrieve a set of attributes based on a partial name Retrieve a set of attributes based on a partial name Parameters `$nameLike` restrict output to only attributes with a name starting with this string. Returns array an array of all attributes with names matching $nameLike

Methods inherited from ArrayObject
`__construct(), append(), asort(), count(), exchangeArray(), getArrayCopy(), getFlags(), getIterator(), getIteratorClass(), ksort(), natcasesort(), natsort(), offsetExists(), offsetGet(), offsetSet(), offsetUnset(), serialize(), setFlags(), setIteratorClass(), uasort(), uksort(), unserialize()`

Constants inherited from ArrayObject
`ARRAY_AS_PROPS, STD_PROP_LIST`

Namespaces

Classes

Class ConfigurationAbstract

Direct known subclasses

Parameters

Returns

Implementation of

Parameters

Implementation of

Returns

Returns

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Parameters

Parameters

Parameters

Returns