Documentation TYPO3 par Ameos

Disponible dans d'autres versions de TYPO3 -> 3.7.0  3.8.1  4.0.0  4.0.1  4.1.0   <- Available in other TYPO3 versions

t3lib_userAuthGroup Class Reference

Inheritance diagram for t3lib_userAuthGroup:[legend]Collaboration diagram for t3lib_userAuthGroup:[legend]List of all members.

Public Member Functions
	isAdmin ()
	isMemberOfGroup ($groupId)
	doesUserHaveAccess ($row, $perms)
	isInWebMount ($id, $readPerms='', $exitOnError=0)
	modAccess ($conf, $exitOnError)
	getPagePermsClause ($perms)
	calcPerms ($row)
	isRTE ()
	check ($type, $value)
	checkAuthMode ($table, $field, $value, $authMode)
	checkLanguageAccess ($langValue)
	recordEditAccessInternals ($table, $idOrRow, $newRecord=FALSE)
	isPSet ($lCP, $table, $type='')
	mayMakeShortcut ()
	workspaceCannotEditRecord ($table, $recData)
	workspaceCannotEditOfflineVersion ($table, $recData)
	workspaceAllowLiveRecordsInPID ($pid, $table)
	workspaceCreateNewRecord ($pid, $table)
	workspaceAllowAutoCreation ($table, $id, $recpid)
	workspaceCheckStageForCurrent ($stage)
	workspacePublishAccess ($wsid)
	workspaceSwapAccess ()
	workspaceVersioningTypeAccess ($type)
	workspaceVersioningTypeGetClosest ($type)
	getTSConfig ($objectString, $config='')
	getTSConfigVal ($objectString)
	getTSConfigProp ($objectString)
	inList ($in_list, $item)
	returnWebmounts ()
	returnFilemounts ()
	jsConfirmation ($bitmask)
	fetchGroupData ()
	fetchGroups ($grList, $idList='')
	setCachedList ($cList)
	addFileMount ($title, $altTitle, $path, $webspace, $type)
	addTScomment ($str)
	workspaceInit ()
	checkWorkspace ($wsRec, $fields='uid, title, adminusers, members, reviewers, publish_access, stagechg_notification')
	checkWorkspaceCurrent ()
	setWorkspace ($workspaceId)
	setWorkspacePreview ($previewState)
	getDefaultWorkspace ()
	writelog ($type, $action, $error, $details_nr, $details, $data, $tablename='', $recuid='', $recpid='', $event_pid=-1, $NEWid='', $userId=0)
	simplelog ($message, $extKey='', $error=0)
	checkLogFailures ($email, $secondsBack=3600, $max=3)
Public Attributes
	$usergroup_column = 'usergroup'
	$usergroup_table = 'be_groups'
	$groupData
	$workspace = -99
	$workspaceRec = array()
	$userGroups = Array()
	$userGroupsUID = Array()
	$groupList = ''
	$dataLists
	$includeHierarchy = array()
	$includeGroupArray = array()
	$OS = ''
	$TSdataArray = array()
	$userTS_text = ''
	$userTS = array()
	$userTSUpdated = 0
	$userTS_dontGetCached = 0
	$RTE_errors = array()
	$errorMsg = ''
	$checkWorkspaceCurrent_cache = NULL

---

Detailed Description

Definition at line 135 of file class.t3lib_userauthgroup.php.

---

Member Function Documentation

t3lib_userAuthGroup::isAdmin

(

)

Returns true if user is admin Basically this function evaluates if the ->user[admin] field has bit 0 set. If so, user is admin.

Returns:

boolean

Definition at line 199 of file class.t3lib_userauthgroup.php.

Referenced by t3lib_beUserAuth::backendCheckLogin(), t3lib_tsfeBeUserAuth::checkBackendAccessSettingsFromInitPhp(), t3lib_beUserAuth::checkCLIuser(), t3lib_beUserAuth::emailAtLogin(), local_beUserAuth::ext_printOverview(), getPagePermsClause(), isInWebMount(), and modAccess().

