PHP Класс Newscoop\Image\RenditionService

Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$config array
$imageService Newscoop\Image\ImageService
$orm Doctrine\ORM\EntityManager
$renditions array

Открытые методы

Метод Описание
__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

Приватные методы

Метод Описание
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

Описание методов

__construct() публичный метод

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

getArticleRenditionImage() публичный метод

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
Результат array

getArticleRenditions() публичный метод

Get article renditions
public getArticleRenditions ( integer $articleNumber ) : array
$articleNumber integer
Результат array

getOptions() публичный метод

Get options
public getOptions ( ) : array
Результат array

getRendition() публичный метод

Get rendition by given name
public getRendition ( string $name ) : Newscoop\Image\Rendition
$name string
Результат Newscoop\Image\Rendition

getRenditions() публичный метод

Get renditions
public getRenditions ( ) : array
Результат array

hasRenditions() публичный метод

Test if there are renditions defined
public hasRenditions ( ) : boolean
Результат boolean

registerRenditions() публичный метод

Register renditions
public registerRenditions ( array $existing = [] ) : void
$existing array
Результат void

reloadRenditions() публичный метод

Force reload of rendition specs
public reloadRenditions ( ) : void
Результат void

setArticleRendition() публичный метод

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
Результат Newscoop\Image\ArticleRendition

setRenditionsLabels() публичный метод

Set renditions labels
public setRenditionsLabels ( array $labels ) : void
$labels array
Результат void

setRenditionsOrder() публичный метод

Set renditions order
public setRenditionsOrder ( array $order ) : void
$order array
Результат void

unsetArticleImageRenditions() публичный метод

Unset article-image rendition
public unsetArticleImageRenditions ( integer $articleNumber, integer $image ) : void
$articleNumber integer
$image integer
Результат void

unsetArticleRendition() публичный метод

Unset article rendition
public unsetArticleRendition ( integer $articleNumber, string $rendition ) : void
$articleNumber integer
$rendition string
Результат void

Описание свойств

$config защищенное свойство

protected array $config
Результат array

$imageService защищенное свойство

protected Newscoop\Image\ImageService $imageService
Результат Newscoop\Image\ImageService

$orm защищенное свойство

protected Doctrine\ORM\EntityManager $orm
Результат Doctrine\ORM\EntityManager

$renditions защищенное свойство

protected array $renditions
Результат array