Class Editor

Concrete\Core\Foundation\Object
Extended by Concrete\Core\Conversation\Editor\Editor

Methods summary

abstract public Concrete\Core\Asset\AssetPointer[]
public
public
public
# setConversationObject( Conversation $cnvObject )
public
public
public
public string
# getConversationEditorMessageBody( )
public
public
public
public
public
public string
# getPackageHandle( )

Looks up and returns the Package.

public Package
# getPackageObject( )

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

public static Concrete\Core\Conversation\Editor\Editor|null
# getActive( )
public static Concrete\Core\Conversation\Editor\Editor|null
# getByID( integer $cnvEditorID )

Returns the appropriate conversation editor object for the given cnvEditorID.

public static Concrete\Core\Conversation\Editor\Editor|null
# getByHandle( $cnvEditorHandle )

Returns the appropriate conversation editor object for the given cnvEditorHandle.

protected static Concrete\Core\Conversation\Editor\Editor|null
# createFromRecord( array $record )

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

public
# outputConversationEditorAddMessageForm( )

outputs an HTML block containing the add message form for the current Conversation Editor.

public
# outputConversationEditorReplyMessageForm( )

Outputs an HTML block containing the message reply form for the current Conversation Editor.

public string
# formatConversationMessageBody( Concrete\Core\Conversation\Conversation $cnv, string $cnvMessageBody, array $config = array() )

Returns a formatted conversation message body string, based on configuration options supplied.

public static Concrete\Core\Conversation\Editor\Editor|null
# add( string $cnvEditorHandle, string $cnvEditorName, boolean|Package $pkg = false )

Creates a database record for the Conversation Editor, then attempts to return the object.

public
# delete( )

Removes the current editor object's record from the database.

public
# activate( )

Deactivates all other Conversation Editors, and activates the current one.

protected
# deactivateAll( )

Function used to deactivate.

public static Concrete\Core\Conversation\Editor\Editor[]
# getList( null $pkgID = null )

Returns an array of all Editor Objects.

public static Concrete\Core\Conversation\Editor\Editor[]
# getListByPackage( Package $pkg )

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

public
# export( $xml )
public static
# exportList( SimpleXMLElement $xml )

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

public boolean
# hasOptionsForm( )

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

Properties summary

protected string $cnvEditorHandle
#
protected string $cnvEditorID
#
protected integer $cnvEditorIsActive
#
protected string $cnvEditorInputName
# 'cnvMessageBody'
protected string $cnvEditorName
#
protected Concrete\Core\Conversation\Message\Message $cnvMessage
#
protected Conversation $cnvObject
#
protected integer $pkgID
#

Properties inherited from Concrete\Core\Foundation\Object

$error