KWeb  6.4
KWebItem_MMedia Class Reference
Inheritance diagram for KWebItem_MMedia:
KWebItem_Image KWebItem_File KWebItem KWebObject_Translateable KWebObject_Attributable KWebObject

Public Member Functions

 getItemPrinter ()
 getPreviewPath ($lang=false)
 getImagePath ($type= 'list')
 getPreviewFile ($lang=false)
 Returns path to the file, that can be used as an object's preview.
 getPreview ($imgPreview, array $options=array(), $lang=false)
 Generates preview for the object, using supplied $imgPreview object If the object doesnt support previews, it should return empty object (new ImgPreviewResult())
 getMediaParam ($name)
 getInfo ($lang=false)
 
 getEmbedType ($ext=false)
 getMediaType ($path=false)
 buildObjectForm ($id, array $options=array())
 Builds the user input form for this object.

Static Public Member Functions

static prepareSearch ($search)
static getClassAttributes (array $options=array())
 Returns attribute table for this class.

Member Function Documentation

KWebItem_MMedia::buildObjectForm ( id,
array $  options = array() 
)

Builds the user input form for this object.

Options specify the intent of the form (full edit, quick edit, quick add, and so on). Once build, the form should be attached to this object with setObjectForm().

By default, the form will be built automatically, using KWebAttribute form intents ($group and $forms)

Returns:
KWebAttribute_Table_Form

Reimplemented from KWebItem_File.

static KWebItem_MMedia::getClassAttributes ( array $  options = array()) [static]

Returns attribute table for this class.

Once created, the table should be stored in a static value. The table should be read only.

Options contain 'genre', 'type' and 'object' for which this attribute table is needed. However, the best practice is to always return always the same, static attribute table.

Overriding classes should be responsible to clone the table and it's attributes and modify them if needed.

Returns:
KWebAttribute_Table_Class

Reimplemented from KWebItem_Image.

KWebItem_MMedia::getEmbedType ( ext = false)
KWebItem_MMedia::getImagePath ( type = 'list')

Reimplemented from KWebItem_Image.

KWebItem_MMedia::getInfo ( lang = false)

Reimplemented from KWebObject.

KWebItem_MMedia::getItemPrinter ( )

Reimplemented from KWebItem_Image.

KWebItem_MMedia::getMediaParam ( name)
KWebItem_MMedia::getMediaType ( path = false)
KWebItem_MMedia::getPreview ( imgPreview,
array $  options = array(),
lang = false 
)

Generates preview for the object, using supplied $imgPreview object If the object doesnt support previews, it should return empty object (new ImgPreviewResult())

By default this function uses file returned by getPreviewFile() as a preview source

Parameters:
$imgPreviewImgPreview instance, or instance name
Returns:
ImgPreviewResult

Reimplemented from KWebItem_Image.

KWebItem_MMedia::getPreviewFile ( lang = false)

Returns path to the file, that can be used as an object's preview.

Returns:
String

Reimplemented from KWebItem_Image.

KWebItem_MMedia::getPreviewPath ( lang = false)
Returns:
KWebPath
static KWebItem_MMedia::prepareSearch ( search) [static]
Parameters:
$searchKWebSearch

Reimplemented from KWebItem_File.


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