class YAMLExporter in Loft Data Grids 6.2

Class YAMLExporter

http://symfony.com/doc/current/components/yaml/introduction.html

Hierarchy

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

File

vendor/aklump/loft_data_grids/src/AKlump/LoftDataGrids/YAMLExporter.php, line 10

Namespace

AKlump\LoftDataGrids

class YAMLExporter extends Exporter implements ExporterInterface {
  protected $extension = '.yml';
  public function __construct(ExportDataInterface $data = NULL, $filename = '') {
    parent::__construct($data, $filename);
  }
  public function getInfo() {
    $info = parent::getInfo();
    $info = array(
      'name' => 'YAML Format',
      'shortname' => 'YAML',
      'description' => 'Export data in YAML file format. For more information visit: http://www.yaml.org.',
    ) + $info;
    return $info;
  }
  public function compile($page_id = NULL) {
    $pages = $this
      ->getData()
      ->get();
    if (isset($page_id) && array_key_exists($page_id, $pages)) {
      $pages = $pages[$page_id];
    }
    $this->output = Yaml::dump($pages);
  }

}

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::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::getFilename	public	function	Get the filename Overrides ExporterInterface::getFilename
Exporter::getHeader	public	function	Return an array containing the header row values for 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	Save as a file to the server Overrides ExporterInterface::save	1
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.	1
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
YAMLExporter::$extension	protected	property
YAMLExporter::compile	public	function	Build $this->output in prep for export/save Overrides Exporter::compile
YAMLExporter::getInfo	public	function	Return info about this class Overrides Exporter::getInfo
YAMLExporter::__construct	public	function	Constructor Overrides Exporter::__construct