|
ContentBox Core API 1.6.0 | ||||
FRAMES |
WEB-INF.cftags.componentcontentbox.model.security.Author
public class Author
I am a author entity
Property Summary | ||||
---|---|---|---|---|
Type | Property & Description | Default | Serializable | Required |
any
|
authorID
Attributes:
|
|
true
|
false
|
any
|
authorService
Attributes:
|
|
true
|
false
|
any
|
biography
Attributes:
|
|
true
|
false
|
any
|
createdDate
Attributes:
|
|
true
|
false
|
any
|
email
Attributes:
|
|
true
|
false
|
array
|
entries
Attributes:
|
|
true
|
false
|
any
|
firstName
Attributes:
|
|
true
|
false
|
any
|
isActive
Attributes:
|
false
|
true
|
false
|
any
|
lastLogin
Attributes:
|
|
true
|
false
|
any
|
lastName
Attributes:
|
|
true
|
false
|
boolean
|
loggedIn
Attributes:
|
false
|
true
|
false
|
any
|
numberOfEntries
Attributes:
|
|
true
|
false
|
any
|
numberOfPages
Attributes:
|
|
true
|
false
|
array
|
pages
Attributes:
|
|
true
|
false
|
any
|
password
Attributes:
|
|
true
|
false
|
any
|
permissionList
Attributes:
|
|
true
|
false
|
array
|
permissions
Attributes:
|
|
true
|
false
|
any
|
preferences
Attributes:
|
|
true
|
false
|
any
|
role
Attributes:
|
|
true
|
false
|
any
|
username
Attributes:
|
|
true
|
false
|
Constructor Summary | |
---|---|
init()
Constructor |
Method Summary | |
---|---|
void |
ADDENTRY(Entry entry)
|
void |
ADDPAGE(Page page)
|
void |
ADDPERMISSION(Permission permission)
|
any |
GETAUTHORID()
|
any |
GETAUTHORSERVICE()
|
any |
GETBIOGRAPHY()
|
any |
GETCREATEDDATE()
|
any |
GETEMAIL()
|
array |
GETENTRIES()
|
any |
GETFIRSTNAME()
|
any |
GETISACTIVE()
|
any |
GETLASTLOGIN()
|
any |
GETLASTNAME()
|
boolean |
GETLOGGEDIN()
|
any |
GETNUMBEROFENTRIES()
|
any |
GETNUMBEROFPAGES()
|
array |
GETPAGES()
|
any |
GETPASSWORD()
|
any |
GETPERMISSIONLIST()
|
array |
GETPERMISSIONS()
|
any |
GETPREFERENCES()
|
any |
GETROLE()
|
any |
GETUSERNAME()
|
boolean |
HASENTRY([Entry entries])
|
boolean |
HASPAGE([Page pages])
|
boolean |
HASPERMISSION([Permission permissions])
|
boolean |
HASROLE()
|
boolean |
REMOVEENTRY(Entry entry)
|
boolean |
REMOVEPAGE(Page page)
|
boolean |
REMOVEPERMISSION(Permission permission)
|
Author |
SETAUTHORSERVICE(any authorService)
|
Author |
SETBIOGRAPHY(any biography)
|
Author |
SETCREATEDDATE(any createdDate)
|
Author |
SETEMAIL(any email)
|
Author |
SETENTRIES(array entries)
|
Author |
SETFIRSTNAME(any firstName)
|
Author |
SETISACTIVE(any isActive)
|
Author |
SETLASTLOGIN(any lastLogin)
|
Author |
SETLASTNAME(any lastName)
|
Author |
SETLOGGEDIN(boolean loggedIn)
|
Author |
SETNUMBEROFENTRIES(any numberOfEntries)
|
Author |
SETNUMBEROFPAGES(any numberOfPages)
|
Author |
SETPAGES(array pages)
|
Author |
SETPASSWORD(any password)
|
Author |
SETPERMISSIONLIST(any permissionList)
|
Author |
SETROLE(any role)
|
Author |
SETUSERNAME(any username)
|
boolean |
checkPermission(any slug)
Check for permission |
Author |
clearPermissions()
Clear all permissions |
struct |
getAllPreferences()
Get all user preferences in inflated format |
string |
getDisplayCreatedDate()
Get formatted createdDate |
string |
getDisplayLastLogin()
Get formatted lastLogin |
any |
getMemento()
Get a flat representation of this entry |
string |
getName()
Retrieve full name |
any |
getPreference(any name, [any defaultValue])
Get a preference, you can pass a default value if preference does not exist |
any |
inPermissionList(any list)
Verify that a passed in list of perms the user can use |
boolean |
isLoaded()
is loaded? |
any |
isLoggedIn()
Logged in |
void |
preInsert()
|
Author |
setPermissions(array permissions)
Override the setPermissions |
Author |
setPreference(any name, any value)
Set a preference in the user preferences |
Author |
setPreferences(any preferences)
Store a preferences structure or JSON data in the user prefernces |
Methods inherited from class WEB-INF.cftags.component |
---|
None
|
Constructor Detail |
---|
public init()
Property Detail |
---|
any authorID
generator
- nativefieldtype
- idserializable
- truerequired
- falsedefault
- setter
- falseany authorService
inject
- authorService@cbserializable
- truerequired
- falsepersistent
- falsedefault
- any biography
ormtype
- textserializable
- truerequired
- falsenotnull
- falselength
- 8000default
- any createdDate
update
- falseormtype
- timestampserializable
- truerequired
- falsenotnull
- truedefault
- any email
index
- idx_emailserializable
- truerequired
- falsenotnull
- truelength
- 255default
- array entries
inverse
- trueserializable
- truelazy
- extrabatchsize
- 10default
- fieldtype
- one-to-manysingularname
- entryorderby
- publishedDate DESCrequired
- falsecascade
- save-updatecfc
- contentbox.model.content.Entryfkcolumn
- FK_authorIDany firstName
serializable
- truerequired
- falsenotnull
- truelength
- 100default
- any isActive
index
- idx_login,idx_activeormtype
- booleanserializable
- truerequired
- falsenotnull
- truedbdefault
- 0default
- falseany lastLogin
ormtype
- timestampserializable
- truerequired
- falsenotnull
- falsedefault
- any lastName
serializable
- truerequired
- falsenotnull
- truelength
- 100default
- boolean loggedIn
required
- falseserializable
- truepersistent
- falsedefault
- falseany numberOfEntries
formula
- select count(*) from cb_content as content where content.FK_authorID=authorID and content.contentType='entry'required
- falseserializable
- truedefault
- any numberOfPages
formula
- select count(*) from cb_content as content where content.FK_authorID=authorID and content.contentType='page'required
- falseserializable
- truedefault
- array pages
inverse
- trueserializable
- truelazy
- extrabatchsize
- 10default
- fieldtype
- one-to-manysingularname
- pageorderby
- publishedDate DESCrequired
- falsecascade
- save-updatecfc
- contentbox.model.content.Pagefkcolumn
- FK_authorIDany password
index
- idx_loginserializable
- truerequired
- falsenotnull
- truelength
- 100default
- any permissionList
required
- falseserializable
- truepersistent
- falsedefault
- array permissions
serializable
- truelazy
- extradefault
- linktable
- cb_authorPermissionsfieldtype
- many-to-manysingularname
- permissionorderby
- permissionrequired
- falseinversejoincolumn
- FK_permissionIDcascade
- allcfc
- contentbox.model.security.Permissionfkcolumn
- FK_authorIDany preferences
ormtype
- textserializable
- truerequired
- falsenotnull
- falselength
- 8000default
- any role
fieldtype
- many-to-oneserializable
- truerequired
- falsenotnull
- truelazy
- truecfc
- contentbox.model.security.Roledefault
- fkcolumn
- FK_roleIDany username
index
- idx_loginunique
- trueserializable
- truerequired
- falsenotnull
- truelength
- 100default
- Method Detail |
---|
public void ADDENTRY(Entry entry)
entry
public void ADDPAGE(Page page)
page
public void ADDPERMISSION(Permission permission)
permission
public any GETAUTHORID()
public any GETAUTHORSERVICE()
public any GETBIOGRAPHY()
public any GETCREATEDDATE()
public any GETEMAIL()
public array GETENTRIES()
public any GETFIRSTNAME()
public any GETISACTIVE()
public any GETLASTLOGIN()
public any GETLASTNAME()
public boolean GETLOGGEDIN()
public any GETNUMBEROFENTRIES()
public any GETNUMBEROFPAGES()
public array GETPAGES()
public any GETPASSWORD()
public any GETPERMISSIONLIST()
public array GETPERMISSIONS()
public any GETPREFERENCES()
public any GETROLE()
public any GETUSERNAME()
public boolean HASENTRY([Entry entries])
entries
public boolean HASPAGE([Page pages])
pages
public boolean HASPERMISSION([Permission permissions])
permissions
public boolean HASROLE()
public boolean REMOVEENTRY(Entry entry)
entry
public boolean REMOVEPAGE(Page page)
page
public boolean REMOVEPERMISSION(Permission permission)
permission
public Author SETAUTHORSERVICE(any authorService)
authorService
public Author SETBIOGRAPHY(any biography)
biography
public Author SETCREATEDDATE(any createdDate)
createdDate
public Author SETEMAIL(any email)
email
public Author SETENTRIES(array entries)
entries
public Author SETFIRSTNAME(any firstName)
firstName
public Author SETISACTIVE(any isActive)
isActive
public Author SETLASTLOGIN(any lastLogin)
lastLogin
public Author SETLASTNAME(any lastName)
lastName
public Author SETLOGGEDIN(boolean loggedIn)
loggedIn
public Author SETNUMBEROFENTRIES(any numberOfEntries)
numberOfEntries
public Author SETNUMBEROFPAGES(any numberOfPages)
numberOfPages
public Author SETPAGES(array pages)
pages
public Author SETPASSWORD(any password)
password
public Author SETPERMISSIONLIST(any permissionList)
permissionList
public Author SETROLE(any role)
role
public Author SETUSERNAME(any username)
username
public boolean checkPermission(any slug)
slug
- The permission slug or list of slugs to validate the user has. If it's a list then they are ORed togetherpublic Author clearPermissions()
public struct getAllPreferences()
public string getDisplayCreatedDate()
public string getDisplayLastLogin()
public any getMemento()
public string getName()
public any getPreference(any name, [any defaultValue])
name
defaultValue
public any inPermissionList(any list)
list
public boolean isLoaded()
public any isLoggedIn()
public void preInsert()
public Author setPermissions(array permissions)
permissions
public Author setPreference(any name, any value)
name
value
public Author setPreferences(any preferences)
preferences
- A struct of data or a JSON packet to store
|
ContentBox Core API 1.6.0 | ||||
FRAMES |