Chris@0: <?php
Chris@0: 
Chris@0: namespace Drupal\Core\Template;
Chris@0: 
Chris@0: use Drupal\Component\Utility\Html;
Chris@0: 
Chris@0: /**
Chris@0:  * A class that defines a type of Attribute that can be added to as an array.
Chris@0:  *
Chris@0:  * To use with Attribute, the array must be specified.
Chris@0:  * Correct:
Chris@0:  * @code
Chris@0:  *  $attributes = new Attribute();
Chris@0:  *  $attributes['class'] = array();
Chris@0:  *  $attributes['class'][] = 'cat';
Chris@0:  * @endcode
Chris@0:  * Incorrect:
Chris@0:  * @code
Chris@0:  *  $attributes = new Attribute();
Chris@0:  *  $attributes['class'][] = 'cat';
Chris@0:  * @endcode
Chris@0:  *
Chris@0:  * @see \Drupal\Core\Template\Attribute
Chris@0:  */
Chris@0: class AttributeArray extends AttributeValueBase implements \ArrayAccess, \IteratorAggregate {
Chris@0: 
Chris@0:   /**
Chris@0:    * Ensures empty array as a result of array_filter will not print '$name=""'.
Chris@0:    *
Chris@0:    * @see \Drupal\Core\Template\AttributeArray::__toString()
Chris@0:    * @see \Drupal\Core\Template\AttributeValueBase::render()
Chris@0:    */
Chris@0:   const RENDER_EMPTY_ATTRIBUTE = FALSE;
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function offsetGet($offset) {
Chris@0:     return $this->value[$offset];
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function offsetSet($offset, $value) {
Chris@0:     if (isset($offset)) {
Chris@0:       $this->value[$offset] = $value;
Chris@0:     }
Chris@0:     else {
Chris@0:       $this->value[] = $value;
Chris@0:     }
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function offsetUnset($offset) {
Chris@0:     unset($this->value[$offset]);
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function offsetExists($offset) {
Chris@0:     return isset($this->value[$offset]);
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Implements the magic __toString() method.
Chris@0:    */
Chris@0:   public function __toString() {
Chris@0:     // Filter out any empty values before printing.
Chris@0:     $this->value = array_unique(array_filter($this->value));
Chris@0:     return Html::escape(implode(' ', $this->value));
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function getIterator() {
Chris@0:     return new \ArrayIterator($this->value);
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Exchange the array for another one.
Chris@0:    *
Chris@0:    * @see ArrayObject::exchangeArray
Chris@0:    *
Chris@0:    * @param array $input
Chris@0:    *   The array input to replace the internal value.
Chris@0:    *
Chris@0:    * @return array
Chris@0:    *   The old array value.
Chris@0:    */
Chris@0:   public function exchangeArray($input) {
Chris@0:     $old = $this->value;
Chris@0:     $this->value = $input;
Chris@0:     return $old;
Chris@0:   }
Chris@0: 
Chris@0: }