1. class
  2. RZ
  3. \
  4. Roadiz
  5. \
  6. Utils
  7. \
  8. TwigExtensions
  9. \
  10. DocumentExtension

DocumentExtension

class DocumentExtension extends Twig_Extension (View source)

Extension that allow render document images.

Methods

__construct(Container $container, bool $throwExceptions = false)

DocumentExtension constructor.

string
getName()

No description

array
getFilters()

No description

bool|AbstractEmbedFinder
getEmbedFinder(Document $document = null)

No description

string
display(Document $document = null, array $criteria = [])

No description

null|string
getImageOrientation(Document $document = null)

Get image orientation.

array
getImageSize(Document $document = null)

No description

float
getImageRatio(Document $document = null)

No description

null|string
getPath(Document $document = null)

No description

bool
exists(Document $document = null)

No description

Details

at line 59
__construct(Container $container, bool $throwExceptions = false)

DocumentExtension constructor.

Parameters

Container $container
bool $throwExceptions Trigger exception if using filter on NULL values (default: false)

at line 68
string getName()

Return Value

string

at line 76
array getFilters()

Return Value

array

at line 94
bool|AbstractEmbedFinder getEmbedFinder(Document $document = null)

Parameters

Document $document

Return Value

bool|AbstractEmbedFinder

Exceptions

Twig_Error_Runtime

at line 118
string display(Document $document = null, array $criteria = [])

Parameters

Document $document
array $criteria

Return Value

string

Exceptions

Twig_Error_Loader
Twig_Error_Runtime
Twig_Error_Syntax

at line 148
null|string getImageOrientation(Document $document = null)

Get image orientation.

  • Return null if document is not an Image
  • Return 'landscape' if width is higher or equal to height
  • Return 'portrait' if height is strictly lower to width

Parameters

Document $document

Return Value

null|string

Exceptions

Twig_Error_Runtime

at line 170
array getImageSize(Document $document = null)

Parameters

Document $document

Return Value

array

Exceptions

Twig_Error_Runtime

at line 210
float getImageRatio(Document $document = null)

Parameters

Document $document

Return Value

float

Exceptions

Twig_Error_Runtime

at line 234
null|string getPath(Document $document = null)

Parameters

Document $document

Return Value

null|string

at line 247
bool exists(Document $document = null)

Parameters

Document $document

Return Value

bool