class Editor extends ConcreteObject (View source)

Properties

$error from ConcreteObject
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

loadError($error)

No description

isError()

No description

getError()

No description

setPropertiesFromArray($arr)

No description

static 
camelcase($file)

No description

static 
uncamelcase($string)

No description

setConversationEditorInputName($input)

No description

setConversationObject(Conversation $cnvObject)

No description

getConversationObject()

No description

setConversationMessageObject(Message $message)

No description

getConversationMessageObject()

No description

string
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 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.

string
removeJavascriptLinks(string $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.

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.

Details

loadError($error)

Parameters

$error

isError()

getError()

setPropertiesFromArray($arr)

Parameters

$arr

static camelcase($file)

Parameters

$file

static uncamelcase($string)

Parameters

$string

abstract AssetPointer[] getConversationEditorAssetPointers()

Return Value

AssetPointer[]

setConversationEditorInputName($input)

Parameters

$input

getConversationEditorInputName()

setConversationObject(Conversation $cnvObject)

Parameters

Conversation $cnvObject

getConversationObject()

setConversationMessageObject(Message $message)

Parameters

Message $message

getConversationMessageObject()

string getConversationEditorMessageBody()

Return Value

string Returns the editor's formatted message

getConversationEditorHandle()

getConversationEditorID()

getConversationEditorName()

isConversationEditorActive()

getPackageID()

string getPackageHandle()

Looks up and returns the Package.

Return Value

string

Package getPackageObject()

Looks up and returns a Package object for the current Editor's Package ID.

Return Value

Package

static Editor|null getActive()

Return Value

Editor|null Returns the first found active conversation editor, null if no editor is active

static Editor|null getByID(int $cnvEditorID)

Returns the appropriate conversation editor object for the given cnvEditorID.

Parameters

int $cnvEditorID

Return Value

Editor|null

static Editor|null getByHandle($cnvEditorHandle)

Returns the appropriate conversation editor object for the given cnvEditorHandle.

Parameters

$cnvEditorHandle

Return Value

Editor|null

static protected Editor|null createFromRecord(array $record)

This function is used to instantiate a Conversation Editor object from an associative array.

Parameters

array $record an associative array of field value pairs for the ConversationEditor record

Return Value

Editor|null

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.

Parameters

Conversation $cnv
string $cnvMessageBody
array $config

Return Value

string

Replace javascript links with dummy links

Parameters

string $html

Return Value

string

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.

Parameters

string $cnvEditorHandle
string $cnvEditorName
bool|Package $pkg

Return Value

Editor|null

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.

Parameters

null $pkgID An optional filter for Package ID

Return Value

Editor[]

static Editor[] getListByPackage(Package $pkg)

Returns an array of all Editor objects for the given package object.

Parameters

Package $pkg

Return Value

Editor[]

export($xml)

Parameters

$xml

static exportList(SimpleXMLElement $xml)

Adds a ConversationEditors node and all Editor records to the provided SimleXMLElement object provided.

Parameters

SimpleXMLElement $xml

bool hasOptionsForm()

Returns whether or not the current Conversation Editor has an options form.

Return Value

bool