XOOPS  2.6.0
Xoops\Core\Service\Contract\ThumbnailInterface Interface Reference
Inheritance diagram for Xoops\Core\Service\Contract\ThumbnailInterface:
Inheritance graph

Public Member Functions

 getImgTag (Response $response, $imgPath, $width=0, $height=0, $attributes=array())
 
 getImgUrl (Response $response, $imgPath, $width=0, $height=0)
 

Public Attributes

const MODE = \Xoops\Core\Service\Manager::MODE_EXCLUSIVE
 

Detailed Description

Definition at line 28 of file ThumbnailInterface.php.

Member Function Documentation

Xoops\Core\Service\Contract\ThumbnailInterface::getImgTag ( Response  $response,
  $imgPath,
  $width = 0,
  $height = 0,
  $attributes = array() 
)

getImgTag - get a full HTML img tag to display a thumbnail of the supplied image

Parameters
Response$responseobject
string$imgPathpath to image to be thumbed
integer$widthmaximum width of thumbnail in pixels, 0 to use default
integer$heightmaximum height of thumbnail in pixels, 0 to use default
array$attributesarray of attribute name => value pairs for img tag
Returns
void - response->value set to image tag

Implemented in ThumbsProvider.

Xoops\Core\Service\Contract\ThumbnailInterface::getImgUrl ( Response  $response,
  $imgPath,
  $width = 0,
  $height = 0 
)

getImgUrl - get URL to a thumbnail of the supplied image

Parameters
Response$responseobject
string$imgPathpath to image to be thumbed
integer$widthmaximum width of thumbnail in pixels, 0 to use default
integer$heightmaximum height of thumbnail in pixels, 0 to use default
Returns
void - response->value set to URL string

Implemented in ThumbsProvider.

Member Data Documentation

const Xoops\Core\Service\Contract\ThumbnailInterface::MODE = \Xoops\Core\Service\Manager::MODE_EXCLUSIVE

Definition at line 30 of file ThumbnailInterface.php.


The documentation for this interface was generated from the following file: