Role Class Reference

Inheritance diagram for Role:

Public Member Functions
	may ($mPage, $sRightName, $bInheritedOnly=false)
	mayEditPageDetails ($mPage)
	mayEditPageContents ($mPage)
	mayEditPageStructure ($mPage)
	mayCreateChildren ($mPage)
	mayDelete ($mPage)
	mayViewPage ($mPage)
	getMissingRights ($mPage, $bInheritedOnly=false)
	getUserWithRoleCount ()
	getGroupWithRoleCount ()
Public Member Functions inherited from BaseRole
	getRoleKey ()
	getDescription ()
	getCreatedAt ($format= 'Y-m-d H:i:s')
	getUpdatedAt ($format= 'Y-m-d H:i:s')
	getCreatedBy ()
	getUpdatedBy ()
	setRoleKey ($v)
	setDescription ($v)
	setCreatedAt ($v)
	setUpdatedAt ($v)
	setCreatedBy ($v)
	setUpdatedBy ($v)
	hasOnlyDefaultValues ()
	hydrate ($row, $startcol=0, $rehydrate=false)
	ensureConsistency ()
	reload ($deep=false, PropelPDO $con=null)
	delete (PropelPDO $con=null)
	save (PropelPDO $con=null)
	getValidationFailures ()
	validate ($columns=null)
	getByName ($name, $type=BasePeer::TYPE_PHPNAME)
	getByPosition ($pos)
	toArray ($keyType=BasePeer::TYPE_PHPNAME, $includeLazyLoadColumns=true, $alreadyDumpedObjects=array(), $includeForeignObjects=false)
	setByName ($name, $value, $type=BasePeer::TYPE_PHPNAME)
	setByPosition ($pos, $value)
	fromArray ($arr, $keyType=BasePeer::TYPE_PHPNAME)
	buildCriteria ()
	buildPkeyCriteria ()
	getPrimaryKey ()
	setPrimaryKey ($key)
	isPrimaryKeyNull ()
	copyInto ($copyObj, $deepCopy=false, $makeNew=true)
	copy ($deepCopy=false)
	getPeer ()
	setUserRelatedByCreatedBy (User $v=null)
	getUserRelatedByCreatedBy (PropelPDO $con=null, $doQuery=true)
	setUserRelatedByUpdatedBy (User $v=null)
	getUserRelatedByUpdatedBy (PropelPDO $con=null, $doQuery=true)
	initRelation ($relationName)
	clearGroupRoles ()
	resetPartialGroupRoles ($v=true)
	initGroupRoles ($overrideExisting=true)
	getGroupRoles ($criteria=null, PropelPDO $con=null)
	setGroupRoles (PropelCollection $groupRoles, PropelPDO $con=null)
	countGroupRoles (Criteria $criteria=null, $distinct=false, PropelPDO $con=null)
	addGroupRole (GroupRole $l)
	removeGroupRole ($groupRole)
	getGroupRolesJoinGroup ($criteria=null, $con=null, $join_behavior=Criteria::LEFT_JOIN)
	getGroupRolesJoinUserRelatedByCreatedBy ($criteria=null, $con=null, $join_behavior=Criteria::LEFT_JOIN)
	getGroupRolesJoinUserRelatedByUpdatedBy ($criteria=null, $con=null, $join_behavior=Criteria::LEFT_JOIN)
	clearUserRoles ()
	resetPartialUserRoles ($v=true)
	initUserRoles ($overrideExisting=true)
	getUserRoles ($criteria=null, PropelPDO $con=null)
	setUserRoles (PropelCollection $userRoles, PropelPDO $con=null)
	countUserRoles (Criteria $criteria=null, $distinct=false, PropelPDO $con=null)
	addUserRole (UserRole $l)
	removeUserRole ($userRole)
	getUserRolesJoinUserRelatedByUserId ($criteria=null, $con=null, $join_behavior=Criteria::LEFT_JOIN)
	getUserRolesJoinUserRelatedByCreatedBy ($criteria=null, $con=null, $join_behavior=Criteria::LEFT_JOIN)
	getUserRolesJoinUserRelatedByUpdatedBy ($criteria=null, $con=null, $join_behavior=Criteria::LEFT_JOIN)
	clearRights ()
	resetPartialRights ($v=true)
	initRights ($overrideExisting=true)
	getRights ($criteria=null, PropelPDO $con=null)
	setRights (PropelCollection $rights, PropelPDO $con=null)
	countRights (Criteria $criteria=null, $distinct=false, PropelPDO $con=null)
	addRight (Right $l)
	removeRight ($right)
	getRightsJoinPage ($criteria=null, $con=null, $join_behavior=Criteria::LEFT_JOIN)
	getRightsJoinUserRelatedByCreatedBy ($criteria=null, $con=null, $join_behavior=Criteria::LEFT_JOIN)
	getRightsJoinUserRelatedByUpdatedBy ($criteria=null, $con=null, $join_behavior=Criteria::LEFT_JOIN)
	clear ()
	clearAllReferences ($deep=false)
	__toString ()
	isAlreadyInSave ()
	mayOperate ($sOperation, $oUser=false)
	mayBeInserted ($oUser=false)
	mayBeUpdated ($oUser=false)
	mayBeDeleted ($oUser=false)
	keepUpdateDateUnchanged ()
	getCreatedAtTimestamp ()
	getCreatedAtFormatted ($sLanguageId=null, $sFormatString= 'x')
	getUpdatedAtTimestamp ()
	getUpdatedAtFormatted ($sLanguageId=null, $sFormatString= 'x')
	keepUpdateUserUnchanged ()
	getPKArray ()
	getPKString ()

Additional Inherited Members
Public Attributes inherited from BaseRole
const	PEER = 'RolePeer'
Protected Member Functions inherited from BaseRole
	doSave (PropelPDO $con)
	doInsert (PropelPDO $con)
	doUpdate (PropelPDO $con)
	doValidate ($columns=null)
	doAddGroupRole ($groupRole)
	doAddUserRole ($userRole)
	doAddRight ($right)
Protected Attributes inherited from BaseRole
	$startCopy = false
	$role_key
	$description
	$created_at
	$updated_at
	$created_by
	$updated_by
	$aUserRelatedByCreatedBy
	$aUserRelatedByUpdatedBy
	$collGroupRoles
	$collGroupRolesPartial
	$collUserRoles
	$collUserRolesPartial
	$collRights
	$collRightsPartial
	$alreadyInSave = false
	$alreadyInValidation = false
	$alreadyInClearAllReferencesDeep = false
	$groupRolesScheduledForDeletion = null
	$userRolesScheduledForDeletion = null
	$rightsScheduledForDeletion = null
	$validationFailures = array()
Static Protected Attributes inherited from BaseRole
static	$peer

---

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

• cms-full/base/lib/model/Role.php