1. class
  2. XELOS
  3. \
  4. Modules
  5. \
  6. Lists
  7. \
  8. Hook
  9. \
  10. Workflows
  11. \
  12. ListItemPayload

ListItemPayload

class ListItemPayload extends xelos_workflows_payload_base

Properties

ListsController $mod
protected string $model_name
protected bool $payload_type_reference
protected bool $payload_convertible_to_pdf

Methods

array
get_fdl()

Get FDL for states

string
get_file_url($path_to_file, bool $inline_disposition = true, bool $name = false, bool $zipOnTheFly = false, bool $width = false, bool $height = false, bool $resize_mode = false)

copied from xelos core, but prepended web_dir to path_to_file

mixed
get_payload_properties()

Get payload properties

bool|array
get_placeholders(bool $descriptive = false)

Get all placeholders with payload property values: It's required that the identifier of the form is the same as the payload identifier.

bool|int
set_payload_property(string $property, string|int $value)

Set payload property

Template|null
show_payload()

Show form

string
storage_path()

return _files storage path for payload

string
to_html(int $list_item_id, array $headerFields = [])

Get payload as HTML

void
validate()

No description

Details

at line 41
array get_fdl()

Get FDL for states

Return Value

array FDL

at line 145
string get_file_url($path_to_file, bool $inline_disposition = true, bool $name = false, bool $zipOnTheFly = false, bool $width = false, bool $height = false, bool $resize_mode = false)

copied from xelos core, but prepended web_dir to path_to_file

Parameters

$path_to_file
bool $inline_disposition
bool $name
bool $zipOnTheFly
bool $width
bool $height
bool $resize_mode

Return Value

string

at line 519
mixed get_payload_properties()

Get payload properties

Return Value

mixed

at line 349
bool|array get_placeholders(bool $descriptive = false)

Get all placeholders with payload property values: It's required that the identifier of the form is the same as the payload identifier.

Parameters

bool $descriptive

Show explanations and examples

Return Value

bool|array

Exceptions

Exception

at line 545
bool|int set_payload_property(string $property, string|int $value)

Set payload property

Parameters

string $property
string|int $value

Return Value

bool|int

Exceptions

Exception

at line 220
Template|null show_payload()

Show form

Return Value

Template|null

Exceptions

ContentException
Exception

at line 123
string storage_path()

return _files storage path for payload

Return Value

string $full_path

at line 78
string to_html(int $list_item_id, array $headerFields = [])

Get payload as HTML

Parameters

int $list_item_id
array $headerFields

Return Value

string

Exceptions

ContentException

at line 600
void validate()

No description

Return Value

void

Exceptions

PayloadException