class ExportData in Loft Data Grids 7.2

Same name and namespace in other branches

6.2 vendor/aklump/loft_data_grids/src/AKlump/LoftDataGrids/ExportData.php \AKlump\LoftDataGrids\ExportData

Hierarchy

class \AKlump\LoftDataGrids\ExportData implements ExportDataInterface

Expanded class hierarchy of ExportData

File

vendor/aklump/loft_data_grids/src/AKlump/LoftDataGrids/ExportData.php, line 8

Namespace

AKlump\LoftDataGrids

View source

class ExportData implements ExportDataInterface {
  protected $data = array();
  protected $keys = array();
  protected $current_pointers = array();
  protected $current_page = 0;
  protected $locations = array();
  protected $hiddenKeys = array();

  /**
   * Constructor
   *
   * @param mixed $page_id
   *   (Optional) Defaults to 0.
   */
  public function __construct($page_id = 0) {
    $this
      ->setPage($page_id);
  }
  public function getLocations() {
    $data = $this->locations;
    $default = (array) array_fill_keys($this
      ->getAllPageIds(), 0) + array(
      0,
    );
    foreach (array_keys($data) as $location_id) {
      $a =& $data[$location_id];
      if (!isset($a['page'])) {
        $a['page'] = 0;
      }
      if (!isset($a['pointers'])) {
        $a['pointers'] = array();
      }
      $a['pointers'] += $default;
    }
    return $data;
  }
  public function setLocations($locations) {
    foreach ($locations as $location_id => $data) {
      $data = array_intersect_key($data, array_flip(array(
        'page',
        'pointers',
      )));
      $this->locations[$location_id] = $data;
    }
  }
  public function storeLocation($location_id) {
    $this->locations[$location_id] = array(
      'page' => (int) $this->current_page,
      'pointers' => $this->current_pointers,
    );
    return $this;
  }
  public function gotoLocation($location_id) {
    if (isset($this->locations[$location_id])) {
      $this->current_page = $page = $this->locations[$location_id]['page'];
      $this->current_pointers = $this->locations[$location_id]['pointers'];
    }
    return $this;
  }
  public function getKeys($page_id = null) {
    if ($page_id === null) {
      $page_id = $this->current_page;
    }
    $keys = array();
    $rows = isset($this->data[$page_id]) ? $this->data[$page_id] : array();
    foreach ($rows as $row) {
      $keys += $row;
    }
    $keys = array_keys($keys);
    $this
      ->setKeys($keys);
    return $keys;
  }
  public function setKeys($key) {
    if (is_array($key)) {
      $this->keys[$this->current_page] = $key;
    }
    else {
      $this->keys[$this->current_page] = func_get_args();
    }

    // If we have data then we need to go through and modify the order
    if (!empty($this->data[$this->current_page])) {
      foreach ($this->data[$this->current_page] as $row => $data) {
        $new_row = array();
        foreach ($this->keys[$this->current_page] as $key) {
          if (array_key_exists($key, $data)) {
            $new_row[$key] = $data[$key];
          }
        }
        $new_row += $data;
        $this->data[$this->current_page][$row] = $new_row;
      }
    }
    return $this;
  }
  public function hideKeys() {
    $keys = func_get_args();

    // Boolean values sets all keys.
    if (count($keys) === 1 && is_bool($keys[0])) {

      // This is important, as it resets our property.
      if ($keys[0] === false) {
        $this->hiddenKeys[$this->current_page] = array();
      }
      $keys = $keys[0] ? $this
        ->getKeys() : array();
    }
    if (!isset($this->hiddenKeys[$this->current_page])) {
      $this->hiddenKeys[$this->current_page] = array();
    }
    if ($keys) {
      $this->hiddenKeys[$this->current_page] += array_combine($keys, $keys);
    }
    return $this;
  }
  public function showKeys() {
    $keys = func_get_args();

    // Boolean values sets all keys.
    if (count($keys) === 1 && is_bool($keys[0])) {

      // This is important, as it resets our property.
      if ($keys[0] === true) {
        $this->hiddenKeys[$this->current_page] = array();
      }
      $keys = $keys[0] ? array() : $this
        ->getKeys();
    }
    if (!isset($this->hiddenKeys[$this->current_page])) {
      $this->hiddenKeys[$this->current_page] = array();
    }
    if ($keys) {
      $this->hiddenKeys[$this->current_page] = array_diff($this->hiddenKeys[$this->current_page], $keys);
    }
    return $this;
  }