t3lib_userAuthGroup::isMemberOfGroup

(

$

groupId

)

Returns true if the current user is a member of group $groupId $groupId must be set. $this->groupList must contain groups Will return true also if the user is a member of a group through subgroups.

Parameters:

integer

Group ID to look for in $this->groupList

Returns:

boolean

Definition at line 211 of file class.t3lib_userauthgroup.php.

References inList().

t3lib_userAuthGroup::doesUserHaveAccess	(	$	row,
		$	perms
	)

Checks if the permissions is granted based on a page-record ($row) and $perms (binary and'ed)

Bits for permissions, see $perms variable:

1 - Show: See/Copy page and the pagecontent. 16- Edit pagecontent: Change/Add/Delete/Move pagecontent. 2- Edit page: Change/Move the page, eg. change title, startdate, hidden. 4- Delete page: Delete the page and pagecontent. 8- New pages: Create new pages under the page.

Parameters:

	array	$row is the pagerow for which the permissions is checked
	integer	$perms is the binary representation of the permission we are going to check. Every bit in this number represents a permission that must be set. See function explanation.

Returns:

boolean True or False upon evaluation

Definition at line 233 of file class.t3lib_userauthgroup.php.

References calcPerms().

Referenced by t3lib_tsfeBeUserAuth::extPageReadAccess().

t3lib_userAuthGroup::isInWebMount	(	$	id,
		$	readPerms = '',
		$	exitOnError = 0
	)

Checks if the page id, $id, is found within the webmounts set up for the user. This should ALWAYS be checked for any page id a user works with, whether it's about reading, writing or whatever. The point is that this will add the security that a user can NEVER touch parts outside his mounted pages in the page tree. This is otherwise possible if the raw page permissions allows for it. So this security check just makes it easier to make safe user configurations. If the user is admin OR if this feature is disabled (fx. by setting TYPO3_CONF_VARS['BE']['lockBeUserToDBmounts']=0) then it returns "1" right away Otherwise the function will return the uid of the webmount which was first found in the rootline of the input page $id

Parameters:

	integer	Page ID to check
	string	Content of "->getPagePermsClause(1)" (read-permissions). If not set, they will be internally calculated (but if you have the correct value right away you can save that database lookup!)
	boolean	If set, then the function will exit with an error message.

Returns:

integer The page UID of a page in the rootline that matched a mount point

Definition at line 250 of file class.t3lib_userauthgroup.php.

References t3lib_userAuth::$id, t3lib_BEfunc::BEgetRootLine(), getPagePermsClause(), isAdmin(), returnWebmounts(), and t3lib_BEfunc::typo3PrintError().

Referenced by local_beUserAuth::ext_workspaceMembership(), and t3lib_tsfeBeUserAuth::extPageReadAccess().

t3lib_userAuthGroup::modAccess	(	$	conf,
		$	exitOnError
	)

Checks access to a backend module with the $MCONF passed as first argument

Parameters:

	array	$MCONF array of a backend module!
	boolean	If set, an array will issue an error message and exit.

Returns:

boolean Will return true if $MCONF['access'] is not set at all, if the BE_USER is admin or if the module is enabled in the be_users/be_groups records of the user (specifically enabled). Will return false if the module name is not even found in $TBE_MODULES

Definition at line 284 of file class.t3lib_userauthgroup.php.

References check(), t3lib_div::inList(), isAdmin(), t3lib_BEfunc::isModuleSetInTBE_MODULES(), and t3lib_BEfunc::typo3PrintError().

t3lib_userAuthGroup::getPagePermsClause

(

$

perms

)

Returns a WHERE-clause for the pages-table where user permissions according to input argument, $perms, is validated. $perms is the "mask" used to select. Fx. if $perms is 1 then you'll get all pages that a user can actually see! 2^0 = show (1) 2^1 = edit (2) 2^2 = delete (4) 2^3 = new (8) If the user is 'admin' " 1=1" is returned (no effect) If the user is not set at all (->user is not an array), then " 1=0" is returned (will cause no selection results at all) The 95% use of this function is "->getPagePermsClause(1)" which will return WHERE clauses for *selecting* pages in backend listings - in other words this will check read permissions.

Parameters:

integer

Permission mask to use, see function description

Returns:

string Part of where clause. Prefix " AND " to this.

Definition at line 335 of file class.t3lib_userauthgroup.php.

References t3lib_div::callUserFunction(), and isAdmin().

Referenced by t3lib_tsfeBeUserAuth::extGetCategory_cache(), t3lib_tsfeBeUserAuth::extGetCategory_publish(), t3lib_tsfeBeUserAuth::extSaveFeAdminConfig(), isInWebMount(), and local_beUserAuth::returnWebmounts().

t3lib_userAuthGroup::calcPerms

(

$

row

)

Returns a combined binary representation of the current users permissions for the page-record, $row. The perms for user, group and everybody is OR'ed together (provided that the page-owner is the user and for the groups that the user is a member of the group If the user is admin, 31 is returned (full permissions for all five flags)

Parameters:

array

Input page row with all perms_* fields available.

Returns:

integer Bitwise representation of the users permissions in relation to input page row, $row

Definition at line 376 of file class.t3lib_userauthgroup.php.

References t3lib_div::callUserFunction().

Referenced by doesUserHaveAccess().

t3lib_userAuthGroup::isRTE

(

)

Returns true if the RTE (Rich Text Editor) can be enabled for the user Strictly this is not permissions being checked but rather a series of settings like a loaded extension, browser/client type and a configuration option in ->uc[edit_RTE] The reasons for a FALSE return can be found in $this->RTE_errors

Returns:

boolean

Definition at line 414 of file class.t3lib_userauthgroup.php.

References t3lib_BEfunc::RTEgetObj().

t3lib_userAuthGroup::check	(	$	type,
		$	value
	)

Returns true if the $value is found in the list in a $this->groupData[] index pointed to by $type (array key). Can thus be users to check for modules, exclude-fields, select/modify permissions for tables etc. If user is admin true is also returned Please see the document Inside TYPO3 for examples.

Parameters:

	string	The type value; "webmounts", "filemounts", "pagetypes_select", "tables_select", "tables_modify", "non_exclude_fields", "modules"
	string	String to search for in the groupData-list

Returns:

boolean True if permission is granted (that is, the value was found in the groupData list - or the BE_USER is "admin")

Definition at line 448 of file class.t3lib_userauthgroup.php.

Referenced by t3lib_tsfeBeUserAuth::ext_makeToolBar(), and modAccess().

t3lib_userAuthGroup::checkAuthMode	(	$	table,
		$	field,
		$	value,
		$	authMode
	)

Checking the authMode of a select field with authMode set

Parameters:

	string	Table name
	string	Field name (must be configured in TCA and of type "select" with authMode set!)
	string	Value to evaluation (single value, must not contain any of the chars ":,|")
	string	Auth mode keyword (explicitAllow, explicitDeny, individual)

Returns:

boolean True or false whether access is granted or not.

Definition at line 465 of file class.t3lib_userauthgroup.php.

References t3lib_div::loadTCA().

t3lib_userAuthGroup::checkLanguageAccess

(

$

langValue

)

Checking if a language value (-1, 0 and >0 for sys_language records) is allowed to be edited by the user.

Parameters:

integer

Language value to evaluate

Returns:

boolean Returns true if the language value is allowed, otherwise false.

Definition at line 531 of file class.t3lib_userauthgroup.php.

t3lib_userAuthGroup::recordEditAccessInternals	(	$	table,
		$	idOrRow,
		$	newRecord = FALSE
	)

Checking if a user has editing access to a record from a $TCA table. The checks does not take page permissions and other "environmental" things into account. It only deal with record internals; If any values in the record fields disallows it. For instance languages settings, authMode selector boxes are evaluated (and maybe more in the future). It will check for workspace dependent access. The function takes an ID (integer) or row (array) as second argument.

Parameters:

	string	Table name
	mixed	If integer, then this is the ID of the record. If Array this just represents fields in the record.
	boolean	Set, if testing a new (non-existing) record array. Will disable certain checks that doesn't make much sense in that context.

Returns:

boolean True if OK, otherwise false

Definition at line 553 of file class.t3lib_userauthgroup.php.

References t3lib_BEfunc::getRecord(), and t3lib_div::loadTCA().

t3lib_userAuthGroup::isPSet	(	$	lCP,
		$	table,
		$	type = ''
	)

Will check a type of permission against the compiled permission integer, $lCP, and in relation to table, $table

Parameters:

	integer	$lCP could typically be the "compiled permissions" integer returned by ->calcPerms
	string	$table is the tablename to check: If "pages" table then edit,new,delete and editcontent permissions can be checked. Other tables will be checked for "editcontent" only (and $type will be ignored)
	string	For $table='pages' this can be 'edit' (2), 'new' (8 or 16), 'delete' (4), 'editcontent' (16). For all other tables this is ignored. (16 is used)

Returns:

boolean private

Definition at line 628 of file class.t3lib_userauthgroup.php.

t3lib_userAuthGroup::mayMakeShortcut

(

)

Returns true if the BE_USER is allowed to *create* shortcuts in the backend modules

Returns:

boolean

Definition at line 645 of file class.t3lib_userauthgroup.php.

t3lib_userAuthGroup::workspaceCannotEditRecord	(	$	table,
		$	recData
	)

Checking if editing of an existing record is allowed in current workspace if that is offline. Rules for editing in offline mode:

• record supports versioning and is an offline version from workspace and has the corrent stage
• or record (any) is in a branch where there is a page which is a version from the workspace and where the stage is not preventing records

Parameters:

	string	Table of record
	array	Integer (record uid) or array where fields are at least: pid, t3ver_wsid, t3ver_stage (if versioningWS is set)

Returns:

string String error code, telling the failure state. FALSE=All ok

Definition at line 659 of file class.t3lib_userauthgroup.php.

References t3lib_BEfunc::getRecord().

t3lib_userAuthGroup::workspaceCannotEditOfflineVersion	(	$	table,
		$	recData
	)

Evaluates if a user is allowed to edit the offline version

Parameters:

	string	Table of record
	array	Integer (record uid) or array where fields are at least: pid, t3ver_wsid, t3ver_stage (if versioningWS is set)

Returns:

string String error code, telling the failure state. FALSE=All ok

See also:

workspaceCannotEditRecord()

Definition at line 698 of file class.t3lib_userauthgroup.php.

References t3lib_BEfunc::getRecord().

t3lib_userAuthGroup::workspaceAllowLiveRecordsInPID	(	$	pid,
		$	table
	)

Check if "live" records from $table may be created or edited in this PID. If the answer is FALSE it means the only valid way to create or edit records in the PID is by versioning If the answer is 1 or 2 it means it is OK to create a record, if -1 it means that it is OK in terms of versioning because the element was within a versionized branch but NOT ok in terms of the state the root point had!

Parameters:

	integer	PID value to check for.
	string	Table name

Returns:

mixed Returns FALSE if a live record cannot be created and must be versionized in order to do so. 2 means a) Workspace is "Live" or workspace allows "live edit" of records from non-versionized tables (and the $table is not versionizable). 1 and -1 means the pid is inside a versionized branch where -1 means that the branch-point did NOT allow a new record according to its state.

