PHP Class Newscoop\Image\RenditionService

Datei anzeigen Open project: sourcefabric/newscoop Class Usage Examples

Protected Properties

Property Type Description
$config array
$imageService Newscoop\Image\ImageService
$orm Doctrine\ORM\EntityManager
$renditions array

Public Methods

Method Description
__construct ( EntityManager $orm, ImageService $imageService )
getArticleRenditionImage ( integer $articleNumber, string $renditionName, integer $width = null, integer $height = null ) : array Get article image rendition
getArticleRenditions ( integer $articleNumber ) : array Get article renditions
getOptions ( ) : array Get options
getRendition ( string $name ) : Newscoop\Image\Rendition Get rendition by given name
getRenditions ( ) : array Get renditions
hasRenditions ( ) : boolean Test if there are renditions defined
registerRenditions ( array $existing = [] ) : void Register renditions
reloadRenditions ( ) : void Force reload of rendition specs
setArticleRendition ( integer $articleNumber, Rendition $rendition, Newscoop\Image\ImageInterface $image, string $imageSpecs = null ) : Newscoop\Image\ArticleRendition Set article rendition
setRenditionsLabels ( array $labels ) : void Set renditions labels
setRenditionsOrder ( array $order ) : void Set renditions order
unsetArticleImageRenditions ( integer $articleNumber, integer $image ) : void Unset article-image rendition
unsetArticleRendition ( integer $articleNumber, string $rendition ) : void Unset article rendition

Private Methods

Method Description
createSchemaIfMissing ( Exception $e ) : void Create schema for article rendition
getArticleRendition ( integer $articleNumber, string $rendition ) : Newscoop\Image\ArticleRendition Get article rendition
getPackageRenditionNames ( ) : array Get renditions names used by packages
removeOrphanedArticleRenditions ( array $names ) : void Remove orphaned article renditions
removeOrphanedRenditions ( array $names ) : void Remove orphaned renditions

Method Details

__construct() public method

public __construct ( EntityManager $orm, ImageService $imageService )
$orm Doctrine\ORM\EntityManager
$imageService ImageService

getArticleRenditionImage() public method

Get article image rendition
public getArticleRenditionImage ( integer $articleNumber, string $renditionName, integer $width = null, integer $height = null ) : array
$articleNumber integer
$renditionName string
$width integer
$height integer
return array

getArticleRenditions() public method

Get article renditions
public getArticleRenditions ( integer $articleNumber ) : array
$articleNumber integer
return array

getOptions() public method

Get options
public getOptions ( ) : array
return array

getRendition() public method

Get rendition by given name
public getRendition ( string $name ) : Newscoop\Image\Rendition
$name string
return Newscoop\Image\Rendition

getRenditions() public method

Get renditions
public getRenditions ( ) : array
return array

hasRenditions() public method

Test if there are renditions defined
public hasRenditions ( ) : boolean
return boolean

registerRenditions() public method

Register renditions
public registerRenditions ( array $existing = [] ) : void
$existing array
return void

reloadRenditions() public method

Force reload of rendition specs
public reloadRenditions ( ) : void
return void

setArticleRendition() public method

Set article rendition
public setArticleRendition ( integer $articleNumber, Rendition $rendition, Newscoop\Image\ImageInterface $image, string $imageSpecs = null ) : Newscoop\Image\ArticleRendition
$articleNumber integer
$rendition Rendition
$image Newscoop\Image\ImageInterface
$imageSpecs string
return Newscoop\Image\ArticleRendition

setRenditionsLabels() public method

Set renditions labels
public setRenditionsLabels ( array $labels ) : void
$labels array
return void

setRenditionsOrder() public method

Set renditions order
public setRenditionsOrder ( array $order ) : void
$order array
return void

unsetArticleImageRenditions() public method

Unset article-image rendition
public unsetArticleImageRenditions ( integer $articleNumber, integer $image ) : void
$articleNumber integer
$image integer
return void

unsetArticleRendition() public method

Unset article rendition
public unsetArticleRendition ( integer $articleNumber, string $rendition ) : void
$articleNumber integer
$rendition string
return void

Property Details

$config protected_oe property

protected array $config
return array

$imageService protected_oe property

protected Newscoop\Image\ImageService $imageService
return Newscoop\Image\ImageService

$orm protected_oe property

protected Doctrine\ORM\EntityManager $orm
return Doctrine\ORM\EntityManager

$renditions protected_oe property

protected array $renditions
return array