  /**
   * Return the current record pointer for the current page
   */
  public function getPointer() {
    if (!isset($this->current_pointers[$this->current_page])) {
      $this->current_pointers[$this->current_page] = 0;
    }
    return $this->current_pointers[$this->current_page];
  }
  public function add($key, $value) {
    $page = $this->current_page;
    if (empty($this->current_pointers[$page])) {
      $this->current_pointers[$page] = 0;
    }
    $row = $this->current_pointers[$page];
    if (!array_key_exists($page, $this->keys)) {
      $this->keys[$page] = array();
    }
    if (empty($this->data[$page][$row])) {
      $this->data[$page][$row] = array_fill_keys($this->keys[$page], null);
    }
    $this->data[$page][$row][$key] = $value;
    return $this;
  }
  public function next() {
    $return = $this
      ->getPointer();
    $this->current_pointers[$this->current_page] = $return + 1;
    return $return;
  }
  public function setPointer($index = null) {
    if ($index === null) {
      $index = count($this->data[$this->current_page]);
    }
    $this->current_pointers[$this->current_page] = $index;
    return $this;
  }
  public function setPage($page_id) {
    $this->current_page = $page_id;
    return $this;
  }
  public function getCurrentPageId() {
    return $this->current_page;
  }
  public function getAllPageIds() {
    $ids = array_keys($this
      ->get());
    if (!in_array($this->current_page, $ids)) {
      $ids[] = $this->current_page;
    }
    return (array) $ids;
  }
  public function setPageOrder($page_id) {
    $page_ids = func_get_args();
    $temp = array();
    foreach ($page_ids as $page_id) {
      $temp[$page_id] = isset($this->data[$page_id]) ? $this->data[$page_id] : array();
    }
    $temp += $this->data;
    $this->data = $temp;
    return $this;
  }
  public function get() {
    $return = $this->data;
    if ($this->hiddenKeys !== array()) {
      foreach ($return as $page_id => $page) {

        // Jump to next page if there are none hidden here.
        if (isset($this->hiddenKeys[$page_id]) && $this->hiddenKeys[$page_id] === array()) {
          continue;
        }
        foreach ($page as $pointer => $record) {
          foreach ($record as $key => $value) {
            if (isset($this->hiddenKeys[$page_id]) && in_array($key, $this->hiddenKeys[$page_id])) {
              unset($return[$page_id][$pointer][$key]);
            }
          }
        }
      }
    }
    return $return;
  }
  public function getValue($key) {
    return $this
      ->getCurrent($key);
  }
  public function getRows() {
    return $this
      ->getPage($this
      ->getCurrentPageId());
  }
  public function getCount() {
    return count($this
      ->getPage($this
      ->getCurrentPageId()));
  }
  public function getCurrent($key = null) {
    $current_pointer = $this
      ->getPointer();
    $data = $this
      ->get();
    $data = isset($data[$this->current_page][$current_pointer]) ? $data[$this->current_page][$current_pointer] : array();
    if ($key === null) {
      return $data;
    }
    return array_key_exists($key, $data) ? $data[$key] : null;
  }
  public function deletePage($page_id) {
    unset($this->data[$page_id]);
    unset($this->keys[$page_id]);
    unset($this->current_pointers[$page_id]);

    // Reset the current page if it was the deleted page.
    if ($this->current_page == $page_id) {
      $ids = $this
        ->getAllPageIds();
      $this->current_page = reset($ids);
    }

    // Remove locations pointing to it
    foreach ($this->locations as $location_id => $stored) {
      if ($stored['page'] == $page_id) {
        unset($this->locations[$location_id]);
      }
      unset($this->locations[$location_id]['pointers'][$page_id]);
    }
    return $this;
  }
  public function getPage($page_id = null) {
    if (!isset($page_id)) {
      $page_id = $this->current_page;
    }
    $data = $this
      ->get();
    return isset($data[$page_id]) ? $data[$page_id] : array();
  }
  public function getPageData($page_id = null) {
    if (!isset($page_id)) {
      $page_id = $this->current_page;
    }
    $clone = clone $this;
    foreach ($clone
      ->getAllPageIds() as $id) {
      if ($id != $page_id) {
        $clone
          ->deletePage($id);
      }
    }
    return $clone;
  }
  public function normalize($empty_value) {
    foreach (array_keys($this->data) as $page_id) {
      $columns = $this
        ->getKeys($page_id);

      // Now go through and add all columns
      $column_order = array();
      foreach ($this->data[$page_id] as $key => $row) {
        if (is_array($empty_value)) {
          if (array_key_exists($key, $empty_value)) {
            $empty = $empty_value[$key];
          }
          elseif (array_key_exists('default', $empty_value)) {
            $empty = $empty_value['default'];
          }
          else {
            $empty = null;
          }
        }
        else {
          $empty = $empty_value;
        }
        $this->data[$page_id][$key] += array_fill_keys($columns, $empty);

        // Assure the same column order for all rows
        if (empty($column_order)) {
          $column_order = array_keys($this->data[$page_id][$key]);
        }
        $ordered = array();
        foreach ($column_order as $col_key) {
          $ordered[$col_key] = $this->data[$page_id][$key][$col_key];
        }
        $this->data[$page_id][$key] = $ordered;
      }
    }
    return $this;
  }

