Property | Type | Description | |
---|---|---|---|
$articleAuthors | object | Article Authors for Newscoop\Gimme. | |
$articleOrder | integer | ||
$attachments | |||
$authors | Doctrine\Common\Collections\Collection | ||
$comments | Newscoop\Entity\Comments | ||
$commentsLocked | integer | ||
$comments_count | integer | ||
$comments_enabled | integer | ||
$comments_link | string | ||
$creator | Newscoop\Entity\User | ||
$data | ArticleData | ||
$fields | array | Article fields used by Newscoop API. | |
$images | |||
$indexed | DateTime | ||
$isIndexed | string | ||
$issue | Newscoop\Entity\Issue | ||
$issueId | integer | TODO: Fix this bug. It's not Issue Id - it's issueNumber! | |
$keywords | string | ||
$language | Newscoop\Entity\Language | ||
$lockTime | DateTime | ||
$lockUser | Newscoop\Entity\User | ||
$name | string | ||
$number | integer | ||
$objectId | integer | ||
$onFrontPage | string | ||
$onSection | string | ||
$packages | Newscoop\Package\Package | ||
$playlists | Newscoop\Entity\Playlist | ||
$public | string | ||
$publication | Newscoop\Entity\Publication | ||
$published | DateTime | ||
$reads | integer | Article reads number used by Newscoop API. | |
$recommended_comments_count | integer | ||
$renditions | array | Article renditions used by Newscoop API. | |
$section | Newscoop\Entity\Section | ||
$sectionId | integer | TODO: Fix this bug. It's not section Id - it's sectionNumber! | |
$shortName | string | ||
$snippets | |||
$topics | |||
$translations | array | Article translations used by Newscoop API. | |
$type | string | ||
$updated | DateTime | ||
$uploaded | DateTime | ||
$webcode | Newscoop\Entity\Webcode | ||
$workflowStatus | string |
Method | Description | |
---|---|---|
__construct ( integer $number, |
||
addAttachment ( |
Setter for attachments. | |
addSnippet ( |
Add a Snippet to the Article. | |
addTopic ( |
Add Topic to the Article. | |
author ( string $title, array $fields ) | Author article. | |
commentsEnabled ( ) : integer | Get whether commenting is enabled. | |
commentsLocked ( ) : mixed | Getter for commentsLocked. | |
getArticleAuthors ( ) : object | Get articleAuthors. | |
getArticleOrder ( ) : integer | Gets the value of articleOrder. | |
getAttachments ( ) : |
Getter for attachments. | |
getCommentsEnabled ( ) : integer | Get whether commenting is enabled. | |
getCommentsLocked ( ) : mixed | Getter for commentsLocked. | |
getCreator ( ) : Newscoop\Entity\User | Get creator. | |
getData ( string $field ) : mixed | Get article type field data. | |
getDate ( ) : string | Get date. | |
getFieldNames ( ) : mixed | Get all field names for this article type. | |
getFields ( ) : object | Get fields. | |
getFirstImage ( ) : Newscoop\Image\LocalImage | Get article first image. | |
getId ( ) : integer | Get article id. | |
getImages ( ) : |
Getter for images. | |
getIndexed ( ) : DateTime | Get indexed. | |
getIsIndexed ( ) : string | Gets the value of isIndexed. | |
getIssue ( ) : |
Getter for issue. | |
getIssueId ( ) : integer | Gets the value of issueId. | |
getKeywords ( ) : string | Get keywords. | |
getLanguage ( ) : Newscoop\Entity\Language | Get language. | |
getLanguageCode ( ) : integer | Get language code. | |
getLanguageId ( ) : integer | Get language id. | |
getLanguageObject ( ) : Newscoop\Entity\Language | Get language object. | |
getLockTime ( ) : DateTime | Gets the value of lockTime. | |
getLockTimeDiffrence ( ) : array | Gets the time difference between current and article lock time. | |
getLockUser ( ) : Newscoop\Entity\User | Gets the value of lockUser. | |
getName ( ) : string | Get article name. | |
getNumber ( ) : integer | Get number. | |
getObject ( ) | ||
getOnFrontPage ( ) : string | Gets the value of onFrontPage. | |
getOnSection ( ) : string | Gets the value of onSection. | |
getPackages ( ) : object | Get packages. | |
getPublic ( ) : string | Gets the value of public. | |
getPublication ( ) : Newscoop\Entity\Publication | Get publication. | |
getPublicationId ( ) : integer | Get publication id. | |
getPublishDate ( ) : string | Get publishDate. | |
getPublished ( ) : string | Get published. | |
getReads ( ) : integer | Set reads. | |
getRenditions ( ) : object | Get renditions. | |
getSection ( ) : |
Get section. | |
getSectionId ( ) : integer | Gets the value of sectionId. | |
getShortName ( ) : string | Gets the value of shortName. | |
getSnippets ( ) | Get Article Snippets. | |
getTitle ( ) : string | Get title. | |
getTopicNames ( ) : array | Get topic names. | |
getTopics ( ) : object | Get topics. | |
getTranslations ( ) : object | Get translations. | |
getType ( ) : string | Get type. | |
getUpdated ( ) : mixed | Getter for updated. | |
getUploaded ( ) : DateTime | Gets the value of uploaded. | |
getView ( ) : object | Get view. | |
getWebcode ( ) : string | Get webcode. | |
getWebcodeEntity ( ) : string | Get webcode object. | |
getWorkflowStatus ( $readable = false ) : string | Get workflowStatus. | |
hasWebcode ( ) : boolean | Test if article has webcode. | |
isLocked ( ) : boolean | Checks if article is locked or not. | |
isPublished ( ) : boolean | Test if article is published. | |
publish ( ) | * Publish article | |
removeSnippet ( |
Remove a Snippet from the Article. | |
removeTopic ( |
Remove a Topic from the Article. | |
setArticleAuthors ( $articleAuthors ) | Set articleAuthors $articleAuthors. | |
setArticleOrder ( integer $articleOrder ) : self | Sets the value of articleOrder. | |
setAttachments ( |
Setter for attachments. | |
setCommentsEnabled ( integer $comments_enabled ) | Set commenting en/disabled. | |
setCommentsLink ( string $link ) | Set comments_link. | |
setCommentsLocked ( mixed $commentsLocked ) : self | Setter for commentsLocked. | |
setCreator ( |
Set creator. | |
setData ( array $data ) | Set data. | |
setDate ( DateTime $date ) | Set date. | |
setFieldData ( string $field, string $value ) : mixed | Set article type field data. | |
setFields ( $fields ) | Set Fields $fields. | |
setId ( integer $p_id ) : |
Set article id. | |
setImages ( |
Setter for images. | |
setIndexed ( DateTime $indexed = null ) : self | Set indexed. | |
setIsIndexed ( boolean $isIndexed ) : self | Sets the value of isIndexed. | |
setIssue ( |
Setter for issue. | |
setIssueId ( integer $issueId ) : self | Sets the value of issueId. | |
setKeywords ( $keywords ) | Set Keywords. | |
setLanguage ( |
Set language. | |
setLockTime ( DateTime $lockTime = null ) : self | Sets the value of lockTime. | |
setLockUser ( |
Sets the value of lockUser. | |
setName ( string $name ) : self | Sets the value of name. | |
setNumber ( $number ) : integer | Set number. | |
setOnFrontPage ( string $onFrontPage = false ) : self | Sets the value of onFrontPage. | |
setOnSection ( string $onSection = false ) : self | Sets the value of onSection. | |
setPackages ( $packages ) | Set Packages $packages. | |
setPublic ( boolean $public ) : self | Sets the value of public. | |
setPublication ( |
Set publication. | |
setPublished ( Datetime | null $published ) : self | Set published. | |
setReads ( integer $reads ) | Get reads. | |
setRenditions ( $renditions ) | Set renditions $renditions. | |
setSection ( |
Setter for section. | |
setSectionId ( integer $sectionId ) : self | Sets the value of sectionId. | |
setShortName ( string $shortName ) : self | Sets the value of shortName. | |
setTitle ( string $title ) | Set title. | |
setTopics ( $topics ) | Set Topics $topics. | |
setTranslations ( $translations ) | Set translations $translations. | |
setType ( string $type ) : self | Sets the value of type. | |
setUpdated ( DateTime $updated ) : self | Setter for updated. | |
setUploaded ( DateTime $uploaded ) : self | Sets the value of uploaded. | |
setWebcode ( Newscoop\Entity\Webcode $webcode ) | Set webcode. | |
setWorkflowStatus ( $workflowStatus ) | Set workflowStatus. |
Method | Description | |
---|---|---|
addFields ( |
Add field properties to view. | |
initArticleData ( ) : ArticleData | Init ArticleData. | |
setFieldValue ( string $field, string $value ) | Set article type field value. |
public __construct ( integer $number, |
||
$number | integer | |
$language |
public addAttachment ( |
||
$attachment | ||
return | self |
public addSnippet ( |
||
$snippet | the Snippet to attach | |
return | Newscoop\Entity\Article |
public commentsEnabled ( ) : integer | ||
return | integer |
public commentsLocked ( ) : mixed | ||
return | mixed |
public getArticleAuthors ( ) : object | ||
return | object |
public getArticleOrder ( ) : integer | ||
return | integer |
public getAttachments ( ) : |
||
return |
public getCommentsEnabled ( ) : integer | ||
return | integer |
public getCommentsLocked ( ) : mixed | ||
return | mixed |
public getCreator ( ) : Newscoop\Entity\User | ||
return | Newscoop\Entity\User |
public getFieldNames ( ) : mixed | ||
return | mixed | Returns array with field names or null |
public getFirstImage ( ) : Newscoop\Image\LocalImage | ||
return | Newscoop\Image\LocalImage |
public getImages ( ) : |
||
return |
public getIsIndexed ( ) : string | ||
return | string |
public getIssueId ( ) : integer | ||
return | integer |
public getLanguage ( ) : Newscoop\Entity\Language | ||
return | Newscoop\Entity\Language |
public getLanguageCode ( ) : integer | ||
return | integer |
public getLanguageObject ( ) : Newscoop\Entity\Language | ||
return | Newscoop\Entity\Language |
public getLockTime ( ) : DateTime | ||
return | DateTime |
public getLockTimeDiffrence ( ) : array | ||
return | array |
public getLockUser ( ) : Newscoop\Entity\User | ||
return | Newscoop\Entity\User |
public getOnFrontPage ( ) : string | ||
return | string |
public getOnSection ( ) : string | ||
return | string |
public getPublication ( ) : Newscoop\Entity\Publication | ||
return | Newscoop\Entity\Publication |
public getPublicationId ( ) : integer | ||
return | integer |
public getSectionId ( ) : integer | ||
return | integer |
public getShortName ( ) : string | ||
return | string |
public getUploaded ( ) : DateTime | ||
return | DateTime |
public getWebcodeEntity ( ) : string | ||
return | string |
public getWorkflowStatus ( $readable = false ) : string | ||
return | string |
public hasWebcode ( ) : boolean | ||
return | boolean |
public isPublished ( ) : boolean | ||
return | boolean |
public removeSnippet ( |
||
$snippet | the Snippet to remove | |
return | Newscoop\Entity\Article |
public removeTopic ( |
||
$topic | the Topic to remove | |
return | boolean |
public setArticleAuthors ( $articleAuthors ) |
public setArticleOrder ( integer $articleOrder ) : self | ||
$articleOrder | integer | the article order |
return | self |
public setAttachments ( |
||
$attachments | Value to set | |
return | self |
public setCommentsEnabled ( integer $comments_enabled ) | ||
$comments_enabled | integer |
public setCommentsLink ( string $link ) | ||
$link | string | uri for comments resource in Newscoop API |
public setCommentsLocked ( mixed $commentsLocked ) : self | ||
$commentsLocked | mixed | Value to set |
return | self |
public setCreator ( |
||
$p_user | ||
return |
public setImages ( |
||
$images | Value to set | |
return | self |
public setIndexed ( DateTime $indexed = null ) : self | ||
$indexed | DateTime | |
return | self |
public setIsIndexed ( boolean $isIndexed ) : self | ||
$isIndexed | boolean | the is indexed |
return | self |
public setIssue ( |
||
$issue | Value to set | |
return | self |
public setIssueId ( integer $issueId ) : self | ||
$issueId | integer | the issue id |
return | self |
public setLanguage ( |
||
$p_language | ||
return | Newscoop\Entity\Article |
public setLockTime ( DateTime $lockTime = null ) : self | ||
$lockTime | DateTime | the lock time |
return | self |
public setLockUser ( |
||
$lockUser | the lock user | |
return | self |
public setOnFrontPage ( string $onFrontPage = false ) : self | ||
$onFrontPage | string | the on front page |
return | self |
public setOnSection ( string $onSection = false ) : self | ||
$onSection | string | the on section |
return | self |
public setPublication ( |
||
$p_publication | ||
return |
public setPublished ( Datetime | null $published ) : self | ||
$published | Datetime | null | |
return | self |
public setSection ( |
||
$section | ||
return | self |
public setSectionId ( integer $sectionId ) : self | ||
$sectionId | integer | the section id |
return | self |
public setShortName ( string $shortName ) : self | ||
$shortName | string | the short name |
return | self |
public setTranslations ( $translations ) |
public setUpdated ( DateTime $updated ) : self | ||
$updated | DateTime | Value to set |
return | self |
public setUploaded ( DateTime $uploaded ) : self | ||
$uploaded | DateTime | the uploaded |
return | self |
public setWebcode ( Newscoop\Entity\Webcode $webcode ) | ||
$webcode | Newscoop\Entity\Webcode |
protected object $articleAuthors | ||
return | object |
protected ArrayCollection,Doctrine\Common\Collections $attachments | ||
return |
protected Doctrine\Common\Collections\Collection $authors | ||
return | Doctrine\Common\Collections\Collection |
protected Newscoop\Entity\Comments $comments | ||
return | Newscoop\Entity\Comments |
protected array $fields | ||
return | array |
protected ArrayCollection,Doctrine\Common\Collections $images | ||
return |
protected int $issueId | ||
return | integer |
protected Newscoop\Entity\Language $language | ||
return | Newscoop\Entity\Language |
protected Newscoop\Entity\User $lockUser | ||
return | Newscoop\Entity\User |
protected Newscoop\Package\Package $packages | ||
return | Newscoop\Package\Package |
protected Newscoop\Entity\Playlist $playlists | ||
return | Newscoop\Entity\Playlist |
protected Newscoop\Entity\Publication $publication | ||
return | Newscoop\Entity\Publication |
protected int $reads | ||
return | integer |
protected int $recommended_comments_count | ||
return | integer |
protected array $renditions | ||
return | array |
protected Newscoop\Entity\Section $section | ||
return | Newscoop\Entity\Section |
protected int $sectionId | ||
return | integer |
protected ArrayCollection,Doctrine\Common\Collections $snippets | ||
return |
protected ArrayCollection,Doctrine\Common\Collections $topics | ||
return |
protected array $translations | ||
return | array |
protected Newscoop\Entity\Webcode $webcode | ||
return | Newscoop\Entity\Webcode |