Generator

Generator.php : 18 Copy path

Abstract

Output generator.

Constants¶

NULL_PARENT_ELEMENT_EXCEPTION_MESSAGE ¶

Generator.php : 20 Copy path

    
                        protected mixed NULL_PARENT_ELEMENT_EXCEPTION_MESSAGE = 'Parent element at %s cannot be `null`.'

Properties¶

$fieldTypeHashGenerator ¶

Generator.php : 49 Copy path

Generator for field type hash values.

protected AbstractFieldTypeHashGenerator $fieldTypeHashGenerator

$formatOutput ¶

Generator.php : 39 Copy path

If set to true, output will be formatted and indented.

protected bool $formatOutput = false

$isEmpty ¶

Generator.php : 25 Copy path

Keeps track if the document is still empty.

protected bool $isEmpty = true

$json ¶

Generator.php : 54 Copy path

Data structure which is build during visiting.

protected DataObjectInterface $json

$stack ¶

Generator.php : 34 Copy path

protected array<string|int, array{: string, : mixed, : array}> $stack = []

Methods¶

__construct() ¶

Generator.php : 56 Copy path

public __construct(string $vendor)

Parameters

Name	Type	Default value	Description
$vendor	string	-	-

attribute() ¶

Generator.php : 303 Copy path

Generate attribute with given $name and $value.

public attribute(string $name, mixed $value) : void

Parameters

Name	Type	Default value	Description
$name	string	-	-
$value	mixed	-	-

endAttribute() ¶

Generator.php : 325 Copy path

End attribute.

public endAttribute(string $name) : void

Parameters

Name	Type	Default value	Description
$name	string	-	-

endDocument() ¶

Generator.php : 117 Copy path

End document.

public abstract endDocument(mixed $data) : string

Parameters

Name	Type	Default value	Description
$data	mixed	-	-

Return values

string

endHashElement() ¶

Generator.php : 201 Copy path

End hash element.

public endHashElement(string $name) : void

Parameters

Name	Type	Default value	Description
$name	string	-	-

endList() ¶

Generator.php : 278 Copy path

End list.

public endList(string $name) : void

Parameters

Name	Type	Default value	Description
$name	string	-	-

endObjectElement() ¶

Generator.php : 145 Copy path

public endObjectElement(string|int $name) : void

Parameters

Name	Type	Default value	Description
$name	string\|int	-	-

endValueElement() ¶

Generator.php : 249 Copy path

End value element.

public endValueElement(string $name) : void

Parameters

Name	Type	Default value	Description
$name	string	-	-

generateFieldTypeHash() ¶

Generator.php : 359 Copy path

Generates a generic representation of the scalar, hash or list given in $hashValue into the document, using an element of $hashElementName as its parent.

    
                        public generateFieldTypeHash(string $hashElementName, mixed $hashValue) : void

Parameters

Name	Type	Default value	Description
$hashElementName	string	-	-
$hashValue	mixed	-	-

getEncoderContext() ¶

Generator.php : 439 Copy path

    
                        public abstract getEncoderContext(array<string|int, mixed> $data) : array<string|int, mixed>

Parameters

Name	Type	Default value	Description
$data	array<string\|int, mixed>	-	-

Return values

array<string|int, mixed>

getMediaType() ¶

Generator.php : 341 Copy path

Get media type.

public abstract getMediaType(string $name) : string

Parameters

Name	Type	Default value	Description
$name	string	-	-

Return values

string

isEmpty() ¶

Generator.php : 69 Copy path

Returns if the document is empty or already contains data.

public isEmpty() : bool

Return values

bool

reset() ¶

Generator.php : 82 Copy path

Reset output visitor to a virgin state.

public reset() : void

serializeBool() ¶

Generator.php : 430 Copy path

Serializes a boolean value.

public abstract serializeBool(bool|string|null $boolValue) : bool|string

Parameters

Name	Type	Default value	Description
$boolValue	bool\|string\|null	-	-

Return values

bool|string

setFormatOutput() ¶

Generator.php : 61 Copy path

public setFormatOutput(bool $formatOutput) : void

Parameters

Name	Type	Default value	Description
$formatOutput	bool	-	-

startAttribute() ¶

Generator.php : 312 Copy path

Start attribute.

public abstract startAttribute(string $name, mixed $value) : void

Parameters

Name	Type	Default value	Description
$name	string	-	-
$value	mixed	-	-

startDocument() ¶

Generator.php : 91 Copy path

Start document.

public startDocument(mixed $data) : void

Parameters

Name	Type	Default value	Description
$data	mixed	-	-

startHashElement() ¶

Generator.php : 179 Copy path

Start hash element.

public startHashElement(string $name) : void

Parameters

Name	Type	Default value	Description
$name	string	-	-

startList() ¶

Generator.php : 265 Copy path

