Inheritance diagram for KWebObject:

Public Member Functions
	__construct ()
	__destruct ()
	getObjectProperties ($data=true, $cache=true, $temp=false)
	Returns object properties as an array.
	serialize ()
	unserialize ($serialized)
	initializeObjectProperties (array $data)
	Initializes object properties.
	initializeObjectData (array $data, $lang=false)
	Initializes object data using data mapping where necessary.
	error ($msg)
	logMsg ($type, $where, $msg, $dump= '')
	getClearData ($all=false)
	Zwraca parametr data z usuniętymi polami specjalnymi...
	getObjectCopy ($newData)
	isCurrentVersion ()
	Czy jest aktualnš wersjš?
	isPublishedAndAccessible ($byOpenedPath=false)
	Returns TRUE if this object is published and visible, and all its parent are also published and visible.
	isPublishedAndVisible ()
	Is it a published, visible and existing version of this object? Parent objects may still not be published.
	isPublished ()
	Is it published? (may be not visible!, use isPublishedAndVisible())
	isEditObject ()
	Czy jest obiektem edycyjnym?
	isDraft ()
	isPending ()
	isScheduled ()
	isVersion ()
	Czy jest wersjš innego elementu?
	isHidden ()
	Czy jest oznaczony jako niewidoczny?
	isRemoved ()
	Czy obiekt jest usunięty...
	isRemovedDefinitely ()
	Czy obiekt jest usunięty...
	isRemovedSelf ()
	Czy obiekt jest oznaczony jako usunięty...
	isRemovedByParent ()
	Czy obiekt jest usunięty dlatego bo usunięty został nadrzędny?.
	isRemoverObject ()
	Czy jest obiektem usuwajšcym?.
	isTemp ()
	Czy jest obiektem tymczasowym?.
	isNew ()
	Czy jest obiektem zupełnie nowym?.
	canView ($userId=null)
	Uniwersalne zapytanie, czy user może oglšdać ten element.
	canRemove ($userId=null)
	Uniwersalne zapytanie, czy user może usunšć ten element.
	canDraft ($userId=null)
	Returns TRUE if this object may have draft/pending versions.
	canPublish ($userId=null)
	Uniwersalne zapytanie, czy user może publikować ten element.
	canViewIfPublished ($userId=null)
	Sprawdza czy może oglšdać I czy obiekt jest opublikowany...
	canViewAsModerator ($userId=false)
	Sprawdza czy może oglšdać wszystkie edycyjne...
	canViewAsEditor ($userId=false)
	Sprawdza czy może oglšdać (opublikowane i własne edycyjne)
	canAccessByView ($view, $userId=null, $requestType=null)
	canBeSearched ($userId=false)
	canRSS ()
	getObjectOwner ($object=true)
	Zwraca id użytkownika.
	getParent ($object=true, $byOpenedPath=false)
	Returns parent of this object.
	getParents ($object=true, $byPath=false)
	Returns list of parent objects.
	getObjectId ()
	getObjectUID ()
	setObjectId ($newId)
	getObjectName ($lang=false)
	getObjectGenre ()
	getObjectType ()
	isSubtype ($type)
	getObjectTypename ()
	warmupObject ($lang=false, $cache=false, $force=false)
	Warms up object's data - ensures that everything that should be in $data is there.
	getObjectInfo ($name=false, $lang=false, $param=false)
	Zwraca informacje na temat obiektu.
	getObjectDebug ()
	getObjectIcon ($iconType)
	getAccessRights ($apply=null, $userId=null)
	Returns all access rights for this object as an integer.
	checkAccess ($right, $apply=null, $user=null)
	Returns TRUE if specified user has all specified access rights on this object.
	useObjectSynch ()
	getObjectStatus ($includeVirtual=true)
	Returns object's status as an unified string.
	getCSSClasses ()
	Returns a string with css classes, that define this object, like "status-published type-art genre-item".
	getObjectContent ($lang=true, $receiver=null)
	Returns an KWebContent object describing contents of this item.
	getPrinter ()
	Zwraca tablicę identyfikatorów wyświetlania.
	getTitle ()

	getSection ($object=true, $byOpenedPath=false)
	Zwraca sekcję do jakiej należy ten dokument, lub null .
	getInfo ($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())
	getRssDescription ($lang=false)
	getSearchDescription ($lang=false)
	getUrl ($view= '', $params=false, $lang=false, array $options=array())
	Returns URL for this object.
	printMe ($view= 'view/full', $viewVars=array(), $filePrefix= '', $skip=0, $checkExistence=false, $discoveryParams=array())
	Prints this object with the specified view (template found through discovery) Drukuje element w wybranym widoku.
	printMeNext ($var=null, $fullIteration=true, $checkExistence=false)
	Enter description here ...
	printInc ($inc, $vars=array(), $usePrefixes=true, $skip=0, array $discoveryParams=array(), $require=true)
	* Drukuje element przy pomocy wybranego inc'a
	printTemplateFile ($path, array $vars=array())
	getCachedObjectFilename ()

	saveCache ($force=false)
	Stores cached object if it was requested.
	resetCache ()
	Marks the cache to be reset at the end of script execution.
	updateCache ()
	Marks the cache as ready to be updated and at the end of script execution.
	commitUpdates ()
	Commits all pending updates to the data sources.
	releaseObject ()
	Releases this object from memory cache and unsets some variables.
	fetchObjectData ($lang=false)
	Zwraca dane z tabeli parametrow obiektu.
	clearObjectData ($lang=null, $keys=null)
	storeObjectData ($lang, $data)
	getObjectRating ($ratingGroup=null, $refreshCache=false)
	getStructure ($id=false, array $options=array())
	Returns specified structure object.
	getStructures ($filter=false, array $options=array())
	Returns specified structure objects, or all of them.
