Role

contentbox.models.security

Class Role

lucee.Component
    contentbox.models.BaseEntityMethods
      contentbox.models.BaseEntity
        contentbox.models.security.Role

ContentBox - A Modular Content Platform Copyright since 2012 by Ortus Solutions, Corp www.ortussolutions.com/products/contentbox --- A cool Role entity

Class Attributes:

entityname : cbRole

cacheuse : read-write

table : cb_role

synchronized : false

cachename : cbRole

accessors : false

persistent : true

Property Summary
type	property	default	serializable	required
`date`	createdDate access = public returntype = any notnull = true ormtype = timestamp update = false index = idx_createDate		`true`	`false`
`any`	description access = public returntype = any notnull = false ormtype = string length = 500		`true`	`false`
`any`	isDeleted access = public dbdefault = 0 returntype = any notnull = true ormtype = boolean index = idx_deleted sqltype = bit	`false`	`true`	`false`
`date`	modifiedDate access = public returntype = any notnull = true ormtype = timestamp index = idx_modifiedDate		`true`	`false`
`any`	numberOfAuthors access = public returntype = any formula = select count(*) from cb_author as author where author.FK_roleID=roleID		`true`	`false`
`any`	numberOfPermissions access = public returntype = any formula = select count(*) from cb_rolePermissions as rolePermissions where rolePermissions.FK_roleID=roleID		`true`	`false`
`any`	permissionList access = public returntype = any persistent = false		`true`	`false`
`array`	permissions linktable = cb_rolePermissions access = public fieldtype = many-to-many returntype = any cascade = all cacheuse = read-write orderby = permission singularname = permission fkcolumn = FK_roleID inversejoincolumn = FK_permissionID cfc = contentbox.models.security.Permission lazy = extra		`true`	`false`
`any`	permissionService access = public returntype = any inject = permissionService@cb persistent = false		`true`	`false`
`any`	role access = public unique = true returntype = any notnull = true ormtype = string length = 255		`true`	`false`
`any`	roleID access = public fieldtype = id returntype = any params = { allocationSize = 1, sequence = 'roleID_seq' } generator = native setter = no		`true`	`false`

Constructor Summary
init()

Method Summary
`any`	addPermission(any permission)
`boolean`	checkPermission(any slug) Check for permission.
`Role`	clearPermissions() Clear all permissions.
`string`	getDescription()
`any`	getMemento([any excludes=''], [boolean showPermissions='true']) Get memento representation.
`string`	getName() Get the role name, same as getRole().
`string`	getNumberOfAuthors()
`string`	getNumberOfPermissions()
`string`	getPermissionList()
`string`	getPermissions()
`string`	getPermissionService()
`string`	getRole()
`string`	getRoleID()
`boolean`	hasPermission([any permission])
`boolean`	removePermission(any permission)
`any`	setDescription(any description)
`any`	setNumberOfAuthors(any numberOfAuthors)
`any`	setNumberOfPermissions(any numberOfPermissions)
`any`	setPermissionList(any permissionList)
`Role`	setPermissions(array permissions) Override the setPermissions.
`any`	setPermissionService(any permissionService)
`any`	setRole(any role)

Methods inherited from class `contentbox.models.BaseEntity`
getCreatedDate, getIsDeleted, getModifiedDate, setCreatedDate, setIsDeleted, setModifiedDate

Methods inherited from class `contentbox.models.BaseEntityMethods`
getBaseMemento, getDisplayCreatedDate, getDisplayModifiedDate, isLoaded, preInsert, preUpdate

Methods inherited from class `lucee.Component`
None

Constructor Detail

init

public init()

Property Detail

createdDate

property date createdDate

Attributes:: access - public; required - false; returntype - any; notnull - true; ormtype - timestamp; update - false; index - idx_createDate; serializable - true

description

property any description

Attributes:: access - public; required - false; returntype - any; notnull - false; ormtype - string; length - 500; serializable - true

isDeleted

property any isDeleted = [false]

Attributes:: access - public; required - false; dbdefault - 0; returntype - any; notnull - true; ormtype - boolean; index - idx_deleted; serializable - true; sqltype - bit

modifiedDate

property date modifiedDate

Attributes:: access - public; required - false; returntype - any; notnull - true; ormtype - timestamp; index - idx_modifiedDate; serializable - true

numberOfAuthors

property any numberOfAuthors

Attributes:: access - public; required - false; returntype - any; formula - select count(*) from cb_author as author where author.FK_roleID=roleID; serializable - true

numberOfPermissions

property any numberOfPermissions

Attributes:: access - public; required - false; returntype - any; formula - select count(*) from cb_rolePermissions as rolePermissions where rolePermissions.FK_roleID=roleID; serializable - true

permissionList

property any permissionList

Attributes:: access - public; required - false; returntype - any; persistent - false; serializable - true

permissions

property array permissions

Attributes:: linktable - cb_rolePermissions; access - public; required - false; fieldtype - many-to-many; returntype - any; cascade - all; cacheuse - read-write; orderby - permission; singularname - permission; fkcolumn - FK_roleID; serializable - true; inversejoincolumn - FK_permissionID; cfc - contentbox.models.security.Permission; lazy - extra

permissionService

property any permissionService

Attributes:: access - public; required - false; returntype - any; inject - permissionService@cb; persistent - false; serializable - true

role

property any role

Attributes:: access - public; unique - true; required - false; returntype - any; notnull - true; ormtype - string; length - 255; serializable - true

roleID

property any roleID

Attributes:: access - public; required - false; fieldtype - id; returntype - any; params - { allocationSize = 1, sequence = 'roleID_seq' }; generator - native; serializable - true; setter - no

Method Detail

addPermission

public any addPermission(any permission)

Parameters:: permission

checkPermission

public boolean checkPermission(any slug)

Check for permission

Parameters:: slug - The permission slug or list of slugs to validate the role has. If it's a list then they are ORed together

clearPermissions

public Role clearPermissions()

Clear all permissions

getDescription

public string getDescription()

getMemento

public any getMemento([any excludes=''], [boolean showPermissions='true'])

Get memento representation

Parameters:: excludes - Exclude properties; showPermissions - Show permissions or not

getName

public string getName()

Get the role name, same as getRole()

getNumberOfAuthors

public string getNumberOfAuthors()

getNumberOfPermissions

public string getNumberOfPermissions()

getPermissionList

public string getPermissionList()

getPermissions

public string getPermissions()

getPermissionService

public string getPermissionService()

getRole

public string getRole()

getRoleID

public string getRoleID()

hasPermission

public boolean hasPermission([any permission])

Parameters:: permission

removePermission

public boolean removePermission(any permission)

Parameters:: permission

setDescription

public any setDescription(any description)

Parameters:: description

setNumberOfAuthors

public any setNumberOfAuthors(any numberOfAuthors)

Parameters:: numberOfAuthors

setNumberOfPermissions

public any setNumberOfPermissions(any numberOfPermissions)

Parameters:: numberOfPermissions

setPermissionList

public any setPermissionList(any permissionList)

Parameters:: permissionList

setPermissions

public Role setPermissions(array permissions)

Override the setPermissions

Parameters:: permissions

setPermissionService

public any setPermissionService(any permissionService)

Parameters:: permissionService

setRole

public any setRole(any role)

Parameters:: role