• Accueil
• Newscoop
• Entity
• Article

PHP Class Newscoop\Entity\Article

Afficher le fichier Open project: sourcefabric/newscoop Class Usage Examples

Protected Properties

Свойство	Type	Description
$articleAuthors	object	Article Authors for Newscoop\Gimme.
$articleOrder	integer
$attachments	Doctrine\Common\Collections\ArrayCollection
$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	Doctrine\Common\Collections\ArrayCollection
$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	Doctrine\Common\Collections\ArrayCollection
$topics	Doctrine\Common\Collections\ArrayCollection
$translations	array	Article translations used by Newscoop API.
$type	string
$updated	DateTime
$uploaded	DateTime
$webcode	Newscoop\Entity\Webcode
$workflowStatus	string

Méthodes publiques

Méthode	Description
__construct ( integer $number, Language $language )
addAttachment ( Attachment $attachment ) : self	Setter for attachments.
addSnippet ( Snippet $snippet ) : Newscoop\Entity\Article	Add a Snippet to the Article.
addTopic ( Topic $topic ) : boolean	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 ( ) : ArrayCollection	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 ( ) : ArrayCollection	Getter for images.
getIndexed ( ) : DateTime	Get indexed.
getIsIndexed ( ) : string	Gets the value of isIndexed.
getIssue ( ) : Issue	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 ( ) : Section	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 ( Snippet $snippet ) : Newscoop\Entity\Article	Remove a Snippet from the Article.
removeTopic ( Topic $topic ) : boolean	Remove a Topic from the Article.
setArticleAuthors ( $articleAuthors )	Set articleAuthors $articleAuthors.
setArticleOrder ( integer $articleOrder ) : self	Sets the value of articleOrder.
setAttachments ( ArrayCollection | null $attachments ) : self	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 ( User $p_user ) : Article	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 ) : Article	Set article id.
setImages ( ArrayCollection $images ) : self	Setter for images.
setIndexed ( DateTime $indexed = null ) : self	Set indexed.
setIsIndexed ( boolean $isIndexed ) : self	Sets the value of isIndexed.
setIssue ( Issue $issue ) : self	Setter for issue.
setIssueId ( integer $issueId ) : self	Sets the value of issueId.
setKeywords ( $keywords )	Set Keywords.
setLanguage ( Language $p_language ) : Newscoop\Entity\Article	Set language.
setLockTime ( DateTime $lockTime = null ) : self	Sets the value of lockTime.
setLockUser ( User $lockUser = null ) : self	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 ( Publication $p_publication ) : Article	Set publication.
setPublished ( Datetime | null $published ) : self	Set published.
setReads ( integer $reads )	Get reads.
setRenditions ( $renditions )	Set renditions $renditions.
setSection ( Section $section ) : self	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.

Private Methods

Méthode	Description
addFields ( ArticleView $view ) : array	Add field properties to view.
initArticleData ( ) : ArticleData	Init ArticleData.
setFieldValue ( string $field, string $value )	Set article type field value.

Method Details

Property Details