Overview

Namespaces

  • Contrib
    • Bundle
      • CoverallsBundle
        • Console
        • Entity
      • CoverallsV1Bundle
        • Api
        • Collector
        • Command
        • Config
        • Entity
          • Git
    • Component
      • File
      • Log
      • System
        • Git
  • Guzzle
    • Batch
      • Exception
    • Cache
    • Common
      • Exception
    • Http
      • Curl
      • Exception
      • Message
      • QueryAggregator
    • Inflection
    • Iterator
    • Log
    • Parser
      • Cookie
      • Message
      • UriTemplate
      • Url
    • Plugin
      • Async
      • Backoff
      • Cache
      • Cookie
        • CookieJar
        • Exception
      • CurlAuth
      • ErrorResponse
        • Exception
      • History
      • Log
      • Md5
      • Mock
      • Oauth
    • Service
      • Builder
      • Command
        • Factory
        • LocationVisitor
          • Request
          • Response
      • Description
      • Exception
      • Resource
    • Stream
  • PHP
  • Psr
    • Log
  • Symfony
    • Component
      • Config
        • Definition
          • Builder
          • Exception
        • Exception
        • Loader
        • Resource
        • Util
      • Console
        • Command
        • Formatter
        • Helper
        • Input
        • Output
        • Tester
      • EventDispatcher
        • Debug
      • Finder
        • Adapter
        • Comparator
        • Exception
        • Expression
        • Iterator
        • Shell
      • Stopwatch
      • Yaml
        • Exception

Classes

  • ArrayNode
  • BaseNode
  • BooleanNode
  • EnumNode
  • FloatNode
  • IntegerNode
  • NumericNode
  • Processor
  • PrototypedArrayNode
  • ReferenceDumper
  • ScalarNode
  • VariableNode

Interfaces

  • ConfigurationInterface
  • NodeInterface
  • PrototypeNodeInterface
  • Overview
  • Namespace
  • Class
  • Tree
  • Todo

Class ArrayNode

Represents an Array node in the config tree.

Symfony\Component\Config\Definition\BaseNode implements Symfony\Component\Config\Definition\NodeInterface
Extended by Symfony\Component\Config\Definition\ArrayNode implements Symfony\Component\Config\Definition\PrototypeNodeInterface

Direct known subclasses

Symfony\Component\Config\Definition\PrototypedArrayNode
Namespace: Symfony\Component\Config\Definition
Author: Johannes M. Schmitt <schmittjoh@gmail.com>
Located at config/Symfony/Component/Config/Definition/ArrayNode.php
Methods summary
public
# __construct( string $name, Symfony\Component\Config\Definition\NodeInterface $parent = null )

Constructor.

Constructor.

Parameters

$name
string
$name The Node's name
$parent
Symfony\Component\Config\Definition\NodeInterface
$parent The node parent

Throws

InvalidArgumentException
if the name contains a period.

Overrides

Symfony\Component\Config\Definition\BaseNode::__construct()
public
# setNormalizeKeys( mixed $normalizeKeys )
protected array
# preNormalize( mixed $value )

Normalizes keys between the different configuration formats.

Normalizes keys between the different configuration formats.

Namely, you mostly have foo_bar in YAML while you have foo-bar in XML. After running this method, all keys are normalized to foo_bar.

If you have a mixed key like foo-bar_moo, it will not be altered. The key will also not be altered if the target key already exists.

Parameters

$value
mixed
$value

Returns

array
The value with normalized keys

Overrides

Symfony\Component\Config\Definition\BaseNode::preNormalize()
public array
# getChildren( )

Retrieves the children of this node.

Retrieves the children of this node.

Returns

array
The children
public
# setXmlRemappings( array $remappings )

Sets the xml remappings that should be performed.

Sets the xml remappings that should be performed.

Parameters

$remappings
array
$remappings an array of the form array(array(string, string))
public
# setAddIfNotSet( Boolean $boolean )

Sets whether to add default values for this array if it has not been defined in any of the configuration files.

Sets whether to add default values for this array if it has not been defined in any of the configuration files.

Parameters

$boolean
Boolean
$boolean
public
# setAllowFalse( Boolean $allow )

Sets whether false is allowed as value indicating that the array should be unset.

