Public Member Functions | Public Attributes | Protected Member Functions

BeEmbedMediaHelper Class Reference

Helper class to embed media contents. More...

Inheritance diagram for BeEmbedMediaHelper:
AppHelper

List of all members.

Public Member Functions

 getValidImplementations ()
 object ($obj, $params=null, $htmlAttributes=array())
 object public method: embed a generic bedita multimedia object return html for object $obj with options $params and html attributes $htmlAttributes

Public Attributes

 $helpers = array('Html', 'BeEmbedFlash', 'BeEmbedHtml5')

Protected Member Functions

 getMediaTypeImage ($obj)
 media type image return path for object type image if BACKEND_APP => try to find image in /webroot/img/iconset, then /webroot/img/

Detailed Description

Helper class to embed media contents.

Definition at line 25 of file be_embed_media.php.


Member Function Documentation

BeEmbedMediaHelper::getMediaTypeImage ( obj  )  [protected]

media type image return path for object type image if BACKEND_APP => try to find image in /webroot/img/iconset, then /webroot/img/

Parameters:
array $obj, object
Returns:
string, object type image

Definition at line 436 of file be_embed_media.php.

BeEmbedMediaHelper::object ( obj,
params = null,
htmlAttributes = array() 
)

object public method: embed a generic bedita multimedia object return html for object $obj with options $params and html attributes $htmlAttributes

Parameters:
array obj, BEdita Multimedia Object
array params, optional, parameters used by external libraries such as BeThumb->image possible value for params: 'presentation' => 'thumb', 'full', 'link' (default defined by $defaultPresentation attribute) 'URLonly' => if setted return only url

## USED only for image thumbnail on filesystem ## width, height, longside, at least one required, integer (if longside, w&h are ignored) mode, optional, 'crop'/'fill'/'croponly'/'stretch' modeparam, optional, depends on mode: if fill, string representing hex color, ie 'FFFFFF' if croponly, string describing crop zone 'C', 'T', 'B', 'L', 'R', 'TL', 'TR', 'BL', 'BR' if stretch, bool to allow upscale (default false) type, optional, 'gif'/'png'/'jpg', force image target type upscale, optional, bool, allow or not upscale

Parameters:
array htmlAttributes, html attributes
Returns:
string, output complete html tag

Definition at line 94 of file be_embed_media.php.


The documentation for this class was generated from the following file:
Generated on Fri Dec 11 2015 15:29:46 by Doxygen 1.7.1  BEditaBEdita 3.7 Corylus