PHP Класс Newscoop\Entity\Snippet

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

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

Свойство Тип Описание
$articles Newscoop\Entity\Article
$created string
$enabled boolean
$fields Doctrine\Common\Collections\ArrayCollection
$id integer
$modified string
$name string
$template Newscoop\Entity\Snippet\SnippetTemplate

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

Метод Описание
__construct ( SnippetTemplate $template ) Constructs the Snippet
addArticle ( Article $article ) : Newscoop\Entity\Snippet Add an Article to the Snippet
getArticles ( ) : ArrayCollection Return the attached Articles
getCreated ( ) : DateTime Getter for created
getEnabled ( ) : mixed Getter for enabled
getFields ( ) : ArrayCollection Getter for fields
getFieldsWithoutBackend ( ) : ArrayCollection Getter for fields without the Backend scope
getId ( ) : integer Getter for id
getModified ( ) : mixed Getter for modified
getName ( ) : string Getter for Name
getTemplate ( ) : SnippetTemplate Getter for Template
getTemplateId ( ) : integer Returns the Template id
getTemplateName ( ) : string Returns the Template Name
hasName ( ) : boolean Check if Snippet has a name
removeArticle ( Article $article ) : Newscoop\Entity\Snippet Remove an Article from the Snippet
render ( ) : string Renders the Snippet with the Data into the Template
setCreated ( DateTime $created = null ) : Newscoop\Entity\Snippet Setter for created
setData ( string $fieldName, string $fieldData = null ) : Newscoop\Entity\Snippet Set Snippet Data to the appropriate fields
setEnabled ( mixed $enabled ) : self Setter for enabled
setId ( integer $id ) : Newscoop\Entity\Snippet Setter for id
setModified ( mixed $modified = null ) : self Setter for modified
setName ( string $name ) : Newscoop\Entity\Snippet Setter for Name
setTemplate ( SnippetTemplate $template ) : Newscoop\Entity\Snippet Setter for Template

Приватные методы

Метод Описание
addField ( SnippetField $field ) : Newscoop\Entity\Snippet Add Snippet fields

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

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

Constructs the Snippet
public __construct ( SnippetTemplate $template )
$template Newscoop\Entity\Snippet\SnippetTemplate SnippetTemplate to set for this Snippet

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

Add an Article to the Snippet
public addArticle ( Article $article ) : Newscoop\Entity\Snippet
$article Article the Article to attach
Результат Newscoop\Entity\Snippet

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

Return the attached Articles
public getArticles ( ) : ArrayCollection
Результат Doctrine\Common\Collections\ArrayCollection

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

Getter for created
public getCreated ( ) : DateTime
Результат DateTime

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

Getter for enabled
public getEnabled ( ) : mixed
Результат mixed

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

Getter for fields
public getFields ( ) : ArrayCollection
Результат Doctrine\Common\Collections\ArrayCollection

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

Getter for fields without the Backend scope
public getFieldsWithoutBackend ( ) : ArrayCollection
Результат Doctrine\Common\Collections\ArrayCollection

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

Getter for id
public getId ( ) : integer
Результат integer

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

Getter for modified
public getModified ( ) : mixed
Результат mixed

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

Getter for Name
public getName ( ) : string
Результат string

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

Getter for Template
public getTemplate ( ) : SnippetTemplate
Результат Newscoop\Entity\Snippet\SnippetTemplate

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

Returns the Template id
public getTemplateId ( ) : integer
Результат integer template id

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

Returns the Template Name
public getTemplateName ( ) : string
Результат string template name

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

Check if Snippet has a name
public hasName ( ) : boolean
Результат boolean

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

Remove an Article from the Snippet
public removeArticle ( Article $article ) : Newscoop\Entity\Snippet
$article Article the Article to remove
Результат Newscoop\Entity\Snippet

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

Renders the Snippet with the Data into the Template
public render ( ) : string
Результат string rendered Snippet

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

Setter for created
public setCreated ( DateTime $created = null ) : Newscoop\Entity\Snippet
$created DateTime Value to set
Результат Newscoop\Entity\Snippet

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

Set Snippet Data to the appropriate fields
public setData ( string $fieldName, string $fieldData = null ) : Newscoop\Entity\Snippet
$fieldName string the name of the SnippetField
$fieldData string the data of the SnippetField
Результат Newscoop\Entity\Snippet

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

Setter for enabled
public setEnabled ( mixed $enabled ) : self
$enabled mixed Value to set
Результат self

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

Setter for id
public setId ( integer $id ) : Newscoop\Entity\Snippet
$id integer
Результат Newscoop\Entity\Snippet

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

Setter for modified
public setModified ( mixed $modified = null ) : self
$modified mixed Value to set
Результат self

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

Setter for Name
public setName ( string $name ) : Newscoop\Entity\Snippet
$name string
Результат Newscoop\Entity\Snippet

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

Setter for Template
public setTemplate ( SnippetTemplate $template ) : Newscoop\Entity\Snippet
$template Newscoop\Entity\Snippet\SnippetTemplate
Результат Newscoop\Entity\Snippet

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

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

protected Newscoop\Entity\Article $articles
Результат Newscoop\Entity\Article

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

protected string $created
Результат string

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

protected bool $enabled
Результат boolean

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

protected ArrayCollection,Doctrine\Common\Collections $fields
Результат Doctrine\Common\Collections\ArrayCollection

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

protected int $id
Результат integer

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

protected string $modified
Результат string

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

protected string $name
Результат string

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

protected SnippetTemplate,Newscoop\Entity\Snippet $template
Результат Newscoop\Entity\Snippet\SnippetTemplate