Sets whether false is allowed as value indicating that the array should be unset.

Parameters

$allow
Boolean
$allow
public
# setAllowNewKeys( Boolean $allow )

Sets whether new keys can be defined in subsequent configurations.

Sets whether new keys can be defined in subsequent configurations.

Parameters

$allow
Boolean
$allow
public
# setPerformDeepMerging( Boolean $boolean )

Sets if deep merging should occur.

Sets if deep merging should occur.

Parameters

$boolean
Boolean
$boolean
public
# setIgnoreExtraKeys( Boolean $boolean )

Whether extra keys should just be ignore without an exception.

Whether extra keys should just be ignore without an exception.

Parameters

$boolean
Boolean
$boolean To allow extra keys
public
# setName( string $name )

Sets the node Name.

Sets the node Name.

Parameters

$name
string
$name The node's name

Implementation of

Symfony\Component\Config\Definition\PrototypeNodeInterface::setName()
public Boolean
# hasDefaultValue( )

Checks if the node has a default value.

Checks if the node has a default value.

Returns

Boolean

Implementation of

Symfony\Component\Config\Definition\NodeInterface::hasDefaultValue()
public array
# getDefaultValue( )

Retrieves the default value.

Retrieves the default value.

Returns

array
The default value

Throws

RuntimeException
if the node has no default value

Implementation of

Symfony\Component\Config\Definition\NodeInterface::getDefaultValue()
public
# addChild( Symfony\Component\Config\Definition\NodeInterface $node )

Adds a child node.

Adds a child node.

Parameters

$node
Symfony\Component\Config\Definition\NodeInterface
$node The child node to add

Throws

InvalidArgumentException
when the child node has no name
InvalidArgumentException
when the child node's name is not unique
protected mixed
# finalizeValue( mixed $value )

Finalizes the value of this node.

Finalizes the value of this node.

Parameters

$value
mixed
$value

Returns

mixed
The finalised value

Throws

Symfony\Component\Config\Definition\Exception\UnsetKeyException
Symfony\Component\Config\Definition\Exception\InvalidConfigurationException
if the node doesn't have enough children
protected
# validateType( mixed $value )

Validates the type of the value.

Validates the type of the value.

Parameters

$value
mixed
$value

Throws

Symfony\Component\Config\Definition\Exception\InvalidTypeException
protected mixed
# normalizeValue( mixed $value )

Normalizes the value.

Normalizes the value.

Parameters

$value
mixed
$value The value to normalize

Returns

mixed
The normalized value

Throws

Symfony\Component\Config\Definition\Exception\InvalidConfigurationException
protected array
# remapXml( array $value )

Remaps multiple singular values to a single plural value.

Remaps multiple singular values to a single plural value.

Parameters

$value
array
$value The source values

Returns

array
The remapped values
protected mixed
# mergeValues( mixed $leftSide, mixed $rightSide )

Merges values together.

Merges values together.

Parameters

$leftSide
mixed
$leftSide The left side to merge.
$rightSide
mixed
$rightSide The right side to merge.

Returns

mixed
The merged values

Throws

Symfony\Component\Config\Definition\Exception\InvalidConfigurationException
RuntimeException
Methods inherited from Symfony\Component\Config\Definition\BaseNode
addEquivalentValue(), finalize(), getAttribute(), getAttributes(), getExample(), getInfo(), getName(), getPath(), hasAttribute(), isRequired(), merge(), normalize(), removeAttribute(), setAllowOverwrite(), setAttribute(), setAttributes(), setExample(), setFinalValidationClosures(), setInfo(), setNormalizationClosures(), setRequired()
Properties summary
protected mixed $xmlRemappings
#
protected mixed $children
#
protected mixed $allowFalse
#
protected mixed $allowNewKeys
#
protected mixed $addIfNotSet
#
protected mixed $performDeepMerging
#
protected mixed $ignoreExtraKeys
#
protected mixed $normalizeKeys
#
Properties inherited from Symfony\Component\Config\Definition\BaseNode
$allowOverwrite, $attributes, $equivalentValues, $finalValidationClosures, $name, $normalizationClosures, $parent, $required
php-coveralls API documentation generated by ApiGen 2.8.0