PHP Class Eko\FeedBundle\Formatter\Formatter

This class provides formatter methods

Author: Vincent Composieux ([email protected])

Show file Open project: eko/feedbundle Class Usage Examples

Protected Properties

Property	Type	Description
$dom		XML DOMDocument
$domain	string \| null
$feed		A feed instance
$itemFields		Contain item Field instances for this formatter
$translator	Symfony\Component\Translation\TranslatorInterface

Public Methods

Method	Description
__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.

Protected Methods

Method	Description
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.

Method Details

__construct() public method

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() protected method

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() protected method

Adds channel fields to given channel.

protected addChannelFields ( DOMElement $channel )
$channel	DOMElement

format() protected method

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
return	string

formatGroupItemField() protected method

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
return	DOMElement

formatItemField() protected method

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
return	array \| DOMElement

formatMediaItemField() protected method

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
return	array \| null \| DOMElement

formatWithOptions() protected method

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
return	DOMElement

initialize() public method

Initializes feed.

public initialize ( )

render() public method

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

public render ( ) : string
return	string

translate() protected method

Translates a value.

protected translate ( string $value ) : string
$value	string
return	string

Property Details

$dom protected property

XML DOMDocument

protected $dom

$domain protected property

protected string\|null $domain
return	string \| null

$feed protected property

A feed instance

protected $feed

$itemFields protected property

Contain item Field instances for this formatter

protected $itemFields

$translator protected property

protected TranslatorInterface,Symfony\Component\Translation $translator
return	Symfony\Component\Translation\TranslatorInterface