Start list.

public abstract startList(string $name) : void

Parameters

Name	Type	Default value	Description
$name	string	-	-

startObjectElement() ¶

Generator.php : 130 Copy path

Start object element.

    
                        public startObjectElement(string|int $name[, string|null $mediaTypeName = null ]) : void

Parameters

Name	Type	Default value	Description
$name	string\|int	-	-
$mediaTypeName	string\|null	null	-

startValueElement() ¶

Generator.php : 236 Copy path

    
                        public abstract startValueElement(string $name, mixed $value[, array<string|int, mixed> $attributes = [] ]) : void

Parameters

Name	Type	Default value	Description
$name	string	-	-
$value	mixed	-	-
$attributes	array<string\|int, mixed>	[]	-

valueElement() ¶

Generator.php : 226 Copy path

Generate value element with given $name and $value.

public valueElement(string $name, mixed $value) : void

Parameters

Name	Type	Default value	Description
$name	string	-	-
$value	mixed	-	-

checkEnd() ¶

Generator.php : 402 Copy path

Check close / end operation.

protected checkEnd(string $type, mixed $data) : void

Parameters

Name	Type	Default value	Description
$type	string	-	-
$data	mixed	-	-

checkEndAttribute() ¶

Generator.php : 333 Copy path

Check end attribute.

protected checkEndAttribute(mixed $data) : void

Parameters

Name	Type	Default value	Description
$data	mixed	-	-

checkEndDocument() ¶

Generator.php : 122 Copy path

Check end document.

protected checkEndDocument(mixed $data) : void

Parameters

Name	Type	Default value	Description
$data	mixed	-	-

checkEndHashElement() ¶

Generator.php : 218 Copy path

Check end hash element.

protected checkEndHashElement(mixed $data) : void

Parameters

Name	Type	Default value	Description
$data	mixed	-	-

checkEndList() ¶

Generator.php : 295 Copy path

Check end list.

protected checkEndList(mixed $data) : void

Parameters

Name	Type	Default value	Description
$data	mixed	-	-

checkEndObjectElement() ¶

Generator.php : 171 Copy path

Check end object element.

protected checkEndObjectElement(mixed $data) : void

Parameters

Name	Type	Default value	Description
$data	mixed	-	-

checkEndValueElement() ¶

Generator.php : 257 Copy path

Check end value element.

protected checkEndValueElement(mixed $data) : void

Parameters

Name	Type	Default value	Description
$data	mixed	-	-

checkStack() ¶

Generator.php : 457 Copy path

protected checkStack(mixed $data) : void

Parameters

Name	Type	Default value	Description
$data	mixed	-	-

checkStart() ¶

Generator.php : 373 Copy path

Check close / end operation.

    
                        protected checkStart(string $type, mixed $data, array<string|int, string> $validParents) : void

Parameters

Name	Type	Default value	Description
$type	string	-	-
$data	mixed	-	-
$validParents	array<string\|int, string>	-	-

checkStartAttribute() ¶

Generator.php : 317 Copy path

Check start attribute.

protected checkStartAttribute(mixed $data) : void

Parameters

Name	Type	Default value	Description
$data	mixed	-	-

checkStartDocument() ¶

Generator.php : 103 Copy path

Check start document.

protected checkStartDocument(mixed $data) : void

Parameters

Name	Type	Default value	Description
$data	mixed	-	-

checkStartHashElement() ¶

Generator.php : 191 Copy path

Check start hash element.

protected checkStartHashElement(mixed $data) : void

Parameters

Name	Type	Default value	Description
$data	mixed	-	-

checkStartList() ¶

Generator.php : 270 Copy path

Check start list.

protected checkStartList(mixed $data) : void

Parameters

Name	Type	Default value	Description
$data	mixed	-	-

checkStartObjectElement() ¶

Generator.php : 161 Copy path

protected checkStartObjectElement(mixed $data) : void

Parameters

Name	Type	Default value	Description
$data	mixed	-	-

checkStartValueElement() ¶

Generator.php : 241 Copy path

Check start value element.

protected checkStartValueElement(mixed $data) : void

Parameters

Name	Type	Default value	Description
$data	mixed	-	-

generateMediaTypeWithVendor() ¶

Generator.php : 346 Copy path

Generates a media type from $name, $type and $vendor.

    
                        protected generateMediaTypeWithVendor(string $name, string $type[, string $vendor = 'vnd.ibexa.api' ]) : string

Parameters

Name	Type	Default value	Description
$name	string	-	-
$type	string	-	-
$vendor	string	'vnd.ibexa.api'	-

Return values

string

getData() ¶

Generator.php : 432 Copy path

protected abstract getData() : DataObjectInterface

Return values

DataObjectInterface

getVendor() ¶

Generator.php : 74 Copy path

protected getVendor() : string

Return values

string