Methods

Constructor.

__construct() 

Gets the datawriter for the discussion's container.

getContainerDataWriter(integer $containerId, \constant $errorHandler) : \XenForo_DataWriter | false

This DW must implement XenForo_DataWriter_DiscussionContainerInterface. May be false.

Parameters

$containerId

integer

$errorHandler

\constant

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

Returns

getContainerKeyName()

getContainerKeyName() 

getContentType()

getContentType() 

Gets the effective discussion configuration.

getDiscussionConfiguration() : array

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

Returns

array

Gets the discussion from the update marked with "for update" to ensure that position counters are maintained correctly.

getDiscussionForUpdate(\Zend_Db_Adapter_Abstract $db, integer $id) : array | false

Parameters

$db

\Zend_Db_Adapter_Abstract

$id

integer

Returns

arrayfalseDiscussion info or false to use what's in the DW already

getDiscussionKeyName()

getDiscussionKeyName() 

Gets the full discussion structure array.

getDiscussionStructure() : array

See _getDiscussionStructure() for data returned.

Returns

array

getDiscussionTableName()

getDiscussionTableName() 

Gets the message data writer for the given message ID.

getFirstMessageDataWriter(integer $firstMessageId, \constant $errorHandler) : \XenForo_DataWriter_DiscussionMessage

If no message is given, should return a "new" DW.

Parameters

$firstMessageId

integer

$errorHandler

\constant

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

Returns

Gets the search data handler for this type of discussion.

getSearchDataHandler() : \XenForo_Search_DataHandler_Abstract | false

Gets the parts of the discussion configuration options that override the defaults.

_getDiscussionConfiguration() : array

Options: * changeUserMessageCount (true)

Returns

array

Gets the structure of the discussion record.

_getDiscussionStructure() : array

This only includes parts that are variable. Keys returned: * table - name of the table (eg, xf_thread) * key - name of the discussion's key (eg, thread_id) * container - name of the container's key (eg, forum_id); leave blank (but define) if none! * contentType - name of the content type the discussion uses (eg, thread)

Returns

array

 Properties

 

$_structure : array