• Главная
• Jarves
• Configuration
• Model

PHP Класс Jarves\Configuration\Model

Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство	Тип	Описание
$serialisationJarvesCore	Jarves\Jarves

Защищенные свойства (Protected)

Свойство	Тип	Описание
$_defaultProperties
$_excludeFromExport	array
$_modelProperties
$additionalAttributes	array	Contains the additional (not defined properties) attributes.
$additionalNodes	array	Contains the additional (not defined properties) children nodes.
$arrayIndexNames	array	Scenario: ConfigClass => protected $modules; //@var array protected $arrayIndexNames = ['modules' => 'module']; Resulted xml: value value2 If you not defined $arrayIndexNames and if you don't have a proper class name as @var then it will export '' children instead of the ''.
$arrayKey	ConfigCacheClass[]	Scenario: ConfigClass => protected $caches; //@var ConfigCacheClass[] ConfigCacheClass => protected $id; protected $value; protected $arrayKey => 'id'; ConfigClass->propertyToArray('caches') -> array('' => $ConfigCacheClass, ...)
$attributes	array	Defines which values are attributes of the element.
$docBlock	string	Defines a comment for the root element.
$docBlocks	array	Example: ['caches' => 'blabla']
$element	DOMElement	The element passed in constructor.
$elementToArray	ConfigCacheClass[]	Scenario: foo bar Example: ConfigClass => protected $elementToArray = ['cache' => 'caches']; protected $caches; //@var ConfigCacheClass[]
$excludeDefaults	array	Defines which properties should be excluded when they have the default value.
$jarves	Jarves\Jarves
$lastRootElementComment
$nodeValueVar	string	Defines which property is used as the nodeValue.
$requiredProperties	string[]	A list of property names that are required and can no be ommited or be null.
$rootName	string	The name of the element of this class.

Открытые методы

Метод	Описание
__construct ( DOMElement | array | string $values = null, Jarves $jarves = null )
__sleep ( )
__toString ( ) : string
__wakeup ( )	}
appendXml ( DOMNode $node, boolean $printDefaults = false, boolean $printComments = false ) : DOMElement	Appends the xml structure with our values.
appendXmlProperty ( string $key, DOMNode $parentNode, boolean $printDefaults = false, boolean $printComments = false ) : DOMNode | void
appendXmlValue ( string $key, mixed $value, DOMNode $node, boolean $arrayType = false, boolean $printDefaults = false, boolean $printComments = false ) : DOMNode	Appends the xm structure with the given values.
bool ( mixed $val ) : boolean
canPropertyBeExported ( $key )
extractExtraNodes ( DOMNode $child, array &$options )
fromArray ( mixed $values, string $arrayKeyValue = null )
getAdditional ( string $key ) : mixed
getAdditionalAttribute ( string $key ) : mixed
getArrayKey ( )
getArrayKeyValue ( )
getClass ( ) : string
getDirectChild ( string $tag ) : DOMElement
getDirectChildren ( string $tag ) : DOMElement[]
getDocBlock ( ) : string
getDocBlocks ( ) : array
getElement ( ) : DOMElement
getElementArrayName ( $property )
getJarves ( ) : Jarves
getMethodMetaData ( ReflectionMethod | ReflectionClass $reflection ) : array | boolean
getNamespacePath ( )
getParameterValues ( string $element = 'parameters', string $childrenElement = 'parameter', string $keyName = 'id' ) : array	first second bar sa
getPropertyDescription ( string $property ) : null | string
getRootName ( ) : string
importNode ( DOMNode $element ) : array
initialize ( $values = null, $jarves = null )
offsetExists ( mixed $offset ) : boolean
offsetGet ( mixed $offset ) : mixed
offsetSet ( mixed $offset, mixed $value )
offsetUnset ( mixed $offset )
parsePhpDoc ( string $string ) : array	Parse phpDoc string and returns an array.
propertyFromArray ( string $key, mixed $value )
propertyToArray ( string $k, $printDefaults = false ) : mixed
save ( string $path, boolean $withDefaults = false ) : boolean	Saves the xml into a file.
setArrayKeyValue ( $value )
setAttributeVar ( string $variableName )
setElement ( DOMElement $element )
setJarves ( Jarves $jarves )
setVar ( string $variableName )
setupObject ( $jarves = null )	Initialize the object.
toArray ( boolean $printDefaults = false ) : array
toXml ( boolean $printDefaults = false, boolean $printComments = false ) : string	Generates a XML string with all current values.

Защищенные методы

Метод	Описание
checkRequirements ( )	Checks $this->requiredProperties and throws a exception when not met

Описание методов

Описание свойств