+ | <?php |
+ | |
+ | namespace TwbBundle\View\Helper; |
+ | |
+ | use Zend\Form\View\Helper\AbstractHelper; |
+ | use LogicException; |
+ | use InvalidArgumentException; |
+ | |
+ | class TwbBundleDropDown extends AbstractHelper |
+ | { |
+ | |
+ | |
+ | |
+ | |
+ | const TYPE_ITEM_HEADER = 'header'; |
+ | |
+ | |
+ | |
+ | |
+ | const TYPE_ITEM_DIVIDER = '---'; |
+ | |
+ | |
+ | |
+ | |
+ | const TYPE_ITEM_LINK = 'link'; |
+ | |
+ | |
+ | |
+ | |
+ | protected static $dropdownContainerFormat = '<div %s>%s</div>'; |
+ | |
+ | |
+ | |
+ | |
+ | protected static $dropdownToggleFormat = '<a %s>%s <b class="caret"></b></a>'; |
+ | |
+ | |
+ | |
+ | |
+ | protected static $dropdownListFormat = '<ul %s>%s</ul>'; |
+ | |
+ | |
+ | |
+ | |
+ | protected static $dropdownItemContainerFormat = '<li %s>%s</li>'; |
+ | |
+ | |
+ | |
+ | |
+ | protected static $dropdownItemFormats = array( |
+ | self::TYPE_ITEM_LINK => '<a %s>%s</a>', |
+ | ); |
+ | |
+ | |
+ | |
+ | |
+ | |
+ | public function __invoke(array $aDropdownOptions = null) |
+ | { |
+ | return $aDropdownOptions ? $this->render($aDropdownOptions) : $this; |
+ | } |
+ | |
+ | |
+ | |
+ | |
+ | |
+ | |
+ | |
+ | public function render(array $aDropdownOptions) |
+ | { |
+ | |
+ | if (empty($aDropdownOptions['attributes'])) { |
+ | |
+ | $aDropdownOptions['attributes'] = array('class' => 'dropdown'); |
+ | } else { |
+ | if (!is_array($aDropdownOptions['attributes'])) { |
+ | throw new LogicException('"attributes" option expects an array, "' . gettype($aDropdownOptions['attributes']) . '" given'); |
+ | } |
+ | |
+ | if (empty($aDropdownOptions['attributes']['class'])) { |
+ | |
+ | $aDropdownOptions['attributes']['class'] = 'dropdown'; |
+ | } elseif (!preg_match('/(\s|^)dropdown(\s|$)/', $aDropdownOptions['attributes']['class'])) { |
+ | |
+ | $aDropdownOptions['attributes']['class'] .= ' dropdown'; |
+ | } |
+ | } |
+ | |
+ | |
+ | return sprintf( |
+ | static::$dropdownContainerFormat, $this->createAttributesString($aDropdownOptions['attributes']), |
+ | $this->renderToggle($aDropdownOptions) . |
+ | $this->renderListItems($aDropdownOptions) |
+ | ); |
+ | } |
+ | |
+ | |
+ | |
+ | |
+ | |
+ | |
+ | |
+ | public function renderToggle(array $aDropdownOptions) |
+ | { |
+ | |
+ | if (empty($aDropdownOptions['label'])) { |
+ | $aDropdownOptions['label'] = ''; |
+ | } elseif (!is_scalar($aDropdownOptions['label'])) { |
+ | throw new InvalidArgumentException('"label" option expects a scalar value, "' . gettype($aDropdownOptions['label']) . '" given'); |
+ | } elseif (($oTranslator = $this->getTranslator())) { |
+ | $aDropdownOptions['label'] = $oTranslator->translate($aDropdownOptions['label'], $this->getTranslatorTextDomain()); |
+ | } |
+ | |
+ | |
+ | if (empty($aDropdownOptions['toggle_attributes'])) { |
+ | $aDropdownOptions['toggle_attributes'] = array('class' => 'sr-only dropdown-toggle'); |
+ | } else { |
+ | if (!is_array($aDropdownOptions['toggle_attributes'])) { |
+ | throw new InvalidArgumentException('"toggle_attributes" option expects an array, "' . gettype($aDropdownOptions['toggle_attributes']) . '" given'); |
+ | } |
+ | |
+ | if (empty($aDropdownOptions['toggle_attributes']['class'])) { |
+ | $aDropdownOptions['toggle_attributes']['class'] = 'sr-only dropdown-toggle'; |
+ | } else { |
+ | if (!preg_match('/(\s|^)sr-only(\s|$)/', $aDropdownOptions['toggle_attributes']['class'])) { |
+ | $aDropdownOptions['toggle_attributes']['class'] .= ' sr-only'; |
+ | } |
+ | if (!preg_match('/(\s|^)dropdown-toggle(\s|$)/', $aDropdownOptions['toggle_attributes']['class'])) { |
+ | $aDropdownOptions['toggle_attributes']['class'] .= ' dropdown-toggle'; |
+ | } |
+ | } |
+ | } |
+ | |
+ | |
+ | if (empty($aDropdownOptions['toggle_attributes']['data-toggle'])) { |
+ | $aDropdownOptions['toggle_attributes']['data-toggle'] = 'dropdown'; |
+ | } |
+ | |
+ | |
+ | if (empty($aDropdownOptions['toggle_attributes']['role'])) { |
+ | $aDropdownOptions['toggle_attributes']['role'] = 'button'; |
+ | } |
+ | |
+ | |
+ | if (empty($aDropdownOptions['toggle_attributes']['href'])) { |
+ | $aDropdownOptions['toggle_attributes']['href'] = '#'; |
+ | } |
+ | |
+ | |
+ | if (!empty($aDropdownOptions['name'])) { |
+ | $aDropdownOptions['toggle_attributes']['id'] = $aDropdownOptions['name']; |
+ | } |
+ | |
+ | $aValidTagAttributes = $this->validTagAttributes; |
+ | $this->validTagAttributes = array('href' => true); |
+ | $sAttributeString = $this->createAttributesString($aDropdownOptions['toggle_attributes']); |
+ | $this->validTagAttributes = $aValidTagAttributes; |
+ | |
+ | return sprintf( |
+ | static::$dropdownToggleFormat, $sAttributeString, |
+ | $this->getEscapeHtmlHelper()->__invoke($aDropdownOptions['label']) |
+ | ); |
+ | } |
+ | |
+ | |
+ | |
+ | |
+ | |
+ | |
+ | |
+ | public function renderListItems(array $aDropdownOptions) |
+ | { |
+ | if (!isset($aDropdownOptions['items'])) { |
+ | throw new LogicException(__METHOD__ . ' expects "items" option'); |
+ | } |
+ | |
+ | if (!is_array($aDropdownOptions['items'])) { |
+ | throw new LogicException('"items" option expects an array, "' . gettype($aDropdownOptions['items']) . '" given'); |
+ | } |
+ | |
+ | |
+ | if (empty($aDropdownOptions['list_attributes'])) { |
+ | $aDropdownOptions['list_attributes'] = array('class' => 'dropdown-menu'); |
+ | } else { |
+ | if (!is_array($aDropdownOptions['list_attributes'])) { |
+ | throw new \LogicException('"list_attributes" option expects an array, "' . gettype($aDropdownOptions['list_attributes']) . '" given'); |
+ | } |
+ | |
+ | if (empty($aDropdownOptions['list_attributes']['class'])) { |
+ | $aDropdownOptions['list_attributes']['class'] = 'dropdown-menu'; |
+ | } elseif (!preg_match('/(\s|^)dropdown-menu(\s|$)/', $aDropdownOptions['list_attributes']['class'])) { |
+ | $aDropdownOptions['list_attributes']['class'] .= ' dropdown-menu'; |
+ | } |
+ | } |
+ | |
+ | |
+ | if (empty($aDropdownOptions['list_attributes']['role'])) { |
+ | $aDropdownOptions['list_attributes']['role'] = 'menu'; |
+ | } |
+ | |
+ | |
+ | if (!empty($aDropdownOptions['name'])) { |
+ | $aDropdownOptions['list_attributes']['aria-labelledby'] = $aDropdownOptions['name']; |
+ | } |
+ | |
+ | |
+ | $sItems = ''; |
+ | foreach ($aDropdownOptions['items'] as $sKey => $aItemOptions) { |
+ | if (!is_array($aItemOptions)) { |
+ | if (!is_scalar($aItemOptions)) { |
+ | throw new \LogicException('item option expects an array or a scalar value, "' . gettype($aItemOptions) . '" given'); |
+ | } |
+ | $aItemOptions = $aItemOptions === self::TYPE_ITEM_DIVIDER |
+ | |
+ | ? array('type' => self::TYPE_ITEM_DIVIDER) |
+ | |
+ | : array( |
+ | 'label' => $aItemOptions, |
+ | 'type' => self::TYPE_ITEM_LINK, |
+ | 'item_attributes' => array('href' => is_string($sKey) ? $sKey : null) |
+ | ); |
+ | } else { |
+ | if (!isset($aItemOptions['label'])) { |
+ | $aItemOptions['label'] = is_string($sKey) ? $sKey : null; |
+ | } |
+ | |
+ | if (!isset($aItemOptions['type'])) { |
+ | $aItemOptions['type'] = self::TYPE_ITEM_LINK; |
+ | } |
+ | } |
+ | $sItems .= $this->renderItem($aItemOptions) . "\n"; |
+ | } |
+ | |
+ | return sprintf( |
+ | static::$dropdownListFormat, $this->createAttributesString($aDropdownOptions['list_attributes']), |
+ | $sItems |
+ | ); |
+ | } |
+ | |
+ | |
+ | |
+ | |
+ | |
+ | |
+ | |
+ | protected function renderItem($aItemOptions) |
+ | { |
+ | if (empty($aItemOptions['type'])) { |
+ | throw new \LogicException(__METHOD__ . ' expects "type" option'); |
+ | } |
+ | |
+ | |
+ | if (empty($aItemOptions['attributes'])) { |
+ | $aItemOptions['attributes'] = array(); |
+ | } elseif (!is_array($aItemOptions['attributes'])) { |
+ | throw new \LogicException('"attributes" option expects an array, "' . gettype($aItemOptions['attributes']) . '" given'); |
+ | } |
+ | |
+ | |
+ | if (empty($aItemOptions['attributes']['role'])) { |
+ | $aItemOptions['attributes']['role'] = 'presentation'; |
+ | } |
+ | |
+ | $sItemContent = ''; |
+ | switch ($aItemOptions['type']) { |
+ | case self::TYPE_ITEM_HEADER: |
+ | |
+ | if (empty($aItemOptions['attributes']['class'])) { |
+ | $aItemOptions['attributes']['class'] = 'dropdown-header'; |
+ | } elseif (!preg_match('/(\s|^)dropdown-header(\s|$)/', $aItemOptions['attributes']['class'])) { |
+ | $aItemOptions['attributes']['class'] .= ' dropdown-header'; |
+ | } |
+ | |
+ | |
+ | if (empty($aItemOptions['label'])) { |
+ | throw new \LogicException('"' . $aItemOptions['type'] . '" item expects "label" option'); |
+ | } |
+ | |
+ | if (!is_scalar($aItemOptions['label'])) { |
+ | throw new \LogicException('"label" option expect scalar value, "' . gettype($aItemOptions['label']) . '" given'); |
+ | } elseif (($oTranslator = $this->getTranslator())) { |
+ | $aItemOptions['label'] = $oTranslator->translate($aItemOptions['label'], $this->getTranslatorTextDomain()); |
+ | } |
+ | |
+ | $sItemContent = $this->getEscapeHtmlHelper()->__invoke($aItemOptions['label']); |
+ | break; |
+ | case self::TYPE_ITEM_DIVIDER: |
+ | |
+ | if (empty($aItemOptions['attributes']['class'])) { |
+ | $aItemOptions['attributes']['class'] = 'divider'; |
+ | } elseif (!preg_match('/(\s|^)divider(\s|$)/', $aItemOptions['attributes']['class'])) { |
+ | $aItemOptions['attributes']['class'] .= ' divider'; |
+ | } |
+ | |
+ | $sItemContent = ''; |
+ | break; |
+ | |
+ | case self::TYPE_ITEM_LINK: |
+ | if (empty($aItemOptions['label'])) { |
+ | throw new \LogicException('"' . $aItemOptions['type'] . '" item expects "label" option'); |
+ | } |
+ | if (!is_scalar($aItemOptions['label'])) { |
+ | throw new \LogicException('"label" option expect scalar value, "' . gettype($aItemOptions['label']) . '" given'); |
+ | } elseif (($oTranslator = $this->getTranslator())) { |
+ | $aItemOptions['label'] = $oTranslator->translate($aItemOptions['label'], $this->getTranslatorTextDomain()); |
+ | } |
+ | |
+ | |
+ | if (empty($aItemOptions['item_attributes']['role'])) { |
+ | $aItemOptions['item_attributes']['role'] = 'menuitem'; |
+ | } |
+ | |
+ | |
+ | if (!isset($aItemOptions['item_attributes']['tabindex'])) { |
+ | $aItemOptions['item_attributes']['tabindex'] = '-1'; |
+ | } |
+ | |
+ | |
+ | if (!isset($aItemOptions['item_attributes']['href'])) { |
+ | $aItemOptions['item_attributes']['href'] = '#'; |
+ | } |
+ | |
+ | $aValidTagAttributes = $this->validTagAttributes; |
+ | $this->validTagAttributes = array('href' => true); |
+ | $sAttributeString = $this->createAttributesString($aItemOptions['item_attributes']); |
+ | $this->validTagAttributes = $aValidTagAttributes; |
+ | |
+ | $sItemContent = sprintf(static::$dropdownItemFormats[self::TYPE_ITEM_LINK], $sAttributeString, $this->getEscapeHtmlHelper()->__invoke($aItemOptions['label'])); |
+ | break; |
+ | } |
+ | |
+ | return sprintf(static::$dropdownItemContainerFormat, $this->createAttributesString($aItemOptions['attributes']), $sItemContent); |
+ | } |
+ | } |
+
+
+