1. class
  2. Concrete
  3. \
  4. Core
  5. \
  6. Permission
  7. \
  8. Key
  9. \
  10. AddConversationMessageConversationKey

AddConversationMessageConversationKey

class AddConversationMessageConversationKey extends ConversationKey (View source)

Constants

ACCESS_TYPE_INCLUDE

Access type: inclusive.
ACCESS_TYPE_EXCLUDE

Access type: exclusive.
ACCESS_TYPE_ALL

Access type: any.

Properties

$error from  ConcreteObject
protected ObjectInterface|null $permissionObject

The object for which this permission is for (for example, a Page instance).

 from  Key
bool|int|string $pkID from  Key
string $pkName from  Key
string $pkHandle from  Key
string $pkDescription from  Key
bool|int|string $pkCategoryID from  Key
string $pkCategoryHandle from  Key
bool|int|string|null $pkgID from  Key
bool|int|string $pkCanTriggerWorkflow from  Key
bool|int|string $pkHasCustomClass from  Key
protected $permissionObjectToCheck from  ConversationKey

Methods

loadError($error)

No description

from  ConcreteObject
isError()

No description

from  ConcreteObject
getError()

No description

from  ConcreteObject
setPropertiesFromArray($arr)

No description

from  ConcreteObject
static 
camelcase($file)

No description

from  ConcreteObject
static 
uncamelcase($string)

No description

from  ConcreteObject
array
getSupportedAccessTypes()

Get the identifiers (keys) and descriptions (values) of the access types.

from  Key
bool
canPermissionKeyTriggerWorkflow()

Returns whether a permission key can start a workflow.

from  Key
bool
permissionKeyHasCustomClass()

Returns whether a permission key has a custom class.

from  Key
string
getPermissionKeyName()

Returns the name for this permission key.

from  Key
string
getPermissionKeyDisplayName(string $format = 'html')

Returns the display name for this permission key (localized and escaped accordingly to $format).

from  Key
string
getPermissionKeyHandle()

Returns the handle for this permission key.

from  Key
string
getPermissionKeyDescription()

Returns the description for this permission key.

from  Key
string
getPermissionKeyDisplayDescription(string $format = 'html')

Returns the display description for this permission key (localized and escaped accordingly to $format).

from  Key
int
getPermissionKeyID()

Returns the ID for this permission key.

from  Key
int
getPermissionKeyCategoryID()

Returns the ID for the category of this permission key.

from  Key
string
getPermissionKeyCategoryHandle()

Returns the handle for the category of this permission key.

from  Key
setPermissionObject(ObjectInterface|null $object)

Set the object for which this permission is for (for example, a Page instance).

from  Key
getPermissionObjectToCheck()

Set the actual object that should be checked for this permission (for example, a Page instance).

from  Key
ObjectInterface|null
getPermissionObject()

Get the object for which this permission is for (for example, a Page instance).

from  Key
static Key[]
loadAll()

Get the list of all the defined permission keys.

from  Key
bool
hasCustomOptionsForm()

Does this permission key have a form (located at elements/permission/keys/.php)?

from  Key
int|null
getPackageID()

Get the ID of the package that defines this permission key.

from  Key
string|null
getPackageHandle()

Get the handle of the package that defines this permission key.

from  Key
static Key[]
getList(string $pkCategoryHandle, array $filters = [])

Returns the list of all permissions of this category.

from  Key
SimpleXMLElement
export(SimpleXMLElement $axml)

Export this permission key to a SimpleXMLElement instance.

from  Key
static 
exportList(SimpleXMLElement $xml)

Export the list of all permissions of this category to a SimpleXMLElement instance.

from  Key
static Key[]
getListByPackage(Package|Package $pkg)

Get the list of permission keys defined by a package.

from  Key
static Key
import(SimpleXMLElement $pk)

Import a permission key from a SimpleXMLElement element.

from  Key
static Key|null
getByID(int $pkID)

