annotate core/modules/content_moderation/content_moderation.api.php @ 19:fa3358dc1485 tip

Add ndrum files
author Chris Cannam
date Wed, 28 Aug 2019 13:14:47 +0100
parents 4c8ae668cc8c
children
rev   line source
Chris@0 1 <?php
Chris@0 2
Chris@0 3 /**
Chris@0 4 * @file
Chris@0 5 * API documentation for Content Moderation module.
Chris@0 6 */
Chris@0 7
Chris@0 8 /**
Chris@0 9 * @defgroup content_moderation_plugin Content Moderation Workflow Type Plugin
Chris@0 10 * @{
Chris@0 11 * The Workflow Type plugin implemented by Content Moderation links revisionable
Chris@0 12 * entities to workflows.
Chris@0 13 *
Chris@0 14 * In the Content Moderation Workflow Type Plugin, one method requires the
Chris@0 15 * entity object to be passed in as a parameter, even though the interface
Chris@0 16 * defined by Workflows module doesn't require this:
Chris@0 17 * @code
Chris@0 18 * $workflow_type_plugin->getInitialState($entity);
Chris@0 19 * @endcode
Chris@0 20 * This is used to determine the initial moderation state based on the
Chris@0 21 * publishing status of the entity.
Chris@0 22 * @}
Chris@0 23 */