Definition at line 721 of file class.t3lib_userauthgroup.php.

References t3lib_BEfunc::isPidInVersionizedBranch().

t3lib_userAuthGroup::workspaceCreateNewRecord	(	$	pid,
		$	table
	)

Evaluates if a record from $table can be created in $pid

Parameters:

	integer	Page id. This value must be the _ORIG_uid if available: So when you have pages versionized as "page" or "element" you must supply the id of the page version in the workspace!
	string	Table name

Returns:

boolean TRUE if OK.

Definition at line 742 of file class.t3lib_userauthgroup.php.

t3lib_userAuthGroup::workspaceAllowAutoCreation	(	$	table,
		$	id,
		$	recpid
	)

Evaluates if auto creation of a version of a record is allowed.

Parameters:

	string	Table of the record
	integer	UID of record
	integer	PID of record

Returns:

boolean TRUE if ok.

Definition at line 761 of file class.t3lib_userauthgroup.php.

References t3lib_BEfunc::getWorkspaceVersionOfRecord(), and t3lib_BEfunc::isPidInVersionizedBranch().

t3lib_userAuthGroup::workspaceCheckStageForCurrent

(

$

stage

)

Checks if an element stage allows access for the user in the current workspace In workspaces 0 (Live) and -1 (Default draft) access is always granted for any stage. Admins are always allowed. An option for custom workspaces allows members to also edit when the stage is "Review"

