PrincipalController Class Reference

Inheritance diagram for PrincipalController:

Public Member Functions
	initialize (&$request, &$response)
	validate ()
	hasView ()
	executeKernel ()
	beforeDelete (&$principal)
	afterInsert (&$principal)
	afterUpdate (&$principal)
Public Member Functions inherited from Controller
	Controller (&$delegate)
	initialize (&$request, &$response)
	validate ()
	hasView ()
	execute ()
	executeKernel ()
	getErrorMsg ()
	setErrorMsg ($msg)
	appendErrorMsg ($msg)
&	getRequest ()
&	getResponse ()
&	getView ()
&	getDelegate ()
	getViewTemplate ($controller, $context, $action)
	getCacheId ()
	assignViewDefaults (&$view)
	isLocalizedRequest ()

Public Attributes
	$_userManager = null
Public Attributes inherited from Controller
	$_request = null
	$_response = null
	$_errorMsg = ''
	$_view = null
	$_delegate = null

Detailed Description

PrincipalController is used to edit users and roles.

wCMF - wemove Content Management Framework Copyright (C) 2005-2014 wemove digital solutions GmbH

Licensed under the terms of any of the following licenses at your choice:

• GNU Lesser General Public License (LGPL) http://www.gnu.org/licenses/lgpl.html
• Eclipse Public License (EPL) http://www.eclipse.org/org/documents/epl-v10.php

See the license.txt file distributed with this work for additional information.

Id:

class.PrincipalController.php 1462 2014-02-04 23:52:27Z iherwig

Input actions:

• newprincipal Create a new principal of the given type
• editprincipal Edit a given principal
• save Save changes to the given principal
• delprincipal Delete the given principal

Output actions:

• overview If the action was delprincipal
• ok In any other case

Parameters

[in,out]	newtype	The principal type to create (user or role)
[in]	deleteoids	A comma separated list of principal object ids to delete
[in,out]	oid	The object id of the principal to edit
[in]	<oid>	A node defining what to save. The node should only contain those values, that should be changed This may be achived by creating the node using the node constructor (instead of using PersistenceFacade::create) and setting the values on it.
[in]	changepassword	If given, the password will tried to be changed
[in]	newpassword1	The new password of the current user
[in]	newpassword2	The new password of the current user repeated
[in]	principals	The list of all users that should belong to the displayed role or the list of all roles that the displayed user should have
[out]	principal	The principal to display
[out]	principalBaseList	The list of all users, if a role is displayed or the list of all roles if a user is displayed
[out]	principalList	The list of all users that belong to the displayed role or the list of all roles that the displayed user has

Author

ingo herwig ingo@.nosp@m.wemo.nosp@m.ve.co.nosp@m.m

Definition at line 60 of file class.PrincipalController.php.

Member Function Documentation

PrincipalController::initialize	(	&	$request,
		&	$response
	)

See Also

Controller::initialize()

Definition at line 67 of file class.PrincipalController.php.

References ObjectFactory\getInstance().

Here is the call graph for this function:

PrincipalController::validate

(

)

See Also

Controller::validate()

Definition at line 84 of file class.PrincipalController.php.

References Controller\setErrorMsg().

Here is the call graph for this function:

PrincipalController::hasView

(

)

See Also

Controller::hasView()

Definition at line 115 of file class.PrincipalController.php.

PrincipalController::executeKernel

(

)

Process action and assign data to View.

Returns

Array of given context and action 'overview' on delete. False else (Stop action processing chain).

See Also

Controller::executeKernel()

Definition at line 128 of file class.PrincipalController.php.

References afterInsert(), afterUpdate(), beforeDelete(), DATATYPE_ATTRIBUTE, WCMFInifileParser\getIniFiles(), PersistenceFacade\getInstance(), UserManager\getRoleClassName(), UserManager\getUserClassName(), ROLE_PROPERTY_NAME, USER_PROPERTY_CONFIG, USER_PROPERTY_FIRSTNAME, USER_PROPERTY_LOGIN, and USER_PROPERTY_NAME.

Here is the call graph for this function:

PrincipalController::beforeDelete

(

&

$principal

)

Called before deleting an exisiting principal.

Note

subclasses will override this to implement special application requirements.

Parameters

principal

A reference to the principal to delete (

See Also

UserManager::getPrincipal).

Definition at line 279 of file class.PrincipalController.php.

Referenced by executeKernel().

PrincipalController::afterInsert

(

&

$principal

)

Called after inserting a new principal.

Note

subclasses will override this to implement special application requirements.

Parameters

principal

A reference to the principal inserted (

See Also

UserManager::getPrincipal).

Definition at line 285 of file class.PrincipalController.php.

Referenced by executeKernel().

PrincipalController::afterUpdate

(

&

$principal

)

Called after updating an existing principal.

Note

subclasses will override this to implement special application requirements.

Parameters

principal

A reference to the principal updated (

See Also

UserManager::getPrincipal).

Definition at line 291 of file class.PrincipalController.php.

Referenced by executeKernel().

Member Data Documentation

PrincipalController::$_userManager = null

Definition at line 62 of file class.PrincipalController.php.

---

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

• C:/Users/ingo/Daten/web/htdocs/wcmf3.x/SVN/framework/wcmf/application/controller/admintool/class.PrincipalController.php