ZipDocument extends Body
AbstractYes
Table of Contents
Constants
- ARRAY_INDEX_MODIFIER = 'index'
- BLOCK_END_PLACEHOLDER = 'BLOCK_END'
- BLOCK_START_PLACEHOLDER = 'BLOCK_START'
Methods
- __construct() : mixed
- Body constructor.
- __destruct() : mixed
- detectHtml() : bool
- getCodeFromPlaceholder() : string
- getContent() : string
- getFieldNames() : array<string|int, mixed>
- getFields() : array<string|int, mixed>
- getFileExtension() : string
- getFileMimeType() : string
- getPlaceholders() : array<string|int, mixed>
- getStorage() : Storage
- isFileProcessable() : bool
- normalizeContent() : mixed
- Normalizes content of the body.
- process() : Result
- Parse $content, process commands, fill values.
- readFromStorage() : static|false
- save() : AddResult
- setExcludedPlaceholders() : mixed
- Set placeholders list that will not be filled with values.
- setFields() : $this
- setStorage() : $this
- setValues() : $this
Constants
ARRAY_INDEX_MODIFIER
public
mixed
ARRAY_INDEX_MODIFIER
= 'index'
BLOCK_END_PLACEHOLDER
public
mixed
BLOCK_END_PLACEHOLDER
= 'BLOCK_END'
BLOCK_START_PLACEHOLDER
public
mixed
BLOCK_START_PLACEHOLDER
= 'BLOCK_START'
Methods
__construct()
Body constructor.
public
__construct(mixed $content) : mixed
Parameters
- $content : mixed
__destruct()
public
__destruct() : mixed
detectHtml()
public
static detectHtml(string $string) : bool
Parameters
- $string : string
Return values
boolgetCodeFromPlaceholder()
public
static getCodeFromPlaceholder(string $code) : string
Parameters
- $code : string
Return values
stringgetContent()
public
getContent() : string
Return values
stringgetFieldNames()
public
getFieldNames() : array<string|int, mixed>
Return values
array<string|int, mixed>getFields()
public
getFields() : array<string|int, mixed>
Return values
array<string|int, mixed>getFileExtension()
public
abstract getFileExtension() : string
Return values
stringgetFileMimeType()
public
abstract getFileMimeType() : string
Return values
stringgetPlaceholders()
public
abstract getPlaceholders() : array<string|int, mixed>
Return values
array<string|int, mixed>getStorage()
public
getStorage() : Storage
Return values
StorageisFileProcessable()
public
isFileProcessable() : bool
Return values
boolnormalizeContent()
Normalizes content of the body.
public
normalizeContent() : mixed
process()
Parse $content, process commands, fill values.
public
abstract process() : Result
Returns true on success, false on failure.
Return values
ResultreadFromStorage()
public
static readFromStorage(Storage $storage, mixed $from) : static|false
Parameters
- $storage : Storage
- $from : mixed
Return values
static|falsesave()
public
save(array<string|int, mixed> $options[, Storage|null $storage = null ]) : AddResult
Parameters
- $options : array<string|int, mixed>
- $storage : Storage|null = null
Return values
AddResultsetExcludedPlaceholders()
Set placeholders list that will not be filled with values.
public
setExcludedPlaceholders(array<string|int, mixed> $placeholders) : mixed
Parameters
- $placeholders : array<string|int, mixed>
setFields()
public
setFields(array<string|int, mixed> $fields) : $this
Parameters
- $fields : array<string|int, mixed>
Return values
$thissetStorage()
public
setStorage(Storage $storage) : $this
Parameters
- $storage : Storage
Return values
$thissetValues()
public
setValues(array<string|int, mixed> $values) : $this
Parameters
- $values : array<string|int, mixed>