lucee.Componentcborm.models.BaseORMService
cborm.models.VirtualEntityService
contentbox.models.security.AuthorService
ContentBox - A Modular Content Platform Copyright since 2012 by Ortus Solutions, Corp www.ortussolutions.com/products/contentbox --- Service to handle user operations.
Property Summary | ||||
---|---|---|---|---|
type | property | default | serializable | required |
any
|
CBHelper
|
true
|
false
|
|
any
|
bCrypt
|
true
|
false
|
|
any
|
dateUtil
|
true
|
false
|
|
any
|
mailService
|
true
|
false
|
|
any
|
permissionGroupService
|
true
|
false
|
|
any
|
permissionService
|
true
|
false
|
|
any
|
renderer
|
true
|
false
|
|
any
|
requestService
|
true
|
false
|
|
any
|
roleService
|
true
|
false
|
|
any
|
securityService
|
true
|
false
|
|
any
|
settingService
|
true
|
false
|
|
any
|
siteService
|
true
|
false
|
Constructor Summary | |
---|---|
init()
Constructor. |
Method Summary | |
---|---|
Author
|
createNewAuthor(any author)
Create a new author in ContentBox and sends them their email confirmations. |
AuthorService
|
delete(any author)
Delete an author from the system. |
boolean
|
emailFound(any email)
Email checks for authors. |
array
|
getAllForExport()
Get all data prepared for export. |
string
|
getBCrypt()
|
string
|
getCBHelper()
|
string
|
getDateUtil()
|
string
|
getMailService()
|
string
|
getPermissionGroupService()
|
string
|
getPermissionService()
|
string
|
getRenderer()
|
string
|
getRequestService()
|
string
|
getRoleService()
|
string
|
getSecurityService()
|
string
|
getSettingService()
|
string
|
getSiteService()
|
any
|
getStatusReport()
Get a status report of authors in the system. |
numeric
|
getTotalContent(any authorId)
Get the total number of content items an author has created. |
numeric
|
getTotalContentStoreItems(any authorId)
Get the total number of content store items an author has created. |
numeric
|
getTotalEntries(any authorId)
Get the total number of entries an author has created. |
numeric
|
getTotalPages(any authorId)
Get the total number of pages an author has created. |
string
|
importFromData(any importData, [boolean override='false'], [any importLog])
Import data from an array of structures or a single structure of data. |
string
|
importFromFile(any importFile, [boolean override='false'])
Import data from a ContentBox JSON file. |
boolean
|
isSameHash(any incoming, any target)
This function will encrypt an incoming target string using bcrypt and compare it with another bcrypt string. |
Author
|
retrieveUserById(any id)
Get an author by id which is active and not deleted. |
Author
|
retrieveUserByUsername(any username)
Get an author by username which is active and not deleted. |
Author
|
save(any author, [boolean passwordChange='false'])
Save an author with extra pizazz!. |
any
|
search([string searchTerm=''], [string isActive], [string role], [numeric max='0'], [numeric offset='0'], [boolean asQuery='false'], [string sortOrder='lastName'], [string permissionGroups], [string twoFactorAuth])
Author search by many criteria. |
struct
|
sendNewUserEmail(Author author)
Sends a new author their reminder to reset their password and log in to their account. |
any
|
setBCrypt(any bCrypt)
|
any
|
setCBHelper(any CBHelper)
|
any
|
setDateUtil(any dateUtil)
|
any
|
setMailService(any mailService)
|
any
|
setPermissionGroupService(any permissionGroupService)
|
any
|
setPermissionService(any permissionService)
|
any
|
setRenderer(any renderer)
|
any
|
setRequestService(any requestService)
|
any
|
setRoleService(any roleService)
|
any
|
setSecurityService(any securityService)
|
any
|
setSettingService(any settingService)
|
any
|
setSiteService(any siteService)
|
boolean
|
usernameFound(any username)
Username checks for authors. |
Methods inherited from class cborm.models.VirtualEntityService |
---|
autoCast, convertIdValueToJavaType, convertValueToJavaType, count, countWhere, deleteAll, deleteByID, deleteByQuery, deleteWhere, evictCollection, executeQuery, exists, findAllWhere, findWhere, get, getAll, getEntityName, getKey, getOrFail, getPropertyNames, getTableName, idCast, list, new, newCriteria, onMissingMethod, setEntityName |
Methods inherited from class lucee.Component |
---|
None |
Constructor Detail |
---|
Constructor
Property Detail |
---|
access
- publicrequired
- falsereturntype
- anyinject
- CBHelper@contentboxserializable
- trueaccess
- publicrequired
- falsereturntype
- anyinject
- BCrypt@BCryptserializable
- trueaccess
- publicrequired
- falsereturntype
- anyinject
- DateUtil@contentboxserializable
- trueaccess
- publicrequired
- falsereturntype
- anyinject
- mailService@cbmailservicesserializable
- trueaccess
- publicrequired
- falsereturntype
- anyinject
- permissionGroupService@contentboxserializable
- trueaccess
- publicrequired
- falsereturntype
- anyinject
- permissionService@contentboxserializable
- trueaccess
- publicrequired
- falsereturntype
- anyinject
- coldbox:rendererserializable
- trueaccess
- publicrequired
- falsereturntype
- anyinject
- coldbox:requestServiceserializable
- trueaccess
- publicrequired
- falsereturntype
- anyinject
- roleService@contentboxserializable
- trueaccess
- publicrequired
- falsereturntype
- anyinject
- provider:securityService@contentboxserializable
- trueaccess
- publicrequired
- falsereturntype
- anyinject
- provider:settingService@contentboxserializable
- trueaccess
- publicrequired
- falsereturntype
- anyinject
- provider:siteService@contentboxserializable
- trueMethod Detail |
---|
Create a new author in ContentBox and sends them their email confirmations.
author
- The target author object to createDelete an author from the system
delete
in class
cborm.models.BaseORMService
author
- The author to deleteEmail checks for authors
email
- The email to check if it exists alreadyGet all data prepared for export
Get a status report of authors in the system.
Get the total number of content items an author has created
authorId
- The author id to report onGet the total number of content store items an author has created
authorId
- The author id to report onGet the total number of entries an author has created
authorId
- The author id to report onGet the total number of pages an author has created
authorId
- The author id to report onImport data from an array of structures or a single structure of data
importData
- A struct or array of data to importoverride
- Override content if found in the database, defaults to falseimportLog
- The import log bufferImport data from a ContentBox JSON file. Returns the import log
importFile
- The json file to importoverride
- Override content if found in the database, defaults to falseThis function will encrypt an incoming target string using bcrypt and compare it with another bcrypt string
incoming
- Incoming stringtarget
- Target checkGet an author by id which is active and not deleted
id
- The unique IdGet an author by username which is active and not deleted
username
- The username to verify the user withSave an author with extra pizazz!
save
in class
cborm.models.BaseORMService
author
- The author objectpasswordChange
- Are we changing the passwordAuthor search by many criteria.
searchTerm
- Search in firstname, lastname and email fieldsisActive
- Search with active bitrole
- Apply a role filtermax
- The max returned objectsoffset
- The offset for paginationasQuery
- Query or objectssortOrder
- The sort order to applypermissionGroups
- Single or list of permissiong groups to search ontwoFactorAuth
- Two factor auth or anySends a new author their reminder to reset their password and log in to their account
author
- The author to send the reminder tobCrypt
CBHelper
dateUtil
mailService
permissionGroupService
permissionService
renderer
requestService
roleService
securityService
settingService
siteService
Username checks for authors
username
- The username to check if it exists already