Chris@0: <?php
Chris@0: 
Chris@0: /*
Chris@0:  * This file is part of the Symfony CMF package.
Chris@0:  *
Chris@0:  * (c) 2011-2015 Symfony CMF
Chris@0:  *
Chris@0:  * For the full copyright and license information, please view the LICENSE
Chris@0:  * file that was distributed with this source code.
Chris@0:  */
Chris@0: 
Chris@0: namespace Symfony\Cmf\Component\Routing\Enhancer;
Chris@0: 
Chris@0: use Symfony\Component\HttpFoundation\Request;
Chris@0: 
Chris@0: /**
Chris@0:  * This enhancer sets a field to a fixed value. You can specify a source field
Chris@0:  * name to only set the target field if the source is present.
Chris@0:  *
Chris@0:  * @author David Buchmann
Chris@0:  */
Chris@0: class FieldPresenceEnhancer implements RouteEnhancerInterface
Chris@0: {
Chris@0:     /**
Chris@0:      * Field name for the source field that must exist. If null, the target
Chris@0:      * field is always set if not already present.
Chris@0:      *
Chris@0:      * @var string|null
Chris@0:      */
Chris@0:     protected $source;
Chris@0: 
Chris@0:     /**
Chris@0:      * Field name to write the value into.
Chris@0:      *
Chris@0:      * @var string
Chris@0:      */
Chris@0:     protected $target;
Chris@0: 
Chris@0:     /**
Chris@0:      * Value to set the target field to.
Chris@0:      *
Chris@0:      * @var string
Chris@0:      */
Chris@0:     private $value;
Chris@0: 
Chris@0:     /**
Chris@0:      * @param null|string $source the field name of the class, null to disable the check
Chris@0:      * @param string      $target the field name to set from the map
Chris@0:      * @param string      $value  value to set target field to if source field exists
Chris@0:      */
Chris@0:     public function __construct($source, $target, $value)
Chris@0:     {
Chris@0:         $this->source = $source;
Chris@0:         $this->target = $target;
Chris@0:         $this->value = $value;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritdoc}
Chris@0:      */
Chris@0:     public function enhance(array $defaults, Request $request)
Chris@0:     {
Chris@0:         if (isset($defaults[$this->target])) {
Chris@0:             // no need to do anything
Chris@0:             return $defaults;
Chris@0:         }
Chris@0: 
Chris@0:         if (null !== $this->source && !isset($defaults[$this->source])) {
Chris@0:             return $defaults;
Chris@0:         }
Chris@0: 
Chris@0:         $defaults[$this->target] = $this->value;
Chris@0: 
Chris@0:         return $defaults;
Chris@0:     }
Chris@0: }