Parameters:

integer

Stage id from an element: -1,0 = editing, 1 = reviewer, >1 = owner

Returns:

boolean TRUE if user is allowed access

Definition at line 782 of file class.t3lib_userauthgroup.php.

t3lib_userAuthGroup::workspacePublishAccess

(

$

wsid

)

Returns TRUE if the user has access to publish content from the workspace ID given. Admin-users are always granted access to do this If the workspace ID is 0 (live) all users have access also If -1 (draft workspace) TRUE is returned if the user has access to the Live workspace For custom workspaces it depends on whether the user is owner OR like with draft workspace if the user has access to Live workspace.

Parameters:

integer

Workspace UID; -1,0,1+

Returns:

boolean Returns TRUE if the user has access to publish content from the workspace ID given.

Definition at line 806 of file class.t3lib_userauthgroup.php.

t3lib_userAuthGroup::workspaceSwapAccess

(

)

Workspace swap-mode access?

Returns:

boolean Returns TRUE if records can be swapped in the current workspace, otherwise false

Definition at line 834 of file class.t3lib_userauthgroup.php.

t3lib_userAuthGroup::workspaceVersioningTypeAccess

(

$

type

)

Workspace Versioning type access?

Parameters:

integer

Versioning type to evaluation: -1, 0, >1

