KWebItem_Image Class Reference

Inheritance diagram for KWebItem_Image:

Public Member Functions
	getItemPrinter ()
	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())
Static Public Member Functions
static	getClassAttributes (array $options=array())
	Returns attribute table for this class.

---

Member Function Documentation

static KWebItem_Image::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_File.

Reimplemented in KWebItem_MMedia.

KWebItem_Image::getImagePath

(

$

type = 'list'

)

Reimplemented in KWebItem_MMedia.

KWebItem_Image::getItemPrinter

(

)

Reimplemented from KWebItem_File.

Reimplemented in KWebItem_MMedia.

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

$imgPreview

ImgPreview instance, or instance name

Returns:

ImgPreviewResult

Reimplemented from KWebItem_File.

Reimplemented in KWebItem_MMedia.

KWebItem_Image::getPreviewFile

(

$

lang = false

)

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

Returns:

String

Reimplemented from KWebItem_File.

Reimplemented in KWebItem_MMedia.

---

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

• include/KWebItem/Image.php