annotate vendor/consolidation/output-formatters/src/StructuredData/TableDataInterface.php @ 0:4c8ae668cc8c

Initial import (non-working)
author Chris Cannam
date Wed, 29 Nov 2017 16:09:58 +0000
parents
children 5fb285c0d0e3
rev   line source
Chris@0 1 <?php
Chris@0 2 namespace Consolidation\OutputFormatters\StructuredData;
Chris@0 3
Chris@0 4 interface TableDataInterface
Chris@0 5 {
Chris@0 6 /**
Chris@0 7 * Return the original data for this table. Used by any
Chris@0 8 * formatter that is -not- a table.
Chris@0 9 */
Chris@0 10 public function getOriginalData();
Chris@0 11
Chris@0 12 /**
Chris@0 13 * Convert structured data into a form suitable for use
Chris@0 14 * by the table formatter.
Chris@0 15 *
Chris@0 16 * @param boolean $includeRowKey Add a field containing the
Chris@0 17 * key from each row.
Chris@0 18 *
Chris@0 19 * @return array
Chris@0 20 */
Chris@0 21 public function getTableData($includeRowKey = false);
Chris@0 22 }