PHP Class Newscoop\Package\Package

Show file Open project: sourcefabric/newscoop Class Usage Examples

Protected Properties

Property Type Description
$articles array
$description string
$headline string
$id integer
$items
$itemsCount integer
$itemsLink string Items link used by Newscoop API
$rendition Newscoop\Image\Rendition
$slug string

Public Methods

Method Description
__construct ( )
__toString ( ) : string
getArticles ( ) : array Gets the value of articles.
getDescription ( ) : string Get description
getHeadline ( ) : string Get headline
getId ( ) : integer Get id
getItems ( ) : Doctrine\Common\Collections\Collection Get items
getItemsCount ( ) : integer Get items count
getItemsLink ( ) : string Get items link used by Newscoop API
getNext ( Item $currentItem ) : Newscoop\Package\Item Get next item
getPrev ( Item $currentItem ) : Newscoop\Package\Item Get previous item
getRendition ( ) : Rendition Get rendition
getSlug ( ) : string Get slug
getView ( ) : Newscoop\View\AuthorView Get view
setArticles ( array $articles ) : self Sets the value of articles.
setHeadline ( string $headline ) : void Set headline
setItemsCount ( integer $count ) : void Set items count
setItemsLink ( string $link ) Set items link used by Newscoop API
setRendition ( Rendition $rendition ) : void Set rendition
setSlug ( string $slug ) : void Set slug

Method Details

__construct() public method

public __construct ( )

__toString() public method

public __toString ( ) : string
return string

getArticles() public method

Gets the value of articles.
public getArticles ( ) : array
return array

getDescription() public method

Get description
public getDescription ( ) : string
return string

getHeadline() public method

Get headline
public getHeadline ( ) : string
return string

getId() public method

Get id
public getId ( ) : integer
return integer

getItems() public method

Get items
public getItems ( ) : Doctrine\Common\Collections\Collection
return Doctrine\Common\Collections\Collection

getItemsCount() public method

Get items count
public getItemsCount ( ) : integer
return integer

getNext() public method

Get next item
public getNext ( Item $currentItem ) : Newscoop\Package\Item
$currentItem Item
return Newscoop\Package\Item

getPrev() public method

Get previous item
public getPrev ( Item $currentItem ) : Newscoop\Package\Item
$currentItem Item
return Newscoop\Package\Item

getRendition() public method

Get rendition
public getRendition ( ) : Rendition
return Newscoop\Image\Rendition

getSlug() public method

Get slug
public getSlug ( ) : string
return string

getView() public method

Get view
public getView ( ) : Newscoop\View\AuthorView
return Newscoop\View\AuthorView

setArticles() public method

Sets the value of articles.
public setArticles ( array $articles ) : self
$articles array the articles
return self

setHeadline() public method

Set headline
public setHeadline ( string $headline ) : void
$headline string
return void

setItemsCount() public method

Set items count
public setItemsCount ( integer $count ) : void
$count integer
return void

setRendition() public method

Set rendition
public setRendition ( Rendition $rendition ) : void
$rendition Newscoop\Image\Rendition
return void

setSlug() public method

Set slug
public setSlug ( string $slug ) : void
$slug string
return void

Property Details

$articles protected property

protected array $articles
return array

$description protected property

protected string $description
return string

$headline protected property

protected string $headline
return string

$id protected property

protected int $id
return integer

$items protected property

protected $items

$itemsCount protected property

protected int $itemsCount
return integer

$rendition protected property

protected Rendition,Newscoop\Image $rendition
return Newscoop\Image\Rendition

$slug protected property

protected string $slug
return string