Get a permission key given its ID.

from  Key
static Key|null
getByHandle(string $pkHandle)

Get a permission key given its handle.

from  Key
static 
add(string $pkCategoryHandle, string $pkHandle, string $pkName, string $pkDescription, bool $pkCanTriggerWorkflow, bool $pkHasCustomClass, Package|Package|null $pkg = false)

Adds an permission key.

from  Key
setPermissionKeyHasCustomClass(bool $pkHasCustomClass)

Mark this permission key as having (or not) a custom class.

from  Key
can() deprecated

No description

from  Key
bool
validate()

Check if the current user is of for this key and its current permission object (if any).

from  Key
delete()

Delete this permission key.

from  Key
ListItem[]
getAccessListItems()

A shortcut for grabbing the current assignment and passing into that object.

from  Key
Assignment
getPermissionAssignmentObject()

No description

from  ConversationKey
Access|null
getPermissionAccessObject()

No description

from  Key
int|null
getPermissionAccessID()

No description

from  Key
exportAccess(SimpleXMLElement $pxml)

No description

from  Key
static Translations
exportTranslations()

Export the strings that should be translated.

from  Key
static Key|null
load(int|mixed $key, string $loadBy = 'pkID')

Load a permission key by its ID (or whatever is passed to $loadBy).

from  Key
getMyAssignment()

No description

Details

in ConcreteObject at line 10
loadError($error)

No description

Parameters

$error

in ConcreteObject at line 15
isError()

No description

in ConcreteObject at line 25
getError()

No description

in ConcreteObject at line 30
setPropertiesFromArray($arr)

No description

Parameters

$arr

in ConcreteObject at line 37
static camelcase($file)

No description

Parameters

$file

in ConcreteObject at line 42
static uncamelcase($string)

No description

Parameters

$string

in Key at line 65
array getSupportedAccessTypes()

Get the identifiers (keys) and descriptions (values) of the access types.

Return Value

array

in Key at line 80
bool canPermissionKeyTriggerWorkflow()

Returns whether a permission key can start a workflow.

Return Value

bool

in Key at line 90
bool permissionKeyHasCustomClass()

Returns whether a permission key has a custom class.

Return Value

bool

in Key at line 100
string getPermissionKeyName()

Returns the name for this permission key.

Return Value

string

in Key at line 114
string getPermissionKeyDisplayName(string $format = 'html')

Returns the display name for this permission key (localized and escaped accordingly to $format).

Parameters

string $format

= 'html' Escape the result in html format (if $format is 'html'). If $format is 'text' or any other value, the display name won't be escaped.

Return Value

string

in Key at line 131
string getPermissionKeyHandle()

Returns the handle for this permission key.

Return Value

string

in Key at line 141
string getPermissionKeyDescription()

Returns the description for this permission key.

Return Value

string

in Key at line 155
string getPermissionKeyDisplayDescription(string $format = 'html')

Returns the display description for this permission key (localized and escaped accordingly to $format).

Parameters

string $format

= 'html' Escape the result in html format (if $format is 'html'). If $format is 'text' or any other value, the display description won't be escaped.

Return Value

string

in Key at line 172
int getPermissionKeyID()

Returns the ID for this permission key.

Return Value

int

in Key at line 182
int getPermissionKeyCategoryID()

Returns the ID for the category of this permission key.

Return Value

int

in Key at line 192
string getPermissionKeyCategoryHandle()

Returns the handle for the category of this permission key.

Return Value

string

in Key at line 202
setPermissionObject(ObjectInterface|null $object)

Set the object for which this permission is for (for example, a Page instance).

Parameters

ObjectInterface|null $object

in Key at line 212
getPermissionObjectToCheck()

Set the actual object that should be checked for this permission (for example, a Page instance).

in Key at line 226
ObjectInterface|null getPermissionObject()

Get the object for which this permission is for (for example, a Page instance).

