class ValuesOnlyExporter in Loft Data Grids 7.2

Represents a values only exporter with no record dividers.

Hierarchy

• class \AKlump\LoftDataGrids\Exporter implements ExporterInterface
  • class \AKlump\LoftDataGrids\ValuesOnlyExporter implements ExporterInterface

File

vendor/aklump/loft_data_grids/src/AKlump/LoftDataGrids/ValuesOnlyExporter.php, line 7

Namespace

AKlump\LoftDataGrids

class ValuesOnlyExporter extends Exporter implements ExporterInterface {
  public $extension = '.txt';
  public $format;
  public function __construct(ExportDataInterface $data = null, $filename = '') {
    parent::__construct($data, $filename);
    $this->format = new \stdClass();
    $this->format->eol = "\r\n";
    $this->format->sep = "\\";
  }
  public function getInfo() {
    $info = parent::getInfo();
    $info = array(
      'name' => 'Values-only List',
      'shortname' => 'Values List',
      'description' => 'Plaintext list of values',
    ) + $info;
    return $info;
  }
  public function compile($page_id = null) {
    if (isset($page_id)) {
      $pages = array(
        $page_id => $this
          ->getData()
          ->getPage($page_id),
      );
    }
    else {
      $pages = $this
        ->getData()
        ->get();
    }
    $values = array();
    foreach ($pages as $records) {
      foreach ($records as $record) {
        $line = array();
        foreach ($record as $value) {
          $line[] = $value;
        }
        $values[] = implode($this->format->sep, $line);
      }
    }
    $this->output = implode($this->format->eol, $values);
    return $this;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Exporter::$export_data	protected	property
Exporter::$header	protected	property
Exporter::$settings	protected	property
Exporter::addSetting	public	function	Adds/Updates a single setting by name. Overrides ExporterInterface::addSetting
Exporter::cssSafe	protected	function
Exporter::dataTransform	protected	function	Iterate over all cells and transform data as appropriate.
Exporter::export	public	function	Export data as a string Overrides ExporterInterface::export	1
Exporter::filenameSafe	protected	function	Return a string as a safe filename
Exporter::formatColumn	public	function	Format a single column with format by string Overrides ExporterInterface::formatColumn	1
Exporter::getData	public	function	Return the ExportDataInterface object Overrides ExporterInterface::getData
Exporter::getDataAsTransformedArray	protected	function	Convert ExportData to an array transforming every cell.
Exporter::getFilename	public	function	Get the filename Overrides ExporterInterface::getFilename
Exporter::getHeader	public	function	Return an array each of the keys present in the data on a page. Overrides ExporterInterface::getHeader
Exporter::getSettings	public	function	Return the settings object. Overrides ExporterInterface::getSettings
Exporter::getShowPageIds	public	function	Return the showPageIds. Overrides ExporterInterface::getShowPageIds
Exporter::getTitle	public	function	Overrides ExporterInterface::getTitle
Exporter::hidePageIds	public	function	Set the exporter to hide page ids. Overrides ExporterInterface::hidePageIds
Exporter::save	public	function	Stream as a file to the server with headers. Overrides ExporterInterface::save	1
Exporter::saveFile	public	function	Compile and and save to a filepath. Overrides ExporterInterface::saveFile	2
Exporter::setData	public	function	Set the export data object Overrides ExporterInterface::setData
Exporter::setFilename	public	function	Getter/Setter for the filename Overrides ExporterInterface::setFilename
Exporter::setSettings	public	function	Set the settings object. Overrides ExporterInterface::setSettings
Exporter::setSettingsDefault	protected	function	Setup default values on object data.	4
Exporter::setTitle	public	function	Set a title for the exported document Overrides ExporterInterface::setTitle	1
Exporter::showPageIds	public	function	Set the exporter to display page ids. Overrides ExporterInterface::showPageIds
ValuesOnlyExporter::$extension	public	property
ValuesOnlyExporter::$format	public	property
ValuesOnlyExporter::compile	public	function	Build the string content of $this->output and return $this for chaining. Overrides ExporterInterface::compile
ValuesOnlyExporter::getInfo	public	function	Return info about this class Overrides Exporter::getInfo
ValuesOnlyExporter::__construct	public	function	Constructor Overrides Exporter::__construct