Static Public Member Functions
static	getClassInfo ()
	Returns information about this class.
static	clearData ($onData, $all)
static	resolveObjectName ($id, $params=false)
	Resolves the human readable name to internal id or an object.
static	fetchObjects ($ids, $params)
	Zwraca tablicę obiektów.
static	useObjectCache ()
static	getSqlPublishedVersion ($prefix=true)
	Zwraca zapytanie WHERE dla opublikowanych wersji .
static	getSqlJoinObjectData ($odPrefix= 'od', $genre=false, $idColumn=false, $langColumn=false)
static	prepareSearch ($search)
	Prepares for searching in SQL using KWebSearch and KWebSearch_Indexer_Sql Normally it should add queries with $search->addSqlQuery()
static	onObjectSwitchId ($genre, $oldId, $newId)
	Wywoływane, gdy jakiś obiekt zmieni swoje id.
static	onObjectSwitchType ($genre, $oldType, $newType)
Data Fields
	$data = array()
	Object's data - values read from eg.
	$cache = array()
	Object's cached data, calculated during execution (will be cached, may be emptied)
	$temp = array()
	Object's temporary data, will not be cached.
	$canCache = true
	$referenceCount = 0
	Keeping this value above 0 protects this object from being released.
const	PRINT_CHECK_ONLY = true
	printMe will only check if the template is available
const	PRINT_CHECK_THROW = false
	printMe will throw an exception if the template is not available
const	PRINT_CHECK_SILENT = null
	printMe will return false if the template is not available
const	EVENT_STRUCTURES = "kweb.object.structures"
	Called while preparing the list of structures.
const	EVENT_REMOVE_COMMIT = "kweb.object.remove_commit"
	Called when the object is removed from the database.
const	EVENT_REMOVE = "kweb.object.remove"
	Called when the object is marked for removal.
const	STRUCTUREOPT_FOREIGN = 'structure'
	Option for getStructures().
const	TEMP_IS_CREATING = '__creating'
	temp field meaning, that this object is being created
const	TEMP_IS_NEW = '__new'
	temp field meaning, that this object is new (it is not an edit object)
const	TEMP_IS_REMOVED = '__removed'
	temp field meaning, that this object will be removed from db
const	TEMP_IS_TRASHED = '__setremoved'
	temp field meaning, that this object is sent to trash (not removed!)
const	TEMP_RESET_CACHE = '__resetCache'
const	DATA_REQUESTED_ID = '__request_id'
	requested id
const	UPDATE_DELETE = '_DELETE'
Protected Attributes
	$_cacheDirty = false

Detailed Description

Glossary:

attribute - a definition of object's attribute
data - attribute values as name=>value pairs (eg. data from database)
property - a property of the object (eg. $obj->a)

Conventions:

