PHP Class Newscoop\Image\ArticleImage

Inheritance: implements Newscoop\Image\ImageInterface

Datei anzeigen Open project: sourcefabric/newscoop Class Usage Examples

Protected Properties

Property	Type	Description
$articleNumber	integer
$id	integer
$image	Newscoop\Image\Image
$isDefault	boolean
$number	integer

Public Methods

Method	Description
__construct ( integer $articleNumber, LocalImage $image, boolean $isDefault = false, $number = 1 )
getArticleNumber ( ) : integer	Get article number
getCaption ( $languageId ) : string	Get caption
getHeight ( ) : integer	Get height
getId ( ) : integer	Get image id
getImage ( ) : Newscoop\Image\Image	Get image
getNumber ( ) : integer	Gets the value of number.
getPath ( ) : string	Get image path
getWidth ( ) : integer	Get width
isDefault ( ) : boolean	Test if is default image for article
setCaption ( string $caption, Language $language ) : void	Set caption
setIsDefault ( boolean $isDefault = false ) : void	Set is default image
setNumber ( integer $number ) : self	Sets the value of number.

Method Details

__construct() public method

public __construct ( integer $articleNumber, LocalImage $image, boolean $isDefault = false, $number = 1 )
$articleNumber	integer
$image	LocalImage
$isDefault	boolean

getArticleNumber() public method

Get article number

public getArticleNumber ( ) : integer
return	integer

getCaption() public method

Get caption

public getCaption ( $languageId ) : string
return	string

getHeight() public method

Get height

public getHeight ( ) : integer
return	integer

getId() public method

Get image id

public getId ( ) : integer
return	integer

getImage() public method

Get image

public getImage ( ) : Newscoop\Image\Image
return	Newscoop\Image\Image

getNumber() public method

Gets the value of number.

public getNumber ( ) : integer
return	integer

getPath() public method

Get image path

public getPath ( ) : string
return	string

getWidth() public method

Get width

public getWidth ( ) : integer
return	integer

isDefault() public method

Test if is default image for article

public isDefault ( ) : boolean
return	boolean

setCaption() public method

Set caption

public setCaption ( string $caption, Language $language ) : void
$caption	string
$language	Newscoop\Entity\Language
return	void

setIsDefault() public method

Set is default image

public setIsDefault ( boolean $isDefault = false ) : void
$isDefault	boolean
return	void

setNumber() public method

Sets the value of number.

public setNumber ( integer $number ) : self
$number	integer	the number
return	self

Property Details

$articleNumber protected_oe property

protected int $articleNumber
return	integer

$id protected_oe property

protected int $id
return	integer

$image protected_oe property

protected Newscoop\Image\Image $image
return	Newscoop\Image\Image

$isDefault protected_oe property

protected bool $isDefault
return	boolean

$number protected_oe property

protected int $number
return	integer