Returns:

boolean TRUE if OK

Definition at line 846 of file class.t3lib_userauthgroup.php.

References t3lib_div::intInRange().

t3lib_userAuthGroup::workspaceVersioningTypeGetClosest

(

$

type

)

Finding "closest" versioning type, used for creation of new records.

Parameters:

integer

Versioning type to evaluation: -1, 0, >1

Returns:

integer Returning versioning type

Definition at line 877 of file class.t3lib_userauthgroup.php.

References t3lib_div::intInRange().

t3lib_userAuthGroup::getTSConfig	(	$	objectString,
		$	config = ''
	)

Returns the value/properties of a TS-object as given by $objectString, eg. 'options.dontMountAdminMounts' Nice (general!) function for returning a part of a TypoScript array!

Parameters:

	string	Pointer to an "object" in the TypoScript array, fx. 'options.dontMountAdminMounts'
	array	Optional TSconfig array: If array, then this is used and not $this->userTS. If not array, $this->userTS is used.

Returns:

array An array with two keys, "value" and "properties" where "value" is a string with the value of the objectsting and "properties" is an array with the properties of the objectstring. array An array with the TypoScript where the $objectString is located. If this argument is not an array, then internal ->userTS (User TSconfig for the current BE_USER) will be used instead.

Definition at line 920 of file class.t3lib_userauthgroup.php.

t3lib_userAuthGroup::getTSConfigVal

(

$

objectString

)

Returns the "value" of the $objectString from the BE_USERS "User TSconfig" array

Parameters:

string

Object string, eg. "somestring.someproperty.somesubproperty"

Returns:

string The value for that object string (object path)

See also:

getTSConfig()

Definition at line 946 of file class.t3lib_userauthgroup.php.

Referenced by t3lib_beUserAuth::checkLockToIP(), and t3lib_tsfeBeUserAuth::extGetCategory_edit().

