Classes List

Symfony\Component\Config\Definition\NodeInterface

 1 
 2 
 3 
 4 
 5 
 6 
 7 
 8 
 9 
 10 
 11 
 12 
 13 
 14 
 15 
 16 
 17 
 18 
 19 
 20 
 21 
 22 
 23 
 24 
 25 
 26 
 27 
 28 
 29 
 30 
 31 
 32 
 33 
 34 
 35 
 36 
 37 
 38 
 39 
 40 
 41 
 42 
 43 
 44 
 45 
 46 
 47 
 48 
 49 
 50 
 51 
 52 
 53 
 54 
 55 
 56 
 57 
 58 
 59 
 60 
 61 
 62 
 63 
 64 
 65 
 66 
 67 
 68 
 69 
 70 
 71 
 72 
 73 
 74 
 75 
 76 
 77 
 78 
 79 
 80 
 81 
 82 
 83 
 84 
 85 
 86 
 87 
 88 
 89 
 90 
 91 
 92 
 93 
 94 
 95 
 96 
 97 
 98 
 99 
 100 
 101 
<?php

/* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */


namespace Symfony\Component\Config\Definition;

use Symfony\Component\Config\Definition\Exception\ForbiddenOverwriteException;
use Symfony\Component\Config\Definition\Exception\InvalidConfigurationException;
use Symfony\Component\Config\Definition\Exception\InvalidTypeException;

/** * Common Interface among all nodes. * * In most cases, it is better to inherit from BaseNode instead of implementing * this interface yourself. * * @author Johannes M. Schmitt <schmittjoh@gmail.com> */
interface NodeInterface
{
    /** * Returns the name of the node. * * @return string The name of the node */
    public function getName();

    /** * Returns the path of the node. * * @return string The node path */
    public function getPath();

    /** * Returns true when the node is required. * * @return bool If the node is required */
    public function isRequired();

    /** * Returns true when the node has a default value. * * @return bool If the node has a default value */
    public function hasDefaultValue();

    /** * Returns the default value of the node. * * @return mixed The default value * * @throws \RuntimeException if the node has no default value */
    public function getDefaultValue();

    /** * Normalizes a value. * * @param mixed $value The value to normalize * * @return mixed The normalized value * * @throws InvalidTypeException if the value type is invalid */
    public function normalize($value);

    /** * Merges two values together. * * @param mixed $leftSide * @param mixed $rightSide * * @return mixed The merged value * * @throws ForbiddenOverwriteException if the configuration path cannot be overwritten * @throws InvalidTypeException if the value type is invalid */
    public function merge($leftSide$rightSide);

    /** * Finalizes a value. * * @param mixed $value The value to finalize * * @return mixed The finalized value * * @throws InvalidTypeException if the value type is invalid * @throws InvalidConfigurationException if the value is invalid configuration */
    public function finalize($value);
}