PHP Класс Eko\FeedBundle\Formatter\Formatter

This class provides formatter methods

Автор: Vincent Composieux ([email protected])

Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство	Тип	Описание
$dom		XML DOMDocument
$domain	string \| null
$feed		A feed instance
$itemFields		Contain item Field instances for this formatter
$translator	Symfony\Component\Translation\TranslatorInterface

Открытые методы

Метод	Описание
__construct ( Symfony\Component\Translation\TranslatorInterface $translator, string \| null $domain = null )	Construct a formatter with given feed.
initialize ( )	Initializes feed.
render ( ) : string	This method render the given feed transforming the DOMDocument to XML.

Защищенные методы

Метод	Описание
addAttributes ( DOMElement $element, Eko\FeedBundle\Field\Item\ItemFieldInterface $field, Eko\FeedBundle\Item\Writer\ItemInterface $item = null )	Add field attributes to a DOM element.
addChannelFields ( DOMElement $channel )	Adds channel fields to given channel.
format ( Eko\FeedBundle\Field\Item\ItemFieldInterface $field, Eko\FeedBundle\Item\Writer\ItemInterface $item ) : string	Format items field.
formatGroupItemField ( Eko\FeedBundle\Field\Item\GroupItemField $field, Eko\FeedBundle\Item\Writer\ItemInterface $item ) : DOMElement	Format a group item field.
formatItemField ( Eko\FeedBundle\Field\Item\ItemFieldInterface $field, Eko\FeedBundle\Item\Writer\ItemInterface $item ) : array \| DOMElement	Format an item field.
formatMediaItemField ( Eko\FeedBundle\Field\Item\MediaItemField $field, Eko\FeedBundle\Item\Writer\ItemInterface $item ) : array \| null \| DOMElement	Format a media item field.
formatWithOptions ( Eko\FeedBundle\Field\Item\ItemFieldInterface $field, Eko\FeedBundle\Item\Writer\ItemInterface $item, string $value ) : DOMElement	Format an item field.
translate ( string $value ) : string	Translates a value.

Описание методов

__construct() публичный метод

Construct a formatter with given feed.

public __construct ( Symfony\Component\Translation\TranslatorInterface $translator, string \| null $domain = null )
$translator	Symfony\Component\Translation\TranslatorInterface	A Symfony translator service instance
$domain	string \| null	A Symfony translation domain

addAttributes() защищенный метод

Add field attributes to a DOM element.

protected addAttributes ( DOMElement $element, Eko\FeedBundle\Field\Item\ItemFieldInterface $field, Eko\FeedBundle\Item\Writer\ItemInterface $item = null )
$element	DOMElement	A XML DOM element
$field	Eko\FeedBundle\Field\Item\ItemFieldInterface	A feed field instance
$item	Eko\FeedBundle\Item\Writer\ItemInterface	A feed item instance

addChannelFields() защищенный метод

Adds channel fields to given channel.

protected addChannelFields ( DOMElement $channel )
$channel	DOMElement

format() защищенный метод

Format items field.

protected format ( Eko\FeedBundle\Field\Item\ItemFieldInterface $field, Eko\FeedBundle\Item\Writer\ItemInterface $item ) : string
$field	Eko\FeedBundle\Field\Item\ItemFieldInterface	A item field instance
$item	Eko\FeedBundle\Item\Writer\ItemInterface	An entity instance
Результат	string

formatGroupItemField() защищенный метод

Format a group item field.

protected formatGroupItemField ( Eko\FeedBundle\Field\Item\GroupItemField $field, Eko\FeedBundle\Item\Writer\ItemInterface $item ) : DOMElement
$field	Eko\FeedBundle\Field\Item\GroupItemField	An item field instance
$item	Eko\FeedBundle\Item\Writer\ItemInterface	An entity instance
Результат	DOMElement

formatItemField() защищенный метод

Format an item field.

protected formatItemField ( Eko\FeedBundle\Field\Item\ItemFieldInterface $field, Eko\FeedBundle\Item\Writer\ItemInterface $item ) : array \| DOMElement
$field	Eko\FeedBundle\Field\Item\ItemFieldInterface	An item field instance
$item	Eko\FeedBundle\Item\Writer\ItemInterface	An entity instance
Результат	array \| DOMElement

formatMediaItemField() защищенный метод

Format a media item field.

protected formatMediaItemField ( Eko\FeedBundle\Field\Item\MediaItemField $field, Eko\FeedBundle\Item\Writer\ItemInterface $item ) : array \| null \| DOMElement
$field	Eko\FeedBundle\Field\Item\MediaItemField	A media item field instance
$item	Eko\FeedBundle\Item\Writer\ItemInterface	An entity instance
Результат	array \| null \| DOMElement

formatWithOptions() защищенный метод

Format an item field.

protected formatWithOptions ( Eko\FeedBundle\Field\Item\ItemFieldInterface $field, Eko\FeedBundle\Item\Writer\ItemInterface $item, string $value ) : DOMElement
$field	Eko\FeedBundle\Field\Item\ItemFieldInterface	An item field instance
$item	Eko\FeedBundle\Item\Writer\ItemInterface	An entity instance
$value	string	A field value
Результат	DOMElement

initialize() публичный метод

Initializes feed.

public initialize ( )

render() публичный метод

This method render the given feed transforming the DOMDocument to XML.

public render ( ) : string
Результат	string

translate() защищенный метод

Translates a value.

protected translate ( string $value ) : string
$value	string
Результат	string

Описание свойств

$dom защищенное свойство

XML DOMDocument

protected $dom

$domain защищенное свойство

protected string\|null $domain
Результат	string \| null

$feed защищенное свойство

A feed instance

protected $feed

$itemFields защищенное свойство

Contain item Field instances for this formatter

protected $itemFields

$translator защищенное свойство

protected TranslatorInterface,Symfony\Component\Translation $translator
Результат	Symfony\Component\Translation\TranslatorInterface