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 if not yet existing from the class of an object
Chris@0:  * in another field.
Chris@0:  *
Chris@0:  * The comparison is done with instanceof to support proxy classes and such.
Chris@0:  *
Chris@0:  * Only works with RouteObjectInterface routes that can return a referenced
Chris@0:  * content.
Chris@0:  *
Chris@0:  * @author David Buchmann
Chris@0:  */
Chris@0: class FieldByClassEnhancer implements RouteEnhancerInterface
Chris@0: {
Chris@0:     /**
Chris@0:      * @var string field for the source class
Chris@0:      */
Chris@0:     protected $source;
Chris@0:     /**
Chris@0:      * @var string field to write hashmap lookup result into
Chris@0:      */
Chris@0:     protected $target;
Chris@0:     /**
Chris@0:      * @var array containing the mapping between a class name and the target value
Chris@0:      */
Chris@0:     protected $map;
Chris@0: 
Chris@0:     /**
Chris@0:      * @param string $source the field name of the class
Chris@0:      * @param string $target the field name to set from the map
Chris@0:      * @param array  $map    the map of class names to field values
Chris@0:      */
Chris@0:     public function __construct($source, $target, $map)
Chris@0:     {
Chris@0:         $this->source = $source;
Chris@0:         $this->target = $target;
Chris@0:         $this->map = $map;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * If the source field is instance of one of the entries in the map,
Chris@0:      * target is set to the value of that map entry.
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 (!isset($defaults[$this->source])) {
Chris@0:             return $defaults;
Chris@0:         }
Chris@0: 
Chris@0:         // we need to loop over the array and do instanceof in case the content
Chris@0:         // class extends the specified class
Chris@0:         // i.e. phpcr-odm generates proxy class for the content.
Chris@0:         foreach ($this->map as $class => $value) {
Chris@0:             if ($defaults[$this->source] instanceof $class) {
Chris@0:                 // found a matching entry in the map
Chris@0:                 $defaults[$this->target] = $value;
Chris@0: 
Chris@0:                 return $defaults;
Chris@0:             }
Chris@0:         }
Chris@0: 
Chris@0:         return $defaults;
Chris@0:     }
Chris@0: }