Inheritance diagram for KWebItem_User:

Public Member Functions
	__construct ()
	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)
	canAccessByView ($view, $userId=null, $requestType=null)
	canDraft ($userId=null)
	Returns TRUE if this object may have draft/pending versions.
	getInfo ($lang=false)

	getTitle ($lang=false)
	getUserGroups ()
	isInGroup ($id)
	getUserAccessSignature ()
	Returns string with access signature.
	isUserAnonymous ()
	isUserCmdLine ()
	isUserLikeGroup ()
	True if the user is treated like a group - has own access tables and rights.
	isUserEditor ()
	buildObjectForm ($id, array $options=array())
	Builds the user input form for this object.
	getObjectContent ($lang=true, $receiver=null)
	Returns an KWebContent object describing contents of this item.
	storePostedFormData (KWebAttribute_Table_Form $form, array $data)
	Stores form's data in the object.
	setLogin ($login)
	setPassword ($pass)
	checkPassword ($pass)
	setEnabled ($enabled)
	isEnabled ()
	getAccessTable ($apply=AP_CURRENT, $userId=null)
	gotRight ($id)
	Sprawdza, czy użytkownik posiada wskazane uprawnienie.
	hasRight ($id)
	getProfileData ()
	Zwraca dane profilu użytkownika w postaci tablicy:
	setProfileData ($data)
	getProfileField ($name, $default=null)
	setProfileField ($name, $value)
	addProfileAddress ($id, $newAddr)
	getEmail ()
	setEmail ($email, $verified=false)
	getAvatar ()
	setAvatar ($path, $type=false, $lang=false)
	getPreviewFile ($lang=false)
	Returns path to the file, that can be used as an object's preview.
	isEmailVerified ()
	getEmailVerifyKey ()
	verifyEmail ($key)
	sendVerificationEmail ()
	getPassRemindKey ($salt= '')
	sendRemindPassEmail ($emailTemplate=false, $remindView=false)
	releaseObject ()
	Releases this object from memory cache and unsets some variables.
	getStructures ($filter=false, array $options=array())
	Returns specified structure objects, or all of them.
Static Public Member Functions
static	canAssignAsChild ($parent, $attrId=ATTR_ALL)
	Zwraca true, jeżeli można dopiąć ten typ do wskazanego elementu.
static	getClassAttributes (array $options=array())
	Returns attribute table for this class.
static	prepareSearch ($search)
static	isTranslateable ()
static	getUserByLogin ($login, $object=true)
static	getUserByEmail ($email, $object=true)
static	getUserByLoginEmail ($str, $object=true)
Data Fields
const	FIELD_EDIT_HTML_SHOW = 'edit_html_show'

Constructor & Destructor Documentation

KWebItem_User::__construct ( )

Reimplemented from KWebObject.

Reimplemented in KWebUserAnonymous.

Member Function Documentation

KWebItem_User::addProfileAddress	(	$	id,
		$	newAddr
	)

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

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

Reimplemented from KWebItem.

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

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

Reimplemented from KWebItem.

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

Reimplemented from KWebItem.

static KWebItem_User::canAssignAsChild	(	$	parent,
		$	attrId = `ATTR_ALL`
	)		`[static]`

Zwraca true, jeżeli można dopiąć ten typ do wskazanego elementu.

Reimplemented from KWebItem.

KWebItem_User::canDraft ( $ userId = null )

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

Reimplemented from KWebItem.

KWebItem_User::checkPassword ( $ pass )

KWebItem_User::getAccessTable	(	$	apply = `AP_CURRENT`,
		$	userId = `null`
	)

Reimplemented from KWebItem.

KWebItem_User::getAvatar ( )

Returns:: KWebPath

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

KWebItem_User::getEmail ( )

KWebItem_User::getEmailVerifyKey ( )

KWebItem_User::getInfo ( $ lang = false )

Reimplemented from KWebObject.

KWebItem_User::getItemPrinter ( )

Reimplemented from KWebItem.

KWebItem_User::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_User::getPassRemindKey ( $ salt = '' )

KWebItem_User::getPreviewFile ( $ lang = false )

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

Returns:: String

Reimplemented from KWebObject.

KWebItem_User::getProfileData ( )

Zwraca dane profilu użytkownika w postaci tablicy:

fname lname

billing => dane do faktury array() id name1 name2 street code city country taxid => identyfikator podatkowy (nip) address => adresy array() id name1 name2 street code city country

KWebItem_User::getProfileField	(	$	name,
		$	default = `null`
	)

KWebItem_User::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 from KWebItem.

KWebItem_User::getTitle ( $ lang = false )

Reimplemented from KWebItem.

KWebItem_User::getUserAccessSignature ( )

Returns string with access signature.

Users with same access rights will have the same signature

Returns:: multitype:

Reimplemented in KWebUserCmdLine, and KWebUserAnonymous.

static KWebItem_User::getUserByEmail	(	$	email,
		$	object = `true`
	)		`[static]`

static KWebItem_User::getUserByLogin	(	$	login,
		$	object = `true`
	)		`[static]`

static KWebItem_User::getUserByLoginEmail	(	$	str,
		$	object = `true`
	)		`[static]`

Returns:: KWebItem_User

KWebItem_User::getUserGroups ( )

Reimplemented in KWebUserCmdLine, and KWebUserAnonymous.

KWebItem_User::gotRight ( $ id )

Sprawdza, czy użytkownik posiada wskazane uprawnienie.

KWebItem_User::hasRight ( $ id )

See also:: gotRight

KWebItem_User::isEmailVerified ( )

KWebItem_User::isEnabled ( )

KWebItem_User::isInGroup ( $ id )

static KWebItem_User::isTranslateable ( ) [static]

Reimplemented from KWebObject_Translateable.

KWebItem_User::isUserAnonymous ( )

Reimplemented in KWebUserCmdLine, and KWebUserAnonymous.

KWebItem_User::isUserCmdLine ( )

KWebItem_User::isUserEditor ( )

Reimplemented in KWebUserCmdLine.

KWebItem_User::isUserLikeGroup ( )

True if the user is treated like a group - has own access tables and rights.

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

Parameters:

$search KWebSearch

Reimplemented from KWebItem.

KWebItem_User::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 from KWebItem.

KWebItem_User::sendRemindPassEmail	(	$	emailTemplate = `false`,
		$	remindView = `false`
	)

Parameters:

$emailTemplate	- inc file to use as an email template
$remindView	- view for the remind url

KWebItem_User::sendVerificationEmail ( )

KWebItem_User::setAvatar	(	$	path,
		$	type = `false`,
		$	lang = `false`
	)

KWebItem_User::setEmail	(	$	email,
		$	verified = `false`
	)

KWebItem_User::setEnabled ( $ enabled )

KWebItem_User::setLogin ( $ login )

KWebItem_User::setPassword ( $ pass )

KWebItem_User::setProfileData ( $ data )

KWebItem_User::setProfileField	(	$	name,
		$	value
	)

KWebItem_User::storePostedFormData	(	KWebAttribute_Table_Form $	form,
		array $	data
	)

Stores form's data in the object.

Data is in FORMAT_INTERNAL as (attr_id => value)

If data is missing in the table, it shouldn't be stored!

Returns:: TRUE if everything is ok... Any problems will break the storing process...

Reimplemented from KWebItem.

KWebItem_User::verifyEmail ( $ key )

Field Documentation

const KWebItem_User::FIELD_EDIT_HTML_SHOW = 'edit_html_show'

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

include/KWebItem/User.php

Public Member Functions

Static Public Member Functions

Data Fields

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation