Thread discussion definition.
Methods
Constructor.
__construct()
Inherited
| inherited_from |
\XenForo_Discussion_Definition_Abstract::__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
\constantDW error handler constant (usually parent DW's error handler)
Returns
getContainerKeyName()
getContainerKeyName()
Inherited
| inherited_from |
\XenForo_Discussion_Definition_Abstract::getContainerKeyName() |
getContentType()
getContentType()
Inherited
| inherited_from |
\XenForo_Discussion_Definition_Abstract::getContentType() |
Gets the effective discussion configuration.
getDiscussionConfiguration() : array
Inherited
This merges the defaults with
the specific class overrides. See _getDiscussionConfiguration() for options.
| inherited_from |
\XenForo_Discussion_Definition_Abstract::getDiscussionConfiguration() |
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()
Inherited
| inherited_from |
\XenForo_Discussion_Definition_Abstract::getDiscussionKeyName() |
Gets the full discussion structure array.
getDiscussionStructure() : array
Inherited
See _getDiscussionStructure() for
data returned.
| inherited_from |
\XenForo_Discussion_Definition_Abstract::getDiscussionStructure() |
Returns
array
getDiscussionTableName()
getDiscussionTableName()
Inherited
| inherited_from |
\XenForo_Discussion_Definition_Abstract::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
\constantDW error handler constant (usually parent DW's error handler)
Returns
Gets the parts of the discussion configuration options that override the defaults.
_getDiscussionConfiguration() : array
Inherited
Options:
* changeUserMessageCount (true)
| inherited_from |
\XenForo_Discussion_Definition_Abstract::_getDiscussionConfiguration() |
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
Contains the structure returned from {@link _getDiscussionStructure()}.
$_structure : array
Inherited
| inherited_from |
\XenForo_Discussion_Definition_Abstract::$$_structure |