KWebItem_File Class Reference

Inheritance diagram for KWebItem_File:

Public Member Functions
	getItemPrinter ()
	canAddChild ($type, $user=false, $attrId=ATTR_ALL)
	Zwraca true, jeżeli można dodać element o podanym typie...
	canAddLink ($item, $user=false, $attrId=ATTR_ALL)
	buildObjectForm ($id, array $options=array())
	Builds the user input form for this object.
	getObjectInfo ($name=false, $lang=false, $p=false)
	Zwraca informacje na temat obiektu.
	getObjectContent ($lang=true, $receiver=null)
	Returns an KWebContent object describing contents of this item.
	setHitCount ($count)
	hitDownloadCounter ()
	setFile ($path, $type=false, $lang=false)
	getFile ($lang=false)
	getFilePath ($lang=false)
	getFileUrl ($lang=false)
	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())
	getUrl ($view= '', $params=false, $lang=false, array $options=array())
	Returns URL for this object.
	getTitle ($lang=false)
	getHitCount ()
Static Public Member Functions
static	getClassAttributes (array $options=array())
	Returns attribute table for this class.
static	prepareSearch ($search)
Data Fields
	$file

---

Member Function Documentation

KWebItem_File::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.

Reimplemented in KWebItem_MMedia.

KWebItem_File::canAddChild	(	$	type,
		$	user = false,
		$	attrId = ATTR_ALL
	)

Zwraca true, jeżeli można dodać element o podanym typie...

Reimplemented from KWebItem.

KWebItem_File::canAddLink	(	$	item,
		$	user = false,
		$	attrId = ATTR_ALL
	)

Reimplemented from KWebItem.

static KWebItem_File::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.

Reimplemented in KWebItem_MMedia, and KWebItem_Image.

KWebItem_File::getFile

(

$

lang = false

)

Returns:

KWebPath

KWebItem_File::getFilePath

(

$

lang = false

)

KWebItem_File::getFileUrl

(

$

lang = false

)

KWebItem_File::getHitCount

(

)

KWebItem_File::getItemPrinter

(

)

Reimplemented from KWebItem.

Reimplemented in KWebItem_MMedia, and KWebItem_Image.

KWebItem_File::getObjectContent	(	$	lang = true,
		$	receiver = null
	)

Returns an KWebContent object describing contents of this item.

Parameters:

$lang	- Expected translation, false for current language or true for every translation
$receiver	- Object that is requesting this information (for example KWebSearch_Indexer)

Returns:

KWebContent

Reimplemented from KWebItem.

KWebItem_File::getObjectInfo	(	$	name = false,
		$	lang = false,
		$	param = false
	)

Zwraca informacje na temat obiektu.

Parameters:

$name

false - zwraca ogólną informację o obiekcie... Pozostałe wartości zależą od obiektu

Reimplemented from KWebItem.

KWebItem_File::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 KWebObject.

Reimplemented in KWebItem_MMedia, and KWebItem_Image.

KWebItem_File::getPreviewFile

(

$

lang = false

)

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

Returns:

String

Reimplemented from KWebObject.

Reimplemented in KWebItem_MMedia, and KWebItem_Image.

KWebItem_File::getTitle

(

$

lang = false

)

Reimplemented from KWebItem.

KWebItem_File::getUrl	(	$	view = '',
		$	params = false,
		$	lang = false,
		array $	options = array()
	)

Returns URL for this object.

Parameters:

$view	- View to use
$params	- List of url parameters. Parameters suffixed with '/' will be encoded in the name as: "/path/id,parameter-value.html"
$lang	- Language to use
$options	- List of additional options (KWeb::URL_*)

Returns:

string

Reimplemented from KWebItem.

KWebItem_File::hitDownloadCounter

(

)

static KWebItem_File::prepareSearch

(

$

search

)

[static]

Parameters:

$search

KWebSearch

Reimplemented from KWebItem.

Reimplemented in KWebItem_MMedia.

KWebItem_File::setFile	(	$	path,
		$	type = false,
		$	lang = false
	)

KWebItem_File::setHitCount

(

$

count

)

---

Field Documentation

KWebItem_File::$file

---

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

• include/KWebItem/File.php