t3lib_userAuthGroup::getTSConfigProp

(

$

objectString

)

Returns the "properties" of the $objectString from the BE_USERS "User TSconfig" array

Parameters:

string

Object string, eg. "somestring.someproperty.somesubproperty"

Returns:

array The properties for that object string (object path) - if any

See also:

getTSConfig()

Definition at line 958 of file class.t3lib_userauthgroup.php.

Referenced by t3lib_beUserAuth::backendSetUC(), t3lib_tsfeBeUserAuth::extInitFeAdmin(), and t3lib_beUserAuth::overrideUC().

t3lib_userAuthGroup::inList	(	$	in_list,
		$	item
	)

Returns true if $item is in $in_list

Parameters:

	string	Comma list with items, no spaces between items!
	string	The string to find in the list of items

Returns:

string Boolean

Definition at line 970 of file class.t3lib_userauthgroup.php.

Referenced by isMemberOfGroup().

t3lib_userAuthGroup::returnWebmounts

(

)

Returns an array with the webmounts. If no webmounts, and empty array is returned. NOTICE: Deleted pages WILL NOT be filtered out! So if a mounted page has been deleted it is STILL coming out as a webmount. This is not checked due to performance.

Returns:

array

Definition at line 981 of file class.t3lib_userauthgroup.php.

Referenced by local_beUserAuth::ext_printOverview(), and isInWebMount().

t3lib_userAuthGroup::returnFilemounts

(

)

Returns an array with the filemounts for the user. Each filemount is represented with an array of a "name", "path" and "type". If no filemounts an empty array is returned.

Returns:

array

Definition at line 991 of file class.t3lib_userauthgroup.php.

Referenced by local_beUserAuth::ext_printOverview().

t3lib_userAuthGroup::jsConfirmation

(

$

bitmask

)

Returns true or false, depending if an alert popup (a javascript confirmation) should be shown call like $GLOBALS['BE_USER']->jsConfirmation($BITMASK)

1 - typeChange 2 - copy/move/paste 4 - delete 8 - frontend editing 128 - other (not used yet)

Parameters:

integer

Bitmask

Returns:

boolean true if the confirmation should be shown

Definition at line 1008 of file class.t3lib_userauthgroup.php.

t3lib_userAuthGroup::fetchGroupData

(

)

Initializes a lot of stuff like the access-lists, database-mountpoints and filemountpoints This method is called by ->backendCheckLogin() (from extending class t3lib_beuserauth) if the backend user login has verified OK. Generally this is required initialization of a backend user.

Returns:

void private

See also:

t3lib_TSparser

Definition at line 1046 of file class.t3lib_userauthgroup.php.

References t3lib_TSparser::checkIncludeLines_array(), t3lib_BEfunc::getHash(), t3lib_extMgm::isLoaded(), t3lib_div::makeInstance(), t3lib_BEfunc::storeHash(), and t3lib_div::uniqueList().

Referenced by t3lib_beUserAuth::backendCheckLogin().

t3lib_userAuthGroup::fetchGroups	(	$	grList,
		$	idList = ''
	)

Fetches the group records, subgroups and fills internal arrays. Function is called recursively to fetch subgroups

Parameters:

	string	Commalist of be_groups uid numbers
	string	List of already processed be_groups-uids so the function will not fall into a eternal recursion.

Returns:

void private

Definition at line 1179 of file class.t3lib_userauthgroup.php.

References t3lib_div::getIndpEnv(), and t3lib_div::getUserObj().

t3lib_userAuthGroup::setCachedList

(

$

cList

)

Updates the field be_users.usergroup_cached_list if the groupList of the user has changed/is different from the current list. The field "usergroup_cached_list" contains the list of groups which the user is a member of. After authentication (where these functions are called...) one can depend on this list being a representation of the exact groups/subgroups which the BE_USER has membership with.

Parameters:

string

The newly compiled group-list which must be compared with the current list in the user record and possibly stored if a difference is detected.

Returns:

void private

Definition at line 1277 of file class.t3lib_userauthgroup.php.

