ExportFormat
in package
Class ExportFormat
This class provides methods for managing export formats. It includes functionality for retrieving, creating, and updating export formats, as well as specific administrative operations.
Table of Contents
Properties
Methods
- __construct() : mixed
- createByAdmin() : void
- Create a new export format (admin).
- getAll() : array<int, array<string, mixed>>
- Get all export formats for given statuses.
- getByCode() : array<string, mixed>
- Get an export format by code.
- updateByCode() : void
- Update export format by code (admin).
Properties
$mySql
protected
MySql
$mySql
Methods
__construct()
public
__construct(MySql $mySql) : mixed
Parameters
- $mySql : MySql
createByAdmin()
Create a new export format (admin).
public
createByAdmin(array<string, mixed> $data) : void
Expects in $data:
- export_format_code (string, required)
- export_format_name (string, required)
- export_format_name_display (string|null)
- sort_order (int|null)
- status (int, required)
- createdby (string, required)
- modifiedby (string, required)
Parameters
- $data : array<string, mixed>
getAll()
Get all export formats for given statuses.
public
getAll(array<string|int, int> $statuses) : array<int, array<string, mixed>>
Parameters
- $statuses : array<string|int, int>
Return values
array<int, array<string, mixed>>getByCode()
Get an export format by code.
public
getByCode(string $code) : array<string, mixed>
Parameters
- $code : string
Return values
array<string, mixed>updateByCode()
Update export format by code (admin).
public
updateByCode(array<string, mixed> $data) : void
Expects in $data:
- export_format_code (string, required)
- export_format_name (string|null)
- export_format_name_display (string|null)
- sort_order (int|null)
- status (int|null)
- modifiedby (string, required)
Parameters
- $data : array<string, mixed>