Editor
abstract class Editor extends Object (View source)
Properties
| $error | from Object | ||
| protected string | $cnvEditorHandle | ||
| protected string | $cnvEditorID | ||
| protected int | $cnvEditorIsActive | ||
| protected string | $cnvEditorInputName | ||
| protected string | $cnvEditorName | ||
| protected Message | $cnvMessage | ||
| protected Conversation | $cnvObject | ||
| protected int | $pkgID |
Methods
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
Looks up and returns the Package.
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.
Removes the current editor object's record from the database.
Deactivates all other Conversation Editors, and activates the current one.
Function used to deactivate.
Returns an array of all Editor objects for the given package object.
No description
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
in
Object at line 10
loadError($error)
No description
in
Object at line 15
isError()
No description
in
Object at line 25
getError()
No description
in
Object at line 30
setPropertiesFromArray($arr)
No description
in
Object at line 37
static
camelcase($file)
No description
in
Object at line 42
static
uncamelcase($string)
No description
abstract AssetPointer[]
getConversationEditorAssetPointers()
No description
setConversationEditorInputName($input)
No description
getConversationEditorInputName()
No description
setConversationObject(Conversation $cnvObject)
No description
getConversationObject()
No description
setConversationMessageObject(Message $message)
No description
getConversationMessageObject()
No description
string
getConversationEditorMessageBody()
No description
getConversationEditorHandle()
No description
getConversationEditorID()
No description
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())
Returns a formatted conversation message body string, based on configuration options supplied.
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.