PHP Class eZ\Publish\Core\FieldType\RichText\Converter\Render\Embed

Inheritance: extends eZ\Publish\Core\FieldType\RichText\Converter\Render, implements eZ\Publish\Core\FieldType\RichText\Converter
Datei anzeigen Open project: ezsystems/ezpublish-kernel

Protected Properties

Property Type Description
$docbookToHtmlTargetMap array Maps Docbook target to HTML target.
$logger null | Psr\Log\LoggerInterface
$tagDefaultViewMap array Maps embed tag names to their default views.

Public Methods

Method Description
__construct ( eZ\Publish\Core\FieldType\RichText\RendererInterface $renderer, Psr\Log\LoggerInterface $logger = null )
convert ( DOMDocument $document ) : DOMDocument Injects rendered payloads into embed elements.

Protected Methods

Method Description
extractLinkParameters ( DOMElement $embed ) : array Extracts link parameters from embed element.
extractParameters ( DOMElement $embed, $tagName ) : array Extracts parameters from embed element.
isLinkWrapped ( DOMElement $element ) : boolean Returns boolean signifying if the embed is contained in a link element of not.
mapLinkTarget ( string $docbookLinkTarget ) Converts Docbook target to HTML target.
processTag ( DOMDocument $document, $tagName, boolean $isInline ) Processes single embed element type (ezembed or ezembedinline).

Method Details

__construct() public method

public __construct ( eZ\Publish\Core\FieldType\RichText\RendererInterface $renderer, Psr\Log\LoggerInterface $logger = null )
$renderer eZ\Publish\Core\FieldType\RichText\RendererInterface
$logger Psr\Log\LoggerInterface

convert() public method

Injects rendered payloads into embed elements.
public convert ( DOMDocument $document ) : DOMDocument
$document DOMDocument
return DOMDocument

extractLinkParameters() protected method

Extracts link parameters from embed element.
protected extractLinkParameters ( DOMElement $embed ) : array
$embed DOMElement
return array

extractParameters() protected method

Extracts parameters from embed element.
protected extractParameters ( DOMElement $embed, $tagName ) : array
$embed DOMElement
$tagName string name of the tag to extract
return array

isLinkWrapped() protected method

After EmbedLinking converter pass this should be possible only for inline level embeds.
protected isLinkWrapped ( DOMElement $element ) : boolean
$element DOMElement
return boolean

mapLinkTarget() protected method

Converts Docbook target to HTML target.
protected mapLinkTarget ( string $docbookLinkTarget )
$docbookLinkTarget string

processTag() protected method

Processes single embed element type (ezembed or ezembedinline).
protected processTag ( DOMDocument $document, $tagName, boolean $isInline )
$document DOMDocument
$tagName string name of the tag to extract
$isInline boolean

Property Details

$docbookToHtmlTargetMap protected_oe property

Maps Docbook target to HTML target.
protected array $docbookToHtmlTargetMap
return array

$logger protected_oe property

protected null|LoggerInterface,Psr\Log $logger
return null | Psr\Log\LoggerInterface

$tagDefaultViewMap protected_oe property

Maps embed tag names to their default views.
protected array $tagDefaultViewMap
return array