data properties (read from the database, or created on the object) should:
- have the same name as the database column (recommended)
- be declared as public/protected object property, or stored in $data
data meant for caching (will be stored in the object's cache) should:
- be stored in $cache
- or declared as object property prefixed by '_', and set manually in getObjectProperties
data that is temporary should:
- be stored in $temp
- or declared as object property prefixed by '_'. You can, but don't have to set it manually in getObjectProperties

Constructor & Destructor Documentation

KWebObject::__construct ( )

Reimplemented in KWebUserAnonymous, KWebComment, KWebTask, KWebLink, KWebItem_User, KWebItem_Right, and KWebItem_Special.

KWebObject::__destruct ( )

Reimplemented in KWebUserCmdLine, and KWebUserAnonymous.

Member Function Documentation

KWebObject::canAccessByView	(	$	view,
		$	userId = `null`,
		$	requestType = `null`
	)

Reimplemented in KWebItem, and KWebItem_User.

KWebObject::canBeSearched ( $ userId = false )

Reimplemented in KWebItem, and KWebComment.

KWebObject::canDraft ( $ userId = null )

Returns TRUE if this object may have draft/pending versions.

Reimplemented in KWebItem, and KWebItem_User.

KWebObject::canPublish ( $ userId = null )

Uniwersalne zapytanie, czy user może publikować ten element.

Reimplemented in KWebItem, KWebComment, and KWebLink.

KWebObject::canRemove ( $ userId = null )

Uniwersalne zapytanie, czy user może usunšć ten element.

Reimplemented in KWebItem, KWebComment, KWebLink, and KWebTask.

KWebObject::canRSS ( )

Reimplemented in KWebItem, and KWebComment.

KWebObject::canView ( $ userId = null )

Uniwersalne zapytanie, czy user może oglšdać ten element.

Reimplemented in KWebItem, KWebComment, and KWebLink.

KWebObject::canViewAsEditor ( $ userId = false )

Sprawdza czy może oglšdać (opublikowane i własne edycyjne)

KWebObject::canViewAsModerator ( $ userId = false )

Sprawdza czy może oglšdać wszystkie edycyjne...

KWebObject::canViewIfPublished ( $ userId = null )

Sprawdza czy może oglšdać I czy obiekt jest opublikowany...

KWebObject::checkAccess	(	$	right,
		$	apply = `null`,
		$	user = `null`
	)

Returns TRUE if specified user has all specified access rights on this object.

Reimplemented in KWebItem, and KWebLink.

static KWebObject::clearData	(	$	onData,
		$	all
	)		`[static]`

KWebObject::clearObjectData	(	$	lang = `null`,
		$	keys = `null`
	)

KWebObject::commitUpdates ( )

Commits all pending updates to the data sources.

Reimplemented in KWebItem, KWebLink, KWebComment, KWebObject_Attributable, and KWebTask.

KWebObject::error ( $ msg )

Reimplemented in KWebItem, and KWebLink.

KWebObject::fetchObjectData ( $ lang = false )

Zwraca dane z tabeli parametrow obiektu.

Parameters:

$lang = konkretny język, lub null do zwrócenia wszystkich

static KWebObject::fetchObjects	(	$	ids,
		$	params
	)		`[static]`

Zwraca tablicę obiektów.

Reimplemented in KWebItem, KWebTask, KWebLink, and KWebGenre_Comment.

KWebObject::getAccessRights	(	$	apply = `null`,
		$	userId = `null`
	)

Returns all access rights for this object as an integer.

Every access right is a flag

Reimplemented in KWebItem, and KWebComment.

KWebObject::getCachedObjectFilename ( )

static KWebObject::getClassInfo ( ) [static]

Returns information about this class.

genre type name icon

Returns:: array

Reimplemented in KWebItem_NewsLetterGenerator, KWebItem_NewsLetter, and KWebItem_NewsList.

KWebObject::getClearData ( $ all = false )

Zwraca parametr data z usuniętymi polami specjalnymi...

Usuwa wszystkie pola zaczynajšce się od __

Reimplemented in KWebItem, and KWebLink.

KWebObject::getCSSClasses ( )

Returns a string with css classes, that define this object, like "status-published type-art genre-item".

KWebObject::getInfo ( $ lang = false )

Reimplemented in KWebComment, KWebItem_MMedia, KWebItem_Special, KWebItem_User, KWebItem_Right, KWebItem_Group, and KWebItemInfo.

KWebObject::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 in KWebItem, KWebItem_User, KWebItem_File, and KWebItem_Art.

KWebObject::getObjectCopy ( $ newData )

Returns:: KWebObject

Reimplemented in KWebItem, KWebComment, and KWebLink.

KWebObject::getObjectDebug ( )

Reimplemented in KWebItem, KWebComment, and KWebLink.

KWebObject::getObjectGenre ( )

Reimplemented in KWebItem, KWebLink, KWebComment, KWebTask, and KWebGenre_Comment.

KWebObject::getObjectIcon ( $ iconType )

KWebObject::getObjectId ( )

Reimplemented in KWebItem, KWebComment, KWebLink, KWebTask, and KWebGenre_Comment.

KWebObject::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 in KWebItem, and KWebItem_File.

KWebObject::getObjectName ( $ lang = false )

Reimplemented in KWebItem.

KWebObject::getObjectOwner ( $ object = true )

Zwraca id użytkownika.

Returns:: KWebItem_User

Reimplemented in KWebItem, KWebComment, and KWebLink.

KWebObject::getObjectProperties	(	$	data = `true`,
		$	cache = `true`,
		$	temp = `false`
	)

Returns object properties as an array.

Returns:: array

Reimplemented in KWebComment, KWebItem, KWebObject_Attributable, and KWebObject_Translateable.

KWebObject::getObjectRating	(	$	ratingGroup = `null`,
		$	refreshCache = `false`
	)

Returns:: KWebRating_Entry

KWebObject::getObjectStatus ( $ includeVirtual = true )

Returns object's status as an unified string.

Parameters:

$includeVirtual If TRUE, virtual statuses like "temp", "hidden" or "hiddenbranch" will be incuded

KWebObject::getObjectType ( )

Reimplemented in KWebItem, KWebLink, KWebComment, KWebTask, and KWebGenre.

KWebObject::getObjectTypename ( )

KWebObject::getObjectUID ( )

KWebObject::getParent	(	$	object = `true`,
		$	byOpenedPath = `false`
	)

Returns parent of this object.

Parameters:

$byPath - you can specify a branch to use, if the object is available in many branches. If TRUE, an opened branch will be used

Returns:: KWebObject

Reimplemented in KWebItem, KWebComment, and KWebLink.

KWebObject::getParents	(	$	object = `true`,
		$	byPath = `false`
	)

Returns list of parent objects.

Parameters:

$byPath - you can specify a branch to use, if the object is available in many branches. If TRUE, an opened branch will be used

Returns:: array

Reimplemented in KWebItem.

KWebObject::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 in KWebLink, KWebItem_File, KWebItem_MMedia, and KWebItem_Image.

KWebObject::getPreviewFile ( $ lang = false )

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

Returns:: String

Reimplemented in KWebItem_User, KWebLink, KWebItem_File, KWebItem_MMedia, and KWebItem_Image.

KWebObject::getPrinter ( )

Zwraca tablicę identyfikatorów wyświetlania.

Wg. tej listy wyszukiwane są szablony w widokach - od ostatniego do pierwszego... Dla typów spoza rodzaju "item" identyfikatory powinny zawierać nazwę rodzaju aby nie wchodzić w konflikt z identyfikatorami z item.

Reimplemented in KWebItem, KWebComment, KWebLink, and KWebTask.

KWebObject::getRssDescription ( $ lang = false )

KWebObject::getSearchDescription ( $ lang = false )

KWebObject::getSection	(	$	object = `true`,
		$	byOpenedPath = `false`
	)

Zwraca sekcję do jakiej należy ten dokument, lub null .

Returns:: KWebSection

Reimplemented in KWebItem.

static KWebObject::getSqlJoinObjectData	(	$	odPrefix = `'od'`,
		$	genre = `false`,
		$	idColumn = `false`,
		$	langColumn = `false`
	)		`[static]`

Reimplemented in KWebItem.

static KWebObject::getSqlPublishedVersion ( $ prefix = true ) [static]

Zwraca zapytanie WHERE dla opublikowanych wersji .

Parameters:

prefix Przedrostek nazwy tablicy - np. 's.' - dodawany do pól w zapytaniu

Reimplemented in KWebLink.

KWebObject::getStructure	(	$	id = `false`,
		array $	options = `array()`
	)

Returns specified structure object.

Returns:: KWebStructure_Interface

KWebObject::getStructures	(	$	filter = `false`,
		array $	options = `array()`
	)

Returns specified structure objects, or all of them.

Parameters:

$filter - array of structure ids, or false for every one of them

Returns:: array of KWebStructure_Interface

Reimplemented in KWebItem, KWebItem_User, KWebGenre_Comment, and KWebComment.

KWebObject::getTitle ( )

Reimplemented in KWebLink, and KWebGenre_Comment.

KWebObject::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 in KWebItem, KWebItem_File, and KWebItem_Redirect.

KWebObject::initializeObjectData	(	array $	data,
		$	lang = `false`
	)

Initializes object data using data mapping where necessary.

Parameters:

$data	Object's data as $name => $value
$lang	Translation language or false for main data

Reimplemented in KWebComment, KWebItem, and KWebObject_Translateable.

KWebObject::initializeObjectProperties ( array $ data )

Initializes object properties.

Properties are usually mapped 1-to-1 with object's properties

Reimplemented in KWebItem_NewsLetterGenerator, and KWebItem_NewsLetter.

KWebObject::isCurrentVersion ( )

Czy jest aktualnš wersjš?

KWebObject::isDraft ( )

Reimplemented in KWebItem, and KWebLink.

KWebObject::isEditObject ( )

Czy jest obiektem edycyjnym?

KWebObject::isHidden ( )

Czy jest oznaczony jako niewidoczny?

KWebObject::isNew ( )

Czy jest obiektem zupełnie nowym?.

Reimplemented in KWebLink, KWebTask, and KWebObject_Attributable.

KWebObject::isPending ( )

Reimplemented in KWebItem, KWebComment, and KWebLink.

KWebObject::isPublished ( )

Is it published? (may be not visible!, use isPublishedAndVisible())

KWebObject::isPublishedAndAccessible ( $ byOpenedPath = false )

Returns TRUE if this object is published and visible, and all its parent are also published and visible.

Parameters:

$byOpenedPath - checks parents by currently opened path (default FALSE)

KWebObject::isPublishedAndVisible ( )

Is it a published, visible and existing version of this object? Parent objects may still not be published.

Use isPublishedAndAccessible() instead

KWebObject::isRemoved ( )

Czy obiekt jest usunięty...

Reimplemented in KWebItem, and KWebLink.

KWebObject::isRemovedByParent ( )

Czy obiekt jest usunięty dlatego bo usunięty został nadrzędny?.

Reimplemented in KWebItem.

KWebObject::isRemovedDefinitely ( )

Czy obiekt jest usunięty...

Reimplemented in KWebItem.

KWebObject::isRemovedSelf ( )

Czy obiekt jest oznaczony jako usunięty...

Reimplemented in KWebItem, and KWebLink.

KWebObject::isRemoverObject ( )

Czy jest obiektem usuwajšcym?.

Reimplemented in KWebItem, and KWebLink.

KWebObject::isScheduled ( )

Reimplemented in KWebItem.

KWebObject::isSubtype ( $ type )

KWebObject::isTemp ( )

Czy jest obiektem tymczasowym?.

Reimplemented in KWebLink, and KWebGenre.

KWebObject::isVersion ( )

Czy jest wersjš innego elementu?

KWebObject::logMsg	(	$	type,
		$	where,
		$	msg,
		$	dump = `''`
	)

Reimplemented in KWebItem, and KWebLink.

static KWebObject::onObjectSwitchId	(	$	genre,
		$	oldId,
		$	newId
	)		`[static]`

Wywoływane, gdy jakiś obiekt zmieni swoje id.

Reimplemented in KWebItem, KWebComment, and KWebTask.

static KWebObject::onObjectSwitchType	(	$	genre,
		$	oldType,
		$	newType
	)		`[static]`

static KWebObject::prepareSearch ( $ search ) [static]

Prepares for searching in SQL using KWebSearch and KWebSearch_Indexer_Sql Normally it should add queries with $search->addSqlQuery()

Parameters:

KWebSearch $search

Reimplemented in KWebItem, KWebComment, KWebItem_User, KWebItem_MMedia, KWebItem_File, KWebItem_Download, KWebItem_NewsLetter, KWebItem_Art, and KWebItem_Dir.

KWebObject::printInc	(	$	inc,
		$	vars = `array()`,
		$	usePrefixes = `true`,
		$	skip = `0`,
		array $	discoveryParams = `array()`,
		$	require = `true`
	)

* Drukuje element przy pomocy wybranego inc'a

KWebObject::printMe	(	$	view = `'view/full'`,
		$	viewVars = `array()`,
		$	filePrefix = `''`,
		$	skip = `0`,
		$	checkExistence = `false`,
		$	discoveryParams = `array()`
	)

Prints this object with the specified view (template found through discovery) Drukuje element w wybranym widoku.

Parameters:

$lvar	Opcje - returnOutput
$checkExistence	- any of the PRINT_CHECK_* constants

KWebObject::printMeNext	(	$	var = `null`,
		$	fullIteration = `true`,
		$	checkExistence = `false`
	)

Enter description here ...

Parameters:

unknown_type	$var
boolean	$fullIteration	TRUE if shadowed files should be skipped. If current file is in /local/ it will skip the same file in /kweb/

KWebObject::printTemplateFile	(	$	path,
		array $	vars = `array()`
	)

KWebObject::releaseObject ( )

Releases this object from memory cache and unsets some variables.

After using this function the object becomes unusable! Should be used with caution! Objects with pending changes, cache resets etc won't be released.

Returns:: boolean TRUE on success

Reimplemented in KWebItem, and KWebItem_User.

KWebObject::resetCache ( )

Marks the cache to be reset at the end of script execution.

static KWebObject::resolveObjectName	(	$	id,
		$	params = `false`
	)		`[static]`

Resolves the human readable name to internal id or an object.

If object is returned, it should be also registered with KWebCache::storeObjectCache, otherwise it may be asked again...

It's up to the implementation how to handle this...

Parameters:

unknown_type	$id
unknown_type	$params

Returns:: unknown

Reimplemented in KWebItem, and KWebGenre_Comment.

KWebObject::saveCache ( $ force = false )

Stores cached object if it was requested.

KWebObject::serialize ( )

KWebObject::setObjectId ( $ newId )

Reimplemented in KWebItem, and KWebComment.

KWebObject::storeObjectData	(	$	lang,
		$	data
	)

KWebObject::unserialize ( $ serialized )

KWebObject::updateCache ( )

Marks the cache as ready to be updated and at the end of script execution.

static KWebObject::useObjectCache ( ) [static]

Reimplemented in KWebComment, and KWebTask.

KWebObject::useObjectSynch ( )

Reimplemented in KWebItem, KWebComment, and KWebTask.

KWebObject::warmupObject	(	$	lang = `false`,
		$	cache = `false`,
		$	force = `false`
	)

Warms up object's data - ensures that everything that should be in $data is there.

Parameters:

$lang	- FALSE for every language, or specific language to warm up
$cache	- should additional information be cached?
$force	- normally, warmup should work only once, TRUE will force it again

Reimplemented in KWebObject_Attributable.

Field Documentation

KWebObject::$_cacheDirty = false [protected]

KWebObject::$cache = array()

Object's cached data, calculated during execution (will be cached, may be emptied)

KWebObject::$canCache = true

KWebObject::$data = array()

Object's data - values read from eg.

database

KWebObject::$referenceCount = 0

Keeping this value above 0 protects this object from being released.

KWebObject::$temp = array()

Object's temporary data, will not be cached.

const KWebObject::DATA_REQUESTED_ID = '__request_id'

requested id

const KWebObject::EVENT_REMOVE = "kweb.object.remove"

Called when the object is marked for removal.

const KWebObject::EVENT_REMOVE_COMMIT = "kweb.object.remove_commit"

Called when the object is removed from the database.

const KWebObject::EVENT_STRUCTURES = "kweb.object.structures"

Called while preparing the list of structures.

Parameters: filter - return only matching structures, or everything if false options - options for matching list - list of structures (id => KWebStructure_Interface)

const KWebObject::PRINT_CHECK_ONLY = true

printMe will only check if the template is available

const KWebObject::PRINT_CHECK_SILENT = null

printMe will return false if the template is not available

const KWebObject::PRINT_CHECK_THROW = false

printMe will throw an exception if the template is not available

const KWebObject::STRUCTUREOPT_FOREIGN = 'structure'

Option for getStructures().

Foreign KWebStructure_Interface object that is asking for this structure. This option should be used when asking for KWebStructure::ID_FOREIGN

const KWebObject::TEMP_IS_CREATING = '__creating'

temp field meaning, that this object is being created

const KWebObject::TEMP_IS_NEW = '__new'