t3lib_userAuthGroup::addFileMount	(	$	title,
		$	altTitle,
		$	path,
		$	webspace,
		$	type
	)

Adds a filemount to the users array of filemounts, $this->groupData['filemounts'][hash_key] = Array ('name'=>$name, 'path'=>$path, 'type'=>$type); Is a part of the authentication proces of the user. A final requirement for a path being mounted is that a) it MUST return true on is_dir(), b) must contain either PATH_site+'fileadminDir' OR 'lockRootPath' - if lockRootPath is set - as first part of string! Paths in the mounted information will always be absolute and have a trailing slash.

Parameters:

	string	$title will be the (root)name of the filemount in the folder tree
	string	$altTitle will be the (root)name of the filemount IF $title is not true (blank or zero)
	string	$path is the path which should be mounted. Will accept backslash in paths on windows servers (will substituted with forward slash). The path should be 1) relative to TYPO3_CONF_VARS[BE][fileadminDir] if $webspace is set, otherwise absolute.
	boolean	If $webspace is set, the $path is relative to 'fileadminDir' in TYPO3_CONF_VARS, otherwise $path is absolute. 'fileadminDir' must be set to allow mounting of relative paths.
	string	Type of filemount; Can be blank (regular) or "user" / "group" (for user and group filemounts presumably). Probably sets the icon first and foremost.

Returns:

boolean Returns "1" if the requested filemount was mounted, otherwise no return value. private

Definition at line 1297 of file class.t3lib_userauthgroup.php.

References t3lib_div::isFirstPartOfStr(), and t3lib_div::validPathStr().

t3lib_userAuthGroup::addTScomment

(

$

str

)

Creates a TypoScript comment with the string text inside.

Parameters:

string

The text to wrap in comment prefixes and delimiters.

Returns:

string TypoScript comment with the string text inside.

Definition at line 1343 of file class.t3lib_userauthgroup.php.

References t3lib_div::trimExplode().

t3lib_userAuthGroup::workspaceInit

(

)

Initializing workspace. Called from within this function, see fetchGroupData()

Returns:

void

See also:

fetchGroupData()

Definition at line 1379 of file class.t3lib_userauthgroup.php.

References t3lib_div::intExplode().

t3lib_userAuthGroup::checkWorkspace	(	$	wsRec,
		$	fields = 'uid,
		title	,
		adminusers	,
		members	,
		reviewers	,
		publish_access	,
		stagechg_notification'
	)

Checking if a workspace is allowed for backend user

Parameters:

	mixed	If integer, workspace record is looked up, if array it is seen as a Workspace record with at least uid, title, members and adminusers columns. Can be faked for workspaces uid 0 and -1 (online and offline)
	string	List of fields to select. Default fields are: uid,title,adminusers,members,reviewers,publish_access,stagechg_notification

Returns:

array TRUE if access. Output will also show how access was granted. Admin users will have a true output regardless of input.

Definition at line 1422 of file class.t3lib_userauthgroup.php.

References t3lib_BEfunc::deleteClause(), and t3lib_div::inList().

Referenced by local_beUserAuth::ext_workspaceMembership().

t3lib_userAuthGroup::checkWorkspaceCurrent

(

)

Uses checkWorkspace() to check if current workspace is available for user. This function caches the result and so can be called many times with no performance loss.

Returns:

array See checkWorkspace()

See also:

checkWorkspace()

Definition at line 1497 of file class.t3lib_userauthgroup.php.

t3lib_userAuthGroup::setWorkspace

(

$

workspaceId

)

Setting workspace ID

Parameters:

integer

ID of workspace to set for backend user. If not valid the default workspace for BE user is found and set.

Returns:

void

Definition at line 1510 of file class.t3lib_userauthgroup.php.

t3lib_userAuthGroup::setWorkspacePreview

(

$

previewState

)

Setting workspace preview state for user:

Parameters:

boolean

State of user preview.

Returns:

void

Definition at line 1538 of file class.t3lib_userauthgroup.php.

