PHP Класс Newscoop\Image\ImageService

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

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

Свойство Тип Описание
$cacheService
$config array
$orm Doctrine\ORM\EntityManager
$supportedTypes array

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

Метод Описание
__construct ( array $config, EntityManager $orm, $cacheService )
addArticleImage ( integer $articleNumber, LocalImage $image, boolean $defaultImage = false ) : Newscoop\Image\ArticleImage Add article image
calculateCutout ( $srcWidth, $srcHeight, $left, $top, $newWidth, $newHeight ) : array Calculates dimensions of cutout in image.
calculateSize ( $srcWidth, $srcHeight, $newWidth, $newHeight, $flags = self::FIT ) : array Calculates dimensions of resized image.
fillImage ( LocalImage $image, array $attributes ) : LocalImage Fill image with custom/default arttributes
find ( integer $id ) : LocalImage Find image
findBy ( array $criteria, array $orderBy = null, integer $limit = 25, integer $offset ) : array Find images by a set of criteria
findByArticle ( integer $articleNumber ) : array Find images by article
generateFromSrc ( string $src ) : void Generate image for given src
getArticleImage ( integer $articleNumber, integer $imageId ) : Newscoop\Image\ArticleImage Get article image
getArticleImageCaption ( integer $imageId, integer $articleNumber, integer $languageId ) : string Get article specific image caption
getArticleImagesCount ( integer $articleNumber ) : integer Get count of article images
getCaption ( LocalImage $image, integer $articleNumber, integer $languageId ) : string Get image caption
getCountBy ( array $criteria ) : integer Get count of images for a set of criteria
getDefaultArticleImage ( integer $articleNumber ) : Newscoop\Image\ArticleImage Get default article image
getImagePath ( ) : string Gets path of local images
getImagine ( )
getSrc ( string $image, integer $width, integer $height, string $specs = 'fit' ) : string Get image src
getThumbnail ( Rendition $rendition, Newscoop\Image\ImageInterface $image ) : Newscoop\Image\Thumbnail Get thumbnail for given image and rendition
getUserImage ( User $user, integer $width = 65, integer $height = 65 ) : string Get user image
inUse ( LocalImage $image ) : boolean Return true if the image is being used by an article.
remove ( LocalImage $image ) : boolean Remove image (files and entity)
removeArticleImage ( ArticleImage $articleImage ) Remove image from article
save ( array $info ) : string Save image
saveArticleImage ( ArticleImage $articleImage, array $values ) : void Save article image
setDefaultArticleImage ( integer $articleNumber, ArticleImage $image ) : void Set default article image
thumbnail ( string $image, integer $width, integer $height, string $specs ) : mixed Get thumbnail for given image
upload ( Symfony\Component\HttpFoundation\File\UploadedFile $file, array $attributes, Newscoop\Image\ImageInterface $image = null, $keepRatio = true ) : LocalImage Upload image and create entity

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

Метод Описание
decodePath ( string $path ) : string Decode path
encodePath ( string $path ) : string Encode path
generateImagePath ( integer $imageId, string $extension, boolean $olnyFileName = false ) : string Generate file path for image
generateThumbnailPath ( integer $imageId, string $extension, boolean $olnyFileName = false ) : string Generate file path for thumbnail
updateSchema ( integer $articleNumber ) : void Update schema if needed

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

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

public __construct ( array $config, EntityManager $orm, $cacheService )
$config array
$orm Doctrine\ORM\EntityManager

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

Add article image
public addArticleImage ( integer $articleNumber, LocalImage $image, boolean $defaultImage = false ) : Newscoop\Image\ArticleImage
$articleNumber integer
$image LocalImage
$defaultImage boolean
Результат Newscoop\Image\ArticleImage

calculateCutout() публичный статический метод

Calculates dimensions of cutout in image.
public static calculateCutout ( $srcWidth, $srcHeight, $left, $top, $newWidth, $newHeight ) : array
Результат array

calculateSize() публичный статический метод

