ExportManager extends ExportManager
Class created by Core/Base/PluginManager
Table of Contents
| $engine | The selected engine/class to export. | ExportBase |
|---|---|---|
| $options | Option list. | array |
| $optionsModels | array | |
| $orientation | Default document orientation. | string |
| $selectedLang | string | |
| $selectedOption | string | |
| $selectedTitle | string | |
| $tools | Tools list. | array |
| __construct() | ExportManager constructor. | mixed |
| addBusinessDocPage() | Adds a new page with the document data. | bool |
| addListModelPage() | Adds a new page with a table listing the models data. | bool |
| addModelPage() | Adds a new page with the model data. | bool |
| addOption() | Adds a new option. | mixed |
| addOptionModel() | mixed | |
| addTool() | Adds a new tool. | mixed |
| addTablePage() | Adds a new page with the table data. | bool |
| defaultOption() | Returns default option. | string |
| getDoc() | Return generated doc. | mixed |
| getFormats() | array | |
| newDoc() | Create a new doc and set headers. | mixed |
| options() | returns options to export. | array |
| setOrientation() | Sets default orientation. | mixed |
| show() | Returns the formatted data. | mixed |
| tools() | array | |
| getExportClassName() | Returns the full class name. | string |
| init() | Initialize options array | mixed |
Properties
$engine
The selected engine/class to export.
protected
static ExportBase
$engine
$options
Option list.
protected
static array
$options
= []
$optionsModels
protected
static array
$optionsModels
= []
$orientation
Default document orientation.
protected
string
$orientation
$selectedLang
protected
static string
$selectedLang
$selectedOption
protected
static string
$selectedOption
$selectedTitle
protected
static string
$selectedTitle
$tools
Tools list.
protected
static array
$tools
= []
Methods
__construct()
ExportManager constructor.
public
__construct(
)
: mixed
Return values
mixedaddBusinessDocPage()
Adds a new page with the document data.
public
addBusinessDocPage(
$model :
mixed
)
: bool
Parameters
- $model : mixed
Return values
booladdListModelPage()
Adds a new page with a table listing the models data.
public
addListModelPage(
$model :
mixed
, $where :
array
, $order :
array
, $offset :
int
, $columns :
array
[, $title :
string
= '' ]
)
: bool
Parameters
- $model : mixed
- $where : array
- $order : array
- $offset : int
- $columns : array
- $title : string = ''
Return values
booladdModelPage()
Adds a new page with the model data.
public
addModelPage(
$model :
mixed
, $columns :
array
[, $title :
string
= '' ]
)
: bool
Parameters
- $model : mixed
- $columns : array
- $title : string = ''
Return values
booladdOption()
Adds a new option.
public
static addOption(
$key :
string
, $description :
string
, $icon :
string
)
: mixed
Parameters
- $key : string
- $description : string
- $icon : string
Return values
mixedaddOptionModel()
public
static addOptionModel(
$exportClassName :
string
, $optionKey :
string
, $modelName :
string
, $priority :
int
)
: mixed
Parameters
- $exportClassName : string
- $optionKey : string
- $modelName : string
- $priority : int
Return values
mixedaddTool()
Adds a new tool.
public
static addTool(
$key :
string
, $link :
string
, $description :
string
, $icon :
string
)
: mixed
Parameters
- $key : string
- $link : string
- $description : string
- $icon : string
Return values
mixedaddTablePage()
Adds a new page with the table data.
public
addTablePage(
$headers :
array
, $rows :
array
)
: bool
Parameters
- $headers : array
- $rows : array
Return values
booldefaultOption()
Returns default option.
public
static defaultOption(
)
: string
Return values
stringgetDoc()
Return generated doc.
public
getDoc(
)
: mixed
Return values
mixedgetFormats()
public
getFormats(
$model :
object
)
: array
Parameters
- $model : object
Return values
arraynewDoc()
Create a new doc and set headers.
public
newDoc(
$option :
string
[, $title :
string
= '' ]
, $format :
int
[, $lang :
string
= '' ]
)
: mixed
Parameters
- $option : string
- $title : string = ''
- $format : int
- $lang : string = ''
Return values
mixedoptions()
returns options to export.
public
static options(
)
: array
Return values
arraysetOrientation()
Sets default orientation.
public
setOrientation(
$orientation :
string
)
: mixed
Parameters
- $orientation : string
Return values
mixedshow()
Returns the formatted data.
public
show(
&$response :
Response
)
: mixed
Parameters
- $response : Response
Return values
mixedtools()
public
static tools(
)
: array
Return values
arraygetExportClassName()
Returns the full class name.
private
getExportClassName(
$option :
string
)
: string
Parameters
- $option : string
Return values
stringinit()
Initialize options array
protected
static init(
)
: mixed