RedactorEditor
class RedactorEditor extends Editor (View source)
Properties
| $error | from ConcreteObject | ||
| protected string | $cnvEditorHandle | from Editor | |
| protected string | $cnvEditorID | from Editor | |
| protected int | $cnvEditorIsActive | from Editor | |
| protected string | $cnvEditorInputName | from Editor | |
| protected string | $cnvEditorName | from Editor | |
| protected Message | $cnvMessage | from Editor | |
| protected Conversation | $cnvObject | from Editor | |
| protected int | $pkgID | from Editor |
Methods
No description
Looks up and returns a Package object for the current Editor's Package ID.
Returns the appropriate conversation editor object for the given cnvEditorID.
Returns the appropriate conversation editor object for the given cnvEditorHandle.
This function is used to instantiate a Conversation Editor object from an associative array.
outputs an HTML block containing the add message form for the current Conversation Editor.
Outputs an HTML block containing the message reply form for the current Conversation Editor.
Returns a formatted conversation message body string, based on configuration options supplied.
Creates a database record for the Conversation Editor, then attempts to return the object.
Returns an array of all Editor objects for the given package object.
Adds a ConversationEditors node and all Editor records to the provided SimleXMLElement object provided.
Returns whether or not the current Conversation Editor has an options form.
Details
loadError($error)
No description
isError()
No description
getError()
No description
setPropertiesFromArray($arr)
No description
static
camelcase($file)
No description
static
uncamelcase($string)
No description
AssetPointer[]
getConversationEditorAssetPointers()
No description
in
Editor at line 35
setConversationEditorInputName($input)
No description
in
Editor at line 40
getConversationEditorInputName()
No description
in
Editor at line 48
setConversationObject(Conversation $cnvObject)
No description
in
Editor at line 53
getConversationObject()
No description
in
Editor at line 65
setConversationMessageObject(Message $message)
No description
in
Editor at line 70
getConversationMessageObject()
No description
in
Editor at line 78
string
getConversationEditorMessageBody()
No description
in
Editor at line 88
getConversationEditorHandle()
No description
in
Editor at line 93
getConversationEditorID()
No description
in
Editor at line 98
getConversationEditorName()
No description
isConversationEditorActive()
No description
getPackageID()
No description
string
getPackageHandle()
Looks up and returns the Package.
Package
getPackageObject()
Looks up and returns a Package object for the current Editor's Package ID.
static Editor|null
getActive()
No description
static Editor|null
getByID(int $cnvEditorID)
Returns the appropriate conversation editor object for the given cnvEditorID.
static Editor|null
getByHandle($cnvEditorHandle)
Returns the appropriate conversation editor object for the given cnvEditorHandle.
static protected Editor|null
createFromRecord(array $record)
This function is used to instantiate a Conversation Editor object from an associative array.
outputConversationEditorAddMessageForm()
outputs an HTML block containing the add message form for the current Conversation Editor.
outputConversationEditorReplyMessageForm()
Outputs an HTML block containing the message reply form for the current Conversation Editor.
string
formatConversationMessageBody(Conversation $cnv, string $cnvMessageBody, array $config = array('htmlawed' => true))
Returns a formatted conversation message body string, based on configuration options supplied.
protected mixed
removeJavascriptLinks($html)
Replace javascript links with dummy links
static Editor|null
add(string $cnvEditorHandle, string $cnvEditorName, bool|Package $pkg = false)
Creates a database record for the Conversation Editor, then attempts to return the object.
delete()
Removes the current editor object's record from the database.
activate()
Deactivates all other Conversation Editors, and activates the current one.
protected
deactivateAll()
Function used to deactivate.
static Editor[]
getList(null $pkgID = null)
Returns an array of all Editor Objects.
static Editor[]
getListByPackage(Package $pkg)
Returns an array of all Editor objects for the given package object.
export($xml)
No description
static
exportList(SimpleXMLElement $xml)
Adds a ConversationEditors node and all Editor records to the provided SimleXMLElement object provided.
bool
hasOptionsForm()
Returns whether or not the current Conversation Editor has an options form.