XOOPS  2.6.0
ThumbsProvider Class Reference
Inheritance diagram for ThumbsProvider:
Inheritance graph

Public Member Functions

 getDescription ()
 
 getImgTag (Response $response, $imgPath, $width=0, $height=0, $attributes=array())
 
 getImgUrl (Response $response, $imgPath, $width=0, $height=0)
 
 getName ()
 
- Public Member Functions inherited from Xoops\Core\Service\AbstractContract
 getDescription ()
 
 getMode ()
 
 getName ()
 
 getPriority ()
 
 setPriority ($priority)
 

Protected Attributes

 $renderScript = 'modules/thumbs/include/thumbrender.php'
 
- Protected Attributes inherited from Xoops\Core\Service\AbstractContract
 $priority = Manager::PRIORITY_MEDIUM
 

Private Member Functions

 getThumbnailUrl ($imgPath, $width, $height)
 

Additional Inherited Members

- Public Attributes inherited from Xoops\Core\Service\Contract\ThumbnailInterface
const MODE = \Xoops\Core\Service\Manager::MODE_EXCLUSIVE
 

Detailed Description

Definition at line 27 of file ThumbsProvider.php.

Member Function Documentation

ThumbsProvider::getDescription ( )

getDescription - get human readable description of the service provider

Returns
string

Definition at line 48 of file ThumbsProvider.php.

ThumbsProvider::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

Implements Xoops\Core\Service\Contract\ThumbnailInterface.

Definition at line 115 of file ThumbsProvider.php.

References $height, $imgPath, $url, $width, getThumbnailUrl(), and Xoops\Core\Service\Response\setValue().

Here is the call graph for this function:

ThumbsProvider::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

Implements Xoops\Core\Service\Contract\ThumbnailInterface.

Definition at line 99 of file ThumbsProvider.php.

References $height, $imgPath, $width, getThumbnailUrl(), and Xoops\Core\Service\Response\setValue().

Here is the call graph for this function:

ThumbsProvider::getName ( )

getName - get a short name for this service provider. This should be unique within the scope of the named service, so using module dirname is suggested.

Returns
string - a unique name for the service provider

Definition at line 38 of file ThumbsProvider.php.

ThumbsProvider::getThumbnailUrl (   $imgPath,
  $width,
  $height 
)
private

getThumbnailUrl

Parameters
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
string URL to obtain QR Code image of $qrText

Definition at line 63 of file ThumbsProvider.php.

References $height, $helper, $imgPath, $thumbPath, $url, $width, $xoops, and Xoops\getInstance().

Referenced by getImgTag(), and getImgUrl().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

ThumbsProvider::$renderScript = 'modules/thumbs/include/thumbrender.php'
protected

Definition at line 30 of file ThumbsProvider.php.


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