Calculates dimensions of resized image.
public static calculateSize ( $srcWidth, $srcHeight, $newWidth, $newHeight, $flags = self::FIT ) : array
Результат array

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

Fill image with custom/default arttributes
public fillImage ( LocalImage $image, array $attributes ) : LocalImage
$image LocalImage
$attributes array
Результат LocalImage

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

Find image
public find ( integer $id ) : LocalImage
$id integer
Результат LocalImage

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

Find images by a set of criteria
public findBy ( array $criteria, array $orderBy = null, integer $limit = 25, integer $offset ) : array
$criteria array
$orderBy array
$limit integer
$offset integer
Результат array

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

Find images by article
public findByArticle ( integer $articleNumber ) : array
$articleNumber integer
Результат array

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

Generate image for given src
public generateFromSrc ( string $src ) : void
$src string
Результат void

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

Get article image
public getArticleImage ( integer $articleNumber, integer $imageId ) : Newscoop\Image\ArticleImage
$articleNumber integer
$imageId integer
Результат Newscoop\Image\ArticleImage

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

Get article specific image caption
public getArticleImageCaption ( integer $imageId, integer $articleNumber, integer $languageId ) : string
$imageId integer
$articleNumber integer
$languageId integer
Результат string

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

Get count of article images
public getArticleImagesCount ( integer $articleNumber ) : integer
$articleNumber integer
Результат integer

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

Get image caption
public getCaption ( LocalImage $image, integer $articleNumber, integer $languageId ) : string
$image LocalImage
$articleNumber integer
$languageId integer
Результат string

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

Get count of images for a set of criteria
public getCountBy ( array $criteria ) : integer
$criteria array
Результат integer

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

Get default article image
public getDefaultArticleImage ( integer $articleNumber ) : Newscoop\Image\ArticleImage
$articleNumber integer
Результат Newscoop\Image\ArticleImage

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

Gets path of local images
public getImagePath ( ) : string
Результат string

getImagine() публичный статический метод

public static getImagine ( )

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

Get image src
public getSrc ( string $image, integer $width, integer $height, string $specs = 'fit' ) : string
$image string
$width integer
$height integer
$specs string
Результат string

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

Get thumbnail for given image and rendition
public getThumbnail ( Rendition $rendition, Newscoop\Image\ImageInterface $image ) : Newscoop\Image\Thumbnail
$rendition Rendition
$image Newscoop\Image\ImageInterface
Результат Newscoop\Image\Thumbnail

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

Get user image
public getUserImage ( User $user, integer $width = 65, integer $height = 65 ) : string
$user Newscoop\Entity\User
$width integer
$height integer
Результат string

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

Return true if the image is being used by an article.
public inUse ( LocalImage $image ) : boolean
$image LocalImage Local image
Результат boolean

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

Remove image (files and entity)
public remove ( LocalImage $image ) : boolean
$image LocalImage
Результат boolean

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

Remove image from article
public removeArticleImage ( ArticleImage $articleImage )
$articleImage ArticleImage

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

Save image
public save ( array $info ) : string
$info array
Результат string

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

Save article image
public saveArticleImage ( ArticleImage $articleImage, array $values ) : void
$articleImage ArticleImage
$values array
Результат void

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

Set default article image
public setDefaultArticleImage ( integer $articleNumber, ArticleImage $image ) : void
$articleNumber integer
$image ArticleImage
Результат void

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

Get thumbnail for given image
public thumbnail ( string $image, integer $width, integer $height, string $specs ) : mixed
$image string
$width integer
$height integer
$specs string
Результат mixed

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

Upload image and create entity
public upload ( Symfony\Component\HttpFoundation\File\UploadedFile $file, array $attributes, Newscoop\Image\ImageInterface $image = null, $keepRatio = true ) : LocalImage
$file Symfony\Component\HttpFoundation\File\UploadedFile
$attributes array
$image Newscoop\Image\ImageInterface
Результат LocalImage

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

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

protected $cacheService

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

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

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

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

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

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