class ViewsEFFieldsetData in Views Exposed Form Fieldset 8

Class ViewsEFFieldsetData.

Hierarchy

• class \Drupal\views_ef_fieldset\ViewsEFFieldsetData

2 files declare their use of ViewsEFFieldsetData

ViewsEFFieldset.php in src/Plugin/views/display_extender/ViewsEFFieldset.php

views_ef_fieldset.module in ./views_ef_fieldset.module

File

src/ViewsEFFieldsetData.php, line 12

Namespace

Drupal\views_ef_fieldset

class ViewsEFFieldsetData {

  /**
   * The data.
   *
   * @var array
   */
  private $data;

  /**
   * The element.
   *
   * @var array
   */
  private $elements;

  /**
   * The form.
   *
   * @var array
   */
  private $form;

  /**
   * ViewsEFFieldsetData constructor.
   *
   * @param array $data
   *   The data.
   * @param array $form
   *   The form.
   */
  public function __construct(array $data, array &$form = []) {
    $this->data = $data;
    $this->elements = $data;
    $this->form =& $form;
  }

  /**
   * Build a flat array.
   *
   * @return array
   *   The flatten array.
   */
  public function buildFlat() {
    $data = [];
    $recursive_iter_iter = new RecursiveIteratorIterator(new ArrayDataItemIterator($this
      ->buildTreeData()), RecursiveIteratorIterator::SELF_FIRST);
    foreach ($recursive_iter_iter as $item) {
      $item['item']['depth'] = $recursive_iter_iter
        ->getDepth();
      $data[] = $item;
    }
    return $data;
  }

  /**
   * Built the tree data.
   *
   * @return array
   *   The tree data.
   */
  public function buildTreeData() {
    return $this
      ->parseTree($this->elements);
  }

  /**
   * Convert the tree data into form api data.
   *
   * @return array
   *   The array of elements.
   */
  public function treetofapi() {
    $elements = [];
    $this
      ->recursivetreetofapi($this
      ->buildTreeData(), $this->form, $elements);
    return $elements;
  }

  /**
   * Parse the tree.
   *
   * @param array $elements
   *   The elements.
   * @param string $rootParentID
   *   The root parent ID.
   * @param int $depth
   *   The depth.
   *
   * @return array
   *   The array.
   */
  private function parseTree(array &$elements, $rootParentID = '', $depth = -1) {
    $branch = [];
    $depth++;
    foreach ($elements as $key => $element) {
      $element['depth'] = $depth;
      if ($element['pid'] !== $rootParentID) {
        continue;
      }
      $branch[] = [
        'item' => $element,
        'children' => $this
          ->parseTree($elements, $element['id'], $depth),
      ];
    }

    // Automatically get sorted results.
    usort($branch, [
      $this,
      'sortByWeight',
    ]);
    return empty($branch) ? [] : $branch;
  }

  /**
   * Tree to FAPI recursive.
   *
   * @param array $data
   *   The data.
   * @param array $form
   *   The form.
   * @param array $element
   *   The element.
   */
  private function recursivetreetofapi(array $data, array &$form, array &$element = []) {
    foreach ($data as $key => $item) {

      // If it's a filter field.
      if ($item['item']['type'] === 'filter') {
        $form_info = isset($form['#info']['filter-' . $item['item']['id']]) ? $form['#info']['filter-' . $item['item']['id']] : NULL;
        $field_name = $form_info['value'] ?: $item['item']['id'];
        if (isset($form[$field_name]) && is_array($form[$field_name])) {
          $element[$field_name] = $form[$field_name] + [
            '#weight' => $item['item']['weight'],
            '#title' => $form_info['label'] ?: '',
            '#description' => $form_info['description'] ?: '',
          ];
          unset($form['#info']['filter-' . $item['item']['id']]);
          unset($form[$field_name]);
        }
      }

      // If it's a sort field.
      if ($item['item']['type'] === 'sort') {
        $field_name = $item['item']['id'];
        if (isset($form[$field_name]) && is_array($form[$field_name])) {
          $element[$field_name] = $form[$field_name];
          $element[$field_name]['#weight'] = $item['item']['weight'];
          unset($form[$field_name]);
        }
      }

      // If it's the action buttons.
      if ($item['item']['type'] === 'buttons') {
        $field_name = $item['item']['id'];
        if (isset($form['actions'][$field_name]) && is_array($form['actions'][$field_name])) {
          $button = $form['actions'][$field_name];
          $button['#weight'] = $item['item']['weight'];
          $button['#access'] = TRUE;
          $element[$field_name] = $button;
          $form['actions'][$field_name]['#attributes']['style'][] = 'display:none;';

          // unset($form['actions'][$field_name]);.
        }
      }
      if (!empty($item['children']) && $item['item']['type'] === 'container') {
        $element['container-' . $item['item']['id']] = [
          '#type' => $item['item']['container_type'],
          '#title' => t('@title', [
            '@title' => $item['item']['title'],
          ]),
          '#group' => 'container-' . $item['item']['pid'],
          '#description' => t('@description', [
            '@description' => $item['item']['description'],
          ]),
          '#open' => (bool) $item['item']['open'],
          '#attributes' => [
            'class' => [
              'views-ef-fieldset-container',
              'views-ef-fieldset-' . $item['item']['id'],
            ],
          ],
          '#weight' => $item['item']['weight'],
        ];
        $element['container-' . $item['item']['id']]['children'] = [];
        $this
          ->recursivetreetofapi($item['children'], $form, $element['container-' . $item['item']['id']]['children']);
      }
    }
  }

  /**
   * Internal function used to sort array items by weight.
   *
   * @param array $a
   *   First element.
   * @param array $b
   *   Second element.
   *
   * @return int
   *   The weight.
   */
  private function sortByWeight(array $a, array $b) {
    if ($a['item']['weight'] === $b['item']['weight']) {
      return 0;
    }
    return $a['item']['weight'] < $b['item']['weight'] ? -1 : 1;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ViewsEFFieldsetData::$data	private	property	The data.
ViewsEFFieldsetData::$elements	private	property	The element.
ViewsEFFieldsetData::$form	private	property	The form.
ViewsEFFieldsetData::buildFlat	public	function	Build a flat array.
ViewsEFFieldsetData::buildTreeData	public	function	Built the tree data.
ViewsEFFieldsetData::parseTree	private	function	Parse the tree.
ViewsEFFieldsetData::recursivetreetofapi	private	function	Tree to FAPI recursive.
ViewsEFFieldsetData::sortByWeight	private	function	Internal function used to sort array items by weight.
ViewsEFFieldsetData::treetofapi	public	function	Convert the tree data into form api data.
ViewsEFFieldsetData::__construct	public	function	ViewsEFFieldsetData constructor.