contentbox.models.security

Class PermissionGroup

lucee.Component
    extended by contentbox.models.BaseEntityMethods
      extended by contentbox.models.BaseEntity
        extended by contentbox.models.security.PermissionGroup

ContentBox - A Modular Content Platform Copyright since 2012 by Ortus Solutions, Corp www.ortussolutions.com/products/contentbox --- This entity groups permissions for logical groupings

Class Attributes:
  • entityname : cbPermissionGroup
  •  
  • cacheuse : read-write
  •  
  • table : cb_permissionGroup
  •  
  • synchronized : false
  •  
  • cachename : cbPermissionGroup
  •  
  • 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 name


    • access = public
    • unique = true
    • returntype = any
    • notnull = true
    • ormtype = string
    • length = 255
    true false
    any numberOfAuthors


    • access = public
    • returntype = any
    • formula = select count(*) from cb_authorPermissionGroups as pg where pg.FK_permissionGroupID = permissionGroupID
    true false
    any numberOfPermissions


    • access = public
    • returntype = any
    • formula = select count(*) from cb_groupPermissions as groupPermissions where groupPermissions.FK_permissionGroupID = permissionGroupID
    true false
    any permissionGroupID


    • access = public
    • fieldtype = id
    • returntype = any
    • params = { allocationSize = 1, sequence = 'permissionGroupID_seq' }
    • generator = native
    • setter = no
    true false
    any permissionList


    • access = public
    • returntype = any
    • persistent = false
    true false
    array permissions


    • linktable = cb_groupPermissions
    • access = public
    • fieldtype = many-to-many
    • returntype = any
    • cascade = save-update
    • cacheuse = read-write
    • orderby = permission
    • singularname = permission
    • fkcolumn = FK_permissionGroupID
    • inversejoincolumn = FK_permissionID
    • cfc = contentbox.models.security.Permission
    • lazy = extra
    true false
    Constructor Summary
    init()
    Method Summary
    any addPermission(any permission)
    boolean checkPermission(any slug)
         Check for permission.
    PermissionGroup clearPermissions()
         Clear all permissions.
    string getDescription()
    any getMemento([any excludes=''], [boolean showPermissions='true'])
         Get memento representation.
    string getName()
    string getNumberOfAuthors()
    string getNumberOfPermissions()
    string getPermissionGroupID()
    string getPermissionList()
    string getPermissions()
    boolean hasPermission([any permission])
    boolean removePermission(any permission)
    any setDescription(any description)
    any setName(any name)
    any setNumberOfAuthors(any numberOfAuthors)
    any setNumberOfPermissions(any numberOfPermissions)
    any setPermissionList(any permissionList)
    PermissionGroup setPermissions(array permissions)
         Override the setPermissions.
     
    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

    name

    property any name

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

    numberOfAuthors

    property any numberOfAuthors

    Attributes:
    access - public
    required - false
    returntype - any
    formula - select count(*) from cb_authorPermissionGroups as pg where pg.FK_permissionGroupID = permissionGroupID
    serializable - true

    numberOfPermissions

    property any numberOfPermissions

    Attributes:
    access - public
    required - false
    returntype - any
    formula - select count(*) from cb_groupPermissions as groupPermissions where groupPermissions.FK_permissionGroupID = permissionGroupID
    serializable - true

    permissionGroupID

    property any permissionGroupID

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

    permissionList

    property any permissionList

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

    permissions

    property array permissions

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

    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 PermissionGroup 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()


    getNumberOfAuthors

    public string getNumberOfAuthors()


    getNumberOfPermissions

    public string getNumberOfPermissions()


    getPermissionGroupID

    public string getPermissionGroupID()


    getPermissionList

    public string getPermissionList()


    getPermissions

    public string getPermissions()


    hasPermission

    public boolean hasPermission([any permission])

    Parameters:
    permission

    removePermission

    public boolean removePermission(any permission)

    Parameters:
    permission

    setDescription

    public any setDescription(any description)

    Parameters:
    description

    setName

    public any setName(any name)

    Parameters:
    name

    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 PermissionGroup setPermissions(array permissions)

    Override the setPermissions

    Parameters:
    permissions