class crumbs_UI_TableSection in Crumbs, the Breadcrumbs suite 7.2

Hierarchy

• class \crumbs_UI_TableSection

File

lib/UI/TableSection.php, line 4

class crumbs_UI_TableSection {

  /**
   * @var crumbs_UI_TableColumns
   */
  private $columns;

  /**
   * @var true[]
   */
  private $rows = array();

  /**
   * @var string[][]
   */
  private $rowAttributes;

  /**
   * @var array[][]
   *   Format: $[$rowName][$colName] = array($html, 'td', $attributes)
   */
  private $cells = array();

  /**
   * @param crumbs_UI_TableColumns $columns
   */
  function __construct(crumbs_UI_TableColumns $columns) {
    $this->columns = $columns;
  }

  /**
   * @param string $rowName
   *
   * @return $this
   * @throws Exception
   */
  function addRowName($rowName) {
    if (isset($this->rows[$rowName])) {
      throw new \Exception("Row '{$rowName}' already exists.");
    }
    $this->rows[$rowName] = TRUE;
    return $this;
  }

  /**
   * @param string $rowName
   * @param string $class
   *
   * @return $this
   */
  public function addRowClass($rowName, $class) {
    $this->rowAttributes[$rowName]['class'][] = $class;
    return $this;
  }

  /**
   * @param string $rowName
   * @param string $colName
   * @param string $content
   *
   * @return $this
   * @throws Exception
   */
  function td($rowName, $colName, $content) {
    if (!isset($this->rows[$rowName]) && '' !== $rowName) {
      throw new \Exception("Unknown row name '{$rowName}'.");
    }
    $this->columns
      ->verifyColName($colName);
    $this->cells[$rowName][$colName] = array(
      $content,
      'td',
      array(),
    );
    return $this;
  }

  /**
   * @param string $rowName
   * @param string $colName
   * @param string $content
   *
   * @return $this
   */
  function th($rowName, $colName, $content) {
    $this->cells[$rowName][$colName] = array(
      $content,
      'th',
      array(),
    );
    return $this;
  }

  /**
   * Renders the table section as a tbody, thead or tfoot.
   *
   * @param string $sectionTagName
   *   Either 'thead' or 'tbody' or 'tfoot'.
   *
   * @return string
   *   Rendered table html.
   */
  function render($sectionTagName) {
    $html = '';
    foreach ($this
      ->getMatrix() as $rowName => $rowCells) {
      $rowHtml = '';
      foreach ($rowCells as $colName => $cell) {
        list($cellHtml, $tagName, $attributes) = $cell;
        $attributes = !empty($attributes) ? drupal_attributes($attributes) : '';
        $rowHtml .= '<' . $tagName . $attributes . '>' . $cellHtml . '</' . $tagName . '>';
      }
      $rowAttributes = isset($this->rowAttributes[$rowName]) ? drupal_attributes($this->rowAttributes[$rowName]) : '';
      $html .= '<tr' . $rowAttributes . '>' . $rowHtml . '</tr>';
    }
    if ('' === $html) {
      return '';
    }
    return '<' . $sectionTagName . '>' . $html . '</' . $sectionTagName . '>';
  }

  /**
   * Returns rows that can be used in Drupal 7's theme('table').
   *
   * @return array[]
   *   Format:
   *   $[]['data'][]['data'] = $cellHtml
   *   $[]['data'][]['header'] = true|false
   *   $[]['data'][][$cellAttributeName] = $cellAttributeValue
   *   $[][$rowAttributeName] = $rowAttributeValue
   */
  public function getDrupalRows() {
    $drupalRows = array();
    foreach ($this
      ->getMatrix() as $rowName => $rowCells) {
      $drupalCells = array();
      foreach ($rowCells as $colName => $cell) {
        list($cellHtml, $tagName, $attributes) = $cell;
        $drupalCell = array();
        $drupalCell['data'] = $cellHtml;
        if ('th' === $tagName) {
          $drupalCell['header'] = TRUE;
        }
        if (!empty($attributes)) {
          $drupalCell += $attributes;
        }
        $drupalCells[] = $drupalCell;
      }
      $drupalRow = array();
      $drupalRow['data'] = $drupalCells;
      if (!empty($this->rowAttributes[$rowName])) {
        $drupalRow += $this->rowAttributes[$rowName];
      }
      $drupalRows[] = $drupalRow;
    }
    return $drupalRows;
  }

  /**
   * @return array[][]
   */
  private function getMatrix() {
    $matrix = array();
    $cols = $this->columns
      ->getCols();
    $colNames = array_keys($cols);

    // Fill all 1x1 cells.
    foreach ($this->rows as $rowName => $rTrue) {
      foreach ($cols as $colName => $cTrue) {
        $matrix[$rowName][$colName] = isset($this->cells[$rowName][$colName]) ? $this->cells[$rowName][$colName] : array(
          '',
          'td',
          array(),
        );
      }
    }
    $colGroups = $this->columns
      ->getColGroups();

    // Fill horizontal cell groups (colspan).
    foreach ($this->cells as $rowName => $rowCellGroups) {
      if (!isset($this->rows[$rowName])) {
        continue;
      }
      foreach ($rowCellGroups as $colGroupName => $cell) {
        if (!isset($colGroups[$colGroupName])) {
          continue;
        }
        $colNameSuffixes = $colGroups[$colGroupName];
        $cell[2]['colspan'] = count($colNameSuffixes);
        $matrix[$rowName][$colGroupName . '.' . $colNameSuffixes[0]] = $cell;
        for ($i = 1; $i < count($colNameSuffixes); ++$i) {
          unset($matrix[$rowName][$colGroupName . '.' . $colNameSuffixes[$i]]);
        }
      }
    }

    // Fill full-width cells (colspan).
    foreach ($this->cells as $rowName => $rowCellGroups) {
      if (!isset($this->rows[$rowName])) {
        continue;
      }
      if (!isset($rowCellGroups[''])) {
        continue;
      }
      $cell = $rowCellGroups[''];
      $cell[2]['colspan'] = count($cols);
      $matrix[$rowName][$colNames[0]] = $cell;
      for ($i = 1; $i < count($cols); ++$i) {
        unset($matrix[$rowName][$colNames[$i]]);
      }
    }

    // Fill full-height cells (rowspan).
    if (isset($this->cells[''])) {
      $rowNames = array_keys($this->rows);
      foreach ($this->cells[''] as $colName => $cell) {
        if (!isset($cols[$colName])) {
          continue;
        }
        $cell[2]['rowspan'] = count($rowNames);
        $matrix[$rowNames[0]][$colName] = $cell;
        for ($i = 1; $i < count($rowNames); ++$i) {
          unset($matrix[$rowNames[$i]][$colName]);
        }
      }
    }

    // Vertical cell groups are not implemented yet.
    return $matrix;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
crumbs_UI_TableSection::$cells	private	property	Format: $[$rowName][$colName] = array($html, 'td', $attributes)
crumbs_UI_TableSection::$columns	private	property
crumbs_UI_TableSection::$rowAttributes	private	property
crumbs_UI_TableSection::$rows	private	property
crumbs_UI_TableSection::addRowClass	public	function
crumbs_UI_TableSection::addRowName		function
crumbs_UI_TableSection::getDrupalRows	public	function	Returns rows that can be used in Drupal 7's theme('table').
crumbs_UI_TableSection::getMatrix	private	function
crumbs_UI_TableSection::render		function	Renders the table section as a tbody, thead or tfoot.
crumbs_UI_TableSection::td		function
crumbs_UI_TableSection::th		function
crumbs_UI_TableSection::__construct		function