Return Value

ObjectInterface|null

in Key at line 236
static Key[] loadAll()

Get the list of all the defined permission keys.

Return Value

Key[]

in Key at line 275
bool hasCustomOptionsForm()

Does this permission key have a form (located at elements/permission/keys/.php)?

Return Value

bool

in Key at line 293
int|null getPackageID()

Get the ID of the package that defines this permission key.

Return Value

int|null

in Key at line 303
string|null getPackageHandle()

Get the handle of the package that defines this permission key.

Return Value

string|null

in Key at line 318
static Key[] getList(string $pkCategoryHandle, array $filters = [])

Returns the list of all permissions of this category.

Parameters

string $pkCategoryHandle
array $filters

An array containing of field name => value (to be used directly in the SQL query)

Return Value

Key[]

in Key at line 345
SimpleXMLElement export(SimpleXMLElement $axml)

Export this permission key to a SimpleXMLElement instance.

Parameters

SimpleXMLElement $axml

Return Value

SimpleXMLElement

in Key at line 364
static exportList(SimpleXMLElement $xml)

Export the list of all permissions of this category to a SimpleXMLElement instance.

Parameters

SimpleXMLElement $xml

in Key at line 385
static Key[] getListByPackage(Package|Package $pkg)

Get the list of permission keys defined by a package.

Note, this queries both the pkgID found on the PermissionKeys table AND any permission keys of a special type installed by that package, and any in categories by that package.

Parameters

Package|Package $pkg

Return Value

Key[]

in Key at line 420
static Key import(SimpleXMLElement $pk)

Import a permission key from a SimpleXMLElement element.

Parameters

SimpleXMLElement $pk

Return Value

Key

in Key at line 447
static Key|null getByID(int $pkID)

Get a permission key given its ID.

Parameters

int $pkID

Return Value

Key|null

in Key at line 472
static Key|null getByHandle(string $pkHandle)

Get a permission key given its handle.

Parameters

string $pkHandle

Return Value

Key|null

in Key at line 501
static add(string $pkCategoryHandle, string $pkHandle, string $pkName, string $pkDescription, bool $pkCanTriggerWorkflow, bool $pkHasCustomClass, Package|Package|null $pkg = false)

Adds an permission key.

Parameters

string $pkCategoryHandle
string $pkHandle
string $pkName
string $pkDescription
bool $pkCanTriggerWorkflow
bool $pkHasCustomClass
Package|Package|null $pkg

in Key at line 527
setPermissionKeyHasCustomClass(bool $pkHasCustomClass)

Mark this permission key as having (or not) a custom class.

Parameters

bool $pkHasCustomClass

in Key at line 538
can() deprecated

deprecated use the validate() method

No description

in Key at line 548
bool validate()

Check if the current user is of for this key and its current permission object (if any).

Return Value

bool

in Key at line 581
delete()

Delete this permission key.

in Key at line 594
ListItem[] getAccessListItems()

A shortcut for grabbing the current assignment and passing into that object.

Return Value

ListItem[]

in ConversationKey at line 11
Assignment getPermissionAssignmentObject()

No description

Return Value

Assignment

in Key at line 637
Access|null getPermissionAccessObject()

No description

Return Value

Access|null

in Key at line 647
int|null getPermissionAccessID()

No description

Return Value

int|null

in Key at line 657
exportAccess(SimpleXMLElement $pxml)

No description

Parameters

SimpleXMLElement $pxml

in Key at line 667
static Translations exportTranslations()

Export the strings that should be translated.

Return Value

Translations

in Key at line 692
static protected Key|null load(int|mixed $key, string $loadBy = 'pkID')

Load a permission key by its ID (or whatever is passed to $loadBy).

Parameters

int|mixed $key

the ID (or the value of the $loadBy field) of the key to be loaded
string $loadBy

the field to be used to locate the permission key

Return Value

Key|null

at line 10
getMyAssignment()

No description