$filename
$filename : string
Output file name
Admin base exporter Can export data for a given object Uses a config similar to "lists" config.
In fact, it can actually use the "lists" config as it is if the export data is a ident.
__construct(array $data) : \Charcoal\Admin\Service\Exporter
| array | $data | Dependencies. |
If missing dependencies.
Chainable
process() : \Charcoal\Admin\Service\Exporter
Init function
Chainable.
setExportIdent(string $ident) : \Charcoal\Admin\Service\Exporter
The export config ident Public - Called from the exportAction when a given ident is provided
| string | $ident | Config ident. |
(chainable)
prepareOptions() : \Charcoal\Admin\Service\Exporter
Set all data from the metadata.
If no export ident is specified or found.
If no export data is found.
If no properties are defined.
Chainable.
setFilename(string $filename) : \Charcoal\Admin\Service\Exporter
| string | $filename | Output filename. |
(chainable).
setObjType(string $objType) : \Charcoal\Admin\Service\Exporter
| string | $objType | Object to be exported. |
(chainable).
setConvertBrToNewlines(boolean $bool) : \Charcoal\Admin\Service\Exporter
Convert br to newline?
| boolean | $bool | Convert br to newline. |
(chainable)
setStripTags(boolean $bool) : \Charcoal\Admin\Service\Exporter
Strip tags?
| boolean | $bool | Strip tags. |
(chainable)
setProperties(array $properties) : \Charcoal\Admin\Service\Exporter
Output properties
| array | $properties | Properties. |
Chainable.
setCollectionConfig(array $cfg) : \Charcoal\Admin\Service\Exporter
Collection config
| array | $cfg | Collection config. |
Chainable.
setModelFactory(\Charcoal\Factory\FactoryInterface $factory) : \Charcoal\Admin\Service\Exporter
Set the model factory
| \Charcoal\Factory\FactoryInterface | $factory | Model factory. |
(chainable)