phpDocumentor
Back to top  

Post discussion message definition.

This will generally be used to interact with data writers (both for messages and discussions). It serves mostly to decouple data that will be useful to multiple data writers.

package XenForo_Discussion

 Methods

Constructor.

__construct() 
Inherited

inherited_from \XenForo_DiscussionMessage_Definition_Abstract::__construct()

getContainerKeyName() 

getContainerKeyName() 
Inherited

inherited_from \XenForo_DiscussionMessage_Definition_Abstract::getContainerKeyName()

getContentType() 

getContentType() 
Inherited

inherited_from \XenForo_DiscussionMessage_Definition_Abstract::getContentType()

Gets the discussion data writer for the given discussion ID.

getDiscussionDataWriter(integer $discussionId, \constant $errorHandler) : \XenForo_DataWriter_Discussion | false

If no discussion is given, should return false.

Parameters

$discussionId

integer

$errorHandler

\constant

DW error handler constant (usually parent DW's error handler)

Returns

\XenForo_DataWriter_Discussionfalse

Gets the effective message configuration.

getMessageConfiguration() : array
Inherited

This merges the defaults with the specific class overrides. See _getMessageConfiguration() for options.

inherited_from \XenForo_DiscussionMessage_Definition_Abstract::getMessageConfiguration()

Returns

array

getMessageKeyName() 

getMessageKeyName() 
Inherited

inherited_from \XenForo_DiscussionMessage_Definition_Abstract::getMessageKeyName()

Gets the full message structure array.

getMessageStructure() : array
Inherited

See _getMessageStructure() for data returned.

inherited_from \XenForo_DiscussionMessage_Definition_Abstract::getMessageStructure()

Returns

array

getMessageTableName() 

getMessageTableName() 
Inherited

inherited_from \XenForo_DiscussionMessage_Definition_Abstract::getMessageTableName()

Gets the search data handler for this type of message.

getSearchDataHandler() : \XenForo_Search_DataHandler_Abstract | false

Returns

\XenForo_Search_DataHandler_Abstractfalse

Gets the parts of the message configuration options that are to override the defaults.

_getMessageConfiguration() : array

Options: * hasParentDiscussion (false) * changeUserMessageCount (true)

Returns

array

Gets the structure of the message record.

_getMessageStructure() : array

This only includes parts that are variable. Keys returned: * table - name of the table (eg, xf_post) * key - name of the message's key (eg, post_id) * container - name of the container/discussion's key (eg, thread_id, profile_user_id) * contentType - name of the content type the message uses (eg, post, profile_post)

Returns

array

 Properties

 

Contains the structure returned from {@link _getMessageStructure()}.

$_structure : array
Inherited

inherited_from \XenForo_DiscussionMessage_Definition_Abstract::$$_structure