  //@todo write a test for merge
  public function merge(ExportDataInterface $data, $empty_value) {

    // Normalize columns on incoming
    $this
      ->normalize($empty_value);
    $data
      ->normalize($empty_value);
    foreach (array_keys($this->data) as $page_id) {
      foreach ($this->data[$page_id] as $key => $row) {
        $this->data[$page_id][$key] += $row;
      }
    }

    // Normalize result
    $this
      ->normalize($empty_value);
    return $this;
  }
  public function find($needle, $key = null, $results = 1, $direction = 0) {
    $result_set = array();
    $haystack = $this
      ->getPage($this->current_page);
    if ($direction == 1) {
      $haystack = array_reverse($haystack, true);
    }
    foreach ($haystack as $pointer => $row) {
      $set = $row;
      if ($key !== null) {
        $set = array(
          $key => $row[$key],
        );
      }
      if ($found = array_intersect($set, array(
        $needle,
      ))) {
        $result_set[$pointer] = $found;
      }
      if ($results && count($result_set) === $results) {
        break;
      }
    }
    return $result_set;
  }

  /**
   * Returns a hash of the data contents.
   *
   * @return string
   */
  public function __toString() {
    $out = new JSONExporter($this);
    return sha1($out
      ->export());
  }

}

Members

Name	Modifiers	Type	Description
ExportData::$current_page	protected	property
ExportData::$current_pointers	protected	property
ExportData::$data	protected	property
ExportData::$hiddenKeys	protected	property
ExportData::$keys	protected	property
ExportData::$locations	protected	property
ExportData::add	public	function	Add (or Set) data to the current record Overrides ExportDataInterface::add
ExportData::deletePage	public	function	Delete a single page from the object Overrides ExportDataInterface::deletePage
ExportData::find	public	function	Find a value in the dataset of the current page Overrides ExportDataInterface::find
ExportData::get	public	function	Get the data Overrides ExportDataInterface::get
ExportData::getAllPageIds	public	function	Return an array of all page ids Overrides ExportDataInterface::getAllPageIds
ExportData::getCount	public	function	Returns the row count of the current page. Overrides ExportDataInterface::getCount
ExportData::getCurrent	public	function	Return the current record or data by key Overrides ExportDataInterface::getCurrent
ExportData::getCurrentPageId	public	function	Get the current page id Overrides ExportDataInterface::getCurrentPageId
ExportData::getKeys	public	function	Return an array of all keys for current of specified page Overrides ExportDataInterface::getKeys
ExportData::getLocations	public	function	Return an array of location data keyed by location_id Overrides ExportDataInterface::getLocations
ExportData::getPage	public	function	Return a single page of data Overrides ExportDataInterface::getPage
ExportData::getPageData	public	function	Return a single page as an ExportData object Overrides ExportDataInterface::getPageData
ExportData::getPointer	public	function	Return the current record pointer for the current page Overrides ExportDataInterface::getPointer
ExportData::getRows	public	function	Returns all rows of the current page keyed by pointer. Overrides ExportDataInterface::getRows
ExportData::getValue	public	function	Return the value of a single column, single row by key. Overrides ExportDataInterface::getValue
ExportData::gotoLocation	public	function	Goto to a stored location Overrides ExportDataInterface::gotoLocation
ExportData::hideKeys	public	function	Disables one or more keys on the current page from get(). Overrides ExportDataInterface::hideKeys
ExportData::merge	public	function	Merge another ExportData object into this one Overrides ExportDataInterface::merge
ExportData::next	public	function	Returns the record index and advances the record pointer Overrides ExportDataInterface::next
ExportData::normalize	public	function	Normalize all rows so that they all contain the same number of columns, the column order will be taken from the order of the first row. Overrides ExportDataInterface::normalize
ExportData::setKeys	public	function	Set the data key order for the current page Overrides ExportDataInterface::setKeys
ExportData::setLocations	public	function	Set locations using a formatted array. Overrides ExportDataInterface::setLocations
ExportData::setPage	public	function	Set the current page Overrides ExportDataInterface::setPage
ExportData::setPageOrder	public	function	Set the order the pages appear in the data array Overrides ExportDataInterface::setPageOrder
ExportData::setPointer	public	function	Advance the record pointer to a given index or all the way to the end Overrides ExportDataInterface::setPointer
ExportData::showKeys	public	function	Inverse of hideKeys. Overrides ExportDataInterface::showKeys
ExportData::storeLocation	public	function	Store the current page and pointer location for later resuming Overrides ExportDataInterface::storeLocation
ExportData::__construct	public	function	Constructor
ExportData::__toString	public	function	Returns a hash of the data contents.

You are here

class ExportData in Loft Data Grids 7.2

Hierarchy

File

Namespace

Members

API Navigation