t3lib_userAuthGroup::getDefaultWorkspace

(

)

Return default workspace ID for user

Returns:

integer Default workspace id. If no workspace is available it will be "-99"

Definition at line 1548 of file class.t3lib_userauthgroup.php.

References t3lib_BEfunc::deleteClause().

t3lib_userAuthGroup::writelog	(	$	type,
		$	action,
		$	error,
		$	details_nr,
		$	details,
		$	data,
		$	tablename = '',
		$	recuid = '',
		$	recpid = '',
		$	event_pid = -1,
		$	NEWid = '',
		$	userId = 0
	)

Writes an entry in the logfile/table Documentation in "TYPO3 Core API"

Parameters:

	integer	Denotes which module that has submitted the entry. See "TYPO3 Core API". Use "4" for extensions.
	integer	Denotes which specific operation that wrote the entry. Use "0" when no sub-categorizing applies
	integer	Flag. 0 = message, 1 = error (user problem), 2 = System Error (which should not happen), 3 = security notice (admin)
	integer	The message number. Specific for each $type and $action. This will make it possible to translate errormessages to other languages
	string	Default text that follows the message (in english!). Possibly translated by identification through type/action/details_nr
	array	Data that follows the log. Might be used to carry special information. If an array the first 5 entries (0-4) will be sprintf'ed with the details-text
	string	Table name. Special field used by tce_main.php.
	integer	Record UID. Special field used by tce_main.php.
	integer	Record PID. Special field used by tce_main.php. OBSOLETE
	integer	The page_uid (pid) where the event occurred. Used to select log-content for specific pages.
	string	Special field used by tce_main.php. NEWid string of newly created records.
	integer	Alternative Backend User ID (used for logging login actions where this is not yet known).

Returns:

integer Log entry ID.

Definition at line 1599 of file class.t3lib_userauthgroup.php.

References t3lib_div::getIndpEnv().

t3lib_userAuthGroup::simplelog	(	$	message,
		$	extKey = '',
		$	error = 0
	)

Simple logging function

Parameters:

	string	Log message
	string	Option extension key / module name
	integer	Error level. 0 = message, 1 = error (user problem), 2 = System Error (which should not happen), 3 = security notice (admin)

Returns:

integer Log entry UID

Definition at line 1631 of file class.t3lib_userauthgroup.php.

t3lib_userAuthGroup::checkLogFailures	(	$	email,
		$	secondsBack = 3600,
		$	max = 3
	)

Sends a warning to $email if there has been a certain amount of failed logins during a period. If a login fails, this function is called. It will look up the sys_log to see if there has been more than $max failed logins the last $secondsBack seconds (default 3600). If so, an email with a warning is sent to $email.

Parameters:

	string	Email address
	integer	Number of sections back in time to check. This is a kind of limit for how many failures an hour for instance.
	integer	Max allowed failures before a warning mail is sent

Returns:

void private

Definition at line 1652 of file class.t3lib_userauthgroup.php.

---

Member Data Documentation

t3lib_userAuthGroup::$groupData

Initial value:

 Array(                         // This array holds lists of eg. tables, fields and other values related to the permission-system. See fetchGroupData
                'filemounts' => Array()                 // Filemounts are loaded here
        )

Definition at line 140 of file class.t3lib_userauthgroup.php.

t3lib_userAuthGroup::$dataLists

Initial value:

array(                          // Used internally to accumulate data for the user-group. DONT USE THIS EXTERNALLY! Use $this->groupData instead
                'webmount_list'=>'',
                'filemount_list'=>'',
                'modList'=>'',
                'tables_select'=>'',
                'tables_modify'=>'',
                'pagetypes_select'=>'',
                'non_exclude_fields'=>'',
                'explicit_allowdeny'=>'',
                'allowed_languages' => '',
                'workspace_perms' => '',
                'custom_options' => '',
        )

Definition at line 149 of file class.t3lib_userauthgroup.php.

---

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

• typo3_src-4.1/t3lib/class.t3lib_userauthgroup.php

---