class ModerationStateFilter

Same name in other branches
  1. 9 core/modules/content_moderation/src/Plugin/views/filter/ModerationStateFilter.php \Drupal\content_moderation\Plugin\views\filter\ModerationStateFilter
  2. 8.9.x core/modules/content_moderation/src/Plugin/views/filter/ModerationStateFilter.php \Drupal\content_moderation\Plugin\views\filter\ModerationStateFilter
  3. 10 core/modules/content_moderation/src/Plugin/views/filter/ModerationStateFilter.php \Drupal\content_moderation\Plugin\views\filter\ModerationStateFilter

Provides a filter for the moderation state of an entity.

Hierarchy

Expanded class hierarchy of ModerationStateFilter

Related topics

File

core/modules/content_moderation/src/Plugin/views/filter/ModerationStateFilter.php, line 21

Namespace

Drupal\content_moderation\Plugin\views\filter
View source
class ModerationStateFilter extends InOperator implements DependentWithRemovalPluginInterface {
    use ModerationStateJoinViewsHandlerTrait;
    
    /**
     * {@inheritdoc}
     */
    protected $valueFormType = 'select';
    
    /**
     * The entity type manager.
     *
     * @var \Drupal\Core\Entity\EntityTypeManagerInterface
     */
    protected $entityTypeManager;
    
    /**
     * The bundle information service.
     *
     * @var \Drupal\Core\Entity\EntityTypeBundleInfoInterface
     */
    protected $bundleInfo;
    
    /**
     * The storage handler of the workflow entity type.
     *
     * @var \Drupal\Core\Entity\EntityStorageInterface
     */
    protected $workflowStorage;
    
    /**
     * Creates an instance of ModerationStateFilter.
     */
    public function __construct(array $configuration, $plugin_id, $plugin_definition, EntityTypeManagerInterface $entity_type_manager, EntityTypeBundleInfoInterface $bundle_info, EntityStorageInterface $workflow_storage) {
        parent::__construct($configuration, $plugin_id, $plugin_definition);
        $this->entityTypeManager = $entity_type_manager;
        $this->bundleInfo = $bundle_info;
        $this->workflowStorage = $workflow_storage;
    }
    
    /**
     * {@inheritdoc}
     */
    public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
        return new static($configuration, $plugin_id, $plugin_definition, $container->get('entity_type.manager'), $container->get('entity_type.bundle.info'), $container->get('entity_type.manager')
            ->getStorage('workflow'));
    }
    
    /**
     * {@inheritdoc}
     */
    public function getCacheTags() {
        return Cache::mergeTags(parent::getCacheTags(), $this->entityTypeManager
            ->getDefinition('workflow')
            ->getListCacheTags());
    }
    
    /**
     * {@inheritdoc}
     */
    public function getCacheContexts() {
        return Cache::mergeContexts(parent::getCacheContexts(), $this->entityTypeManager
            ->getDefinition('workflow')
            ->getListCacheContexts());
    }
    
    /**
     * {@inheritdoc}
     */
    public function getValueOptions() {
        if (isset($this->valueOptions)) {
            return $this->valueOptions;
        }
        $this->valueOptions = [];
        // Find all workflows which are moderating entity types of the same type the
        // view is displaying.
        foreach ($this->workflowStorage
            ->loadByProperties([
            'type' => 'content_moderation',
        ]) as $workflow) {
            
            /** @var \Drupal\content_moderation\Plugin\WorkflowType\ContentModerationInterface $workflow_type */
            $workflow_type = $workflow->getTypePlugin();
            if (in_array($this->getEntityType(), $workflow_type->getEntityTypes(), TRUE)) {
                foreach ($workflow_type->getStates() as $state_id => $state) {
                    $this->valueOptions[$workflow->label()][implode('-', [
                        $workflow->id(),
                        $state_id,
                    ])] = $state->label();
                }
            }
        }
        return $this->valueOptions;
    }
    
    /**
     * {@inheritdoc}
     */
    protected function opSimple() {
        if (empty($this->value)) {
            return;
        }
        $this->ensureMyTable();
        $entity_type = $this->entityTypeManager
            ->getDefinition($this->getEntityType());
        $bundle_condition = NULL;
        if ($entity_type->hasKey('bundle')) {
            // Get a list of bundles that are being moderated by the workflows
            // configured in this filter.
            $workflow_ids = $this->getWorkflowIds();
            $moderated_bundles = [];
            foreach ($this->bundleInfo
                ->getBundleInfo($this->getEntityType()) as $bundle_id => $bundle) {
                if (isset($bundle['workflow']) && in_array($bundle['workflow'], $workflow_ids, TRUE)) {
                    $moderated_bundles[] = $bundle_id;
                }
            }
            // If we have a list of moderated bundles, restrict the query to show only
            // entities in those bundles.
            if ($moderated_bundles) {
                $entity_base_table_alias = $this->relationship ?: $this->table;
                // The bundle field of an entity type is not revisionable so we need to
                // join the base table.
                $entity_base_table = $entity_type->getBaseTable();
                $entity_revision_base_table = $entity_type->isTranslatable() ? $entity_type->getRevisionDataTable() : $entity_type->getRevisionTable();
                if ($this->table === $entity_revision_base_table) {
                    $entity_revision_base_table_alias = $this->relationship ?: $this->table;
                    $configuration = [
                        'table' => $entity_base_table,
                        'field' => $entity_type->getKey('id'),
                        'left_table' => $entity_revision_base_table_alias,
                        'left_field' => $entity_type->getKey('id'),
                        'type' => 'INNER',
                    ];
                    $join = Views::pluginManager('join')->createInstance('standard', $configuration);
                    $entity_base_table_alias = $this->query
                        ->addRelationship($entity_base_table, $join, $entity_revision_base_table_alias);
                }
                $bundle_condition = $this->view->query
                    ->getConnection()
                    ->condition('AND');
                $bundle_condition->condition("{$entity_base_table_alias}.{$entity_type->getKey('bundle')}", $moderated_bundles, 'IN');
            }
            else {
                $this->query
                    ->addWhereExpression($this->options['group'], '1 = 0');
                return;
            }
        }
        if ($this->operator === 'in') {
            $operator = "=";
        }
        else {
            $operator = "<>";
        }
        // The values are strings composed from the workflow ID and the state ID, so
        // we need to create a complex WHERE condition.
        $field = $this->view->query
            ->getConnection()
            ->condition('OR');
        foreach ((array) $this->value as $value) {
            [
                $workflow_id,
                $state_id,
            ] = explode('-', $value, 2);
            $and = $this->view->query
                ->getConnection()
                ->condition('AND');
            $and->condition("{$this->tableAlias}.workflow", $workflow_id, '=')
                ->condition("{$this->tableAlias}.{$this->realField}", $state_id, $operator);
            $field->condition($and);
        }
        if ($bundle_condition) {
            // The query must match the bundle AND the workflow/state conditions.
            $bundle_condition->condition($field);
            $this->query
                ->addWhere($this->options['group'], $bundle_condition);
        }
        else {
            $this->query
                ->addWhere($this->options['group'], $field);
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public function calculateDependencies() {
        $dependencies = parent::calculateDependencies();
        if ($workflow_ids = $this->getWorkflowIds()) {
            
            /** @var \Drupal\workflows\WorkflowInterface $workflow */
            foreach ($this->workflowStorage
                ->loadMultiple($workflow_ids) as $workflow) {
                $dependencies[$workflow->getConfigDependencyKey()][] = $workflow->getConfigDependencyName();
            }
        }
        return $dependencies;
    }
    
    /**
     * {@inheritdoc}
     */
    public function onDependencyRemoval(array $dependencies) {
        // See if this handler is responsible for any of the dependencies being
        // removed. If this is the case, indicate that this handler needs to be
        // removed from the View.
        $remove = FALSE;
        // Get all the current dependencies for this handler.
        $current_dependencies = $this->calculateDependencies();
        foreach ($current_dependencies as $group => $dependency_list) {
            // Check if any of the handler dependencies match the dependencies being
            // removed.
            foreach ($dependency_list as $config_key) {
                if (isset($dependencies[$group]) && array_key_exists($config_key, $dependencies[$group])) {
                    // This handlers dependency matches a dependency being removed,
                    // indicate that this handler needs to be removed.
                    $remove = TRUE;
                    break 2;
                }
            }
        }
        return $remove;
    }
    
    /**
     * Gets the list of Workflow IDs configured for this filter.
     *
     * @return array
     *   And array of workflow IDs.
     */
    protected function getWorkflowIds() {
        $workflow_ids = [];
        foreach ((array) $this->value as $value) {
            [
                $workflow_id,
            ] = explode('-', $value, 2);
            $workflow_ids[] = $workflow_id;
        }
        return array_unique($workflow_ids);
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
DerivativeInspectionInterface::getBaseId public function Gets the base_plugin_id of the plugin instance. 1
DerivativeInspectionInterface::getDerivativeId public function Gets the derivative_id of the plugin instance. 1
FilterPluginBase::$alwaysMultiple protected property Disable the possibility to force a single value. 6
FilterPluginBase::$always_required public property
FilterPluginBase::$group_info public property
FilterPluginBase::$no_operator public property 1
FilterPluginBase::$operator public property Contains the operator which is used on the query.
FilterPluginBase::$tableAliases public property Keyed array by alias of table relations.
FilterPluginBase::$value public property The value.
FilterPluginBase::addGroupForm public function Add a new group to the exposed filter groups.
FilterPluginBase::arrayFilterZero protected static function Filter by no empty values, though allow the use of (string) &quot;0&quot;.
FilterPluginBase::buildExposedFiltersGroupForm protected function Build the form to let users create the group of exposed filters.
FilterPluginBase::buildExposedForm public function Render our chunk of the exposed filter form when selecting. Overrides HandlerBase::buildExposedForm
FilterPluginBase::buildGroupForm public function Displays the Build Group form.
FilterPluginBase::buildGroupOptions protected function Provide default options for exposed filters.
FilterPluginBase::buildGroupSubmit protected function Save new group items, re-enumerates and remove groups marked to delete.
FilterPluginBase::buildGroupValidate protected function Validate the build group options form.
FilterPluginBase::buildOptionsForm public function Provide the basic form which calls through to subforms. Overrides HandlerBase::buildOptionsForm 2
FilterPluginBase::buildValueWrapper protected function Builds wrapper for value and operator forms.
FilterPluginBase::canBuildGroup protected function Determine if a filter can be converted into a group.
FilterPluginBase::canExpose public function Determine if a filter can be exposed. Overrides HandlerBase::canExpose 5
FilterPluginBase::canGroup public function Can this filter be used in OR groups? 1
FilterPluginBase::convertExposedInput public function Transform the input from a grouped filter into a standard filter.
FilterPluginBase::exposedInfo public function Tell the renderer about our exposed form. Overrides HandlerBase::exposedInfo
FilterPluginBase::exposedTranslate protected function Make some translations to a form item to make it more suitable to exposing.
FilterPluginBase::getCacheMaxAge public function The maximum age for which this object may be cached. Overrides CacheableDependencyInterface::getCacheMaxAge
FilterPluginBase::groupForm public function Builds a group form.
FilterPluginBase::groupMultipleExposedInput public function Group multiple exposed input.
FilterPluginBase::hasValidGroupedValue protected function Determines if the given grouped filter entry has a valid value. 1
FilterPluginBase::isAGroup public function Returns TRUE if the exposed filter works like a grouped filter. Overrides HandlerBase::isAGroup
FilterPluginBase::multipleExposedInput public function Multiple exposed input. Overrides HandlerBase::multipleExposedInput
FilterPluginBase::operatorForm protected function Options form subform for setting the operator. 6
FilterPluginBase::operatorSubmit public function Perform any necessary changes to the form values prior to storage.
FilterPluginBase::operatorValidate protected function Validate the operator form.
FilterPluginBase::prepareFilterSelectOptions protected function Sanitizes the HTML select element&#039;s options.
FilterPluginBase::RESTRICTED_IDENTIFIERS constant A list of restricted identifiers.
FilterPluginBase::showBuildGroupButton protected function Shortcut to display the build_group/hide button.
FilterPluginBase::showBuildGroupForm public function Shortcut to display the exposed options form.
FilterPluginBase::showExposeButton public function Shortcut to display the expose/hide button. Overrides HandlerBase::showExposeButton
FilterPluginBase::showOperatorForm public function Shortcut to display the operator form.
FilterPluginBase::showValueForm protected function Shortcut to display the value form.
FilterPluginBase::storeExposedInput public function If set to remember exposed input in the session, store it there. Overrides HandlerBase::storeExposedInput
FilterPluginBase::storeGroupInput public function If set to remember exposed input in the session, store it there.
FilterPluginBase::submitOptionsForm public function Simple submit handler. Overrides PluginBase::submitOptionsForm
FilterPluginBase::trustedCallbacks public static function Lists the trusted callbacks provided by the implementing class. Overrides PluginBase::trustedCallbacks
FilterPluginBase::validateExposeForm public function Validate the options form. Overrides HandlerBase::validateExposeForm
FilterPluginBase::validateIdentifier protected function Validates a filter identifier.
FilterPluginBase::validateOptionsForm public function Simple validate handler. Overrides PluginBase::validateOptionsForm 1
FilterPluginBase::valueValidate protected function Validate the options form. 3
HandlerBase::$field public property With field you can override the realField if the real field is not set.
HandlerBase::$is_handler public property
HandlerBase::$moduleHandler protected property The module handler. 2
HandlerBase::$query public property Where the $query object will reside. 7
HandlerBase::$realField public property The real field.
HandlerBase::$relationship public property The relationship used for this field.
HandlerBase::$table public property The table this handler is attached to.
HandlerBase::$tableAlias public property The alias of the table of this handler which is used in the query.
HandlerBase::$viewsData protected property The views data service.
HandlerBase::access public function Check whether given user has access to this handler. Overrides ViewsHandlerInterface::access 5
HandlerBase::adminLabel public function Return a string representing this handler&#039;s name in the UI. Overrides ViewsHandlerInterface::adminLabel 4
HandlerBase::breakString public static function Breaks x,y,z and x+y+z into an array. Overrides ViewsHandlerInterface::breakString
HandlerBase::broken public function Determines if the handler is considered &#039;broken&#039;. Overrides ViewsHandlerInterface::broken
HandlerBase::buildExtraOptionsForm public function Provide a form for setting options. 2
HandlerBase::buildGroupByForm public function Provide a form for aggregation settings. 1
HandlerBase::caseTransform protected function Transform a string by a certain method.
HandlerBase::defineExtraOptions public function Provide defaults for the handler.
HandlerBase::displayExposedForm public function Displays the Expose form.
HandlerBase::getDateField public function Creates cross-database SQL dates. 2
HandlerBase::getDateFormat public function Creates cross-database SQL date formatting. 2
HandlerBase::getEntityType public function Determines the entity type used by this handler. Overrides ViewsHandlerInterface::getEntityType
HandlerBase::getField public function Shortcut to get a handler&#039;s raw field value. Overrides ViewsHandlerInterface::getField
HandlerBase::getJoin public function Get the join object that should be used for this handler. Overrides ViewsHandlerInterface::getJoin
HandlerBase::getModuleHandler protected function Gets the module handler.
HandlerBase::getTableJoin public static function Fetches a handler to join one table to a primary table from the data cache. Overrides ViewsHandlerInterface::getTableJoin
HandlerBase::getViewsData protected function Gets views data service.
HandlerBase::hasExtraOptions public function Determines if the handler has extra options. 2
HandlerBase::isExposed public function Determine if this item is &#039;exposed&#039;.
HandlerBase::placeholder protected function Provides a unique placeholders for handlers.
HandlerBase::postExecute public function Run after the view is executed, before the result is cached. Overrides ViewsHandlerInterface::postExecute
HandlerBase::preQuery public function Run before the view is built. Overrides ViewsHandlerInterface::preQuery 2
HandlerBase::sanitizeValue public function Sanitize the value for output. Overrides ViewsHandlerInterface::sanitizeValue
HandlerBase::setModuleHandler public function Sets the module handler.
HandlerBase::setRelationship public function Sets up any needed relationship. Overrides ViewsHandlerInterface::setRelationship
HandlerBase::setViewsData public function
HandlerBase::showExposeForm public function Shortcut to display the exposed options form. Overrides ViewsHandlerInterface::showExposeForm
HandlerBase::submitExposed public function Submit the exposed handler form.
HandlerBase::submitExposeForm public function Perform any necessary changes to the form exposes prior to storage.
HandlerBase::submitExtraOptionsForm public function Perform any necessary changes to the form values prior to storage. 1
HandlerBase::submitFormCalculateOptions public function Calculates options stored on the handler. 1
HandlerBase::submitGroupByForm public function Perform any necessary changes to the form values prior to storage. 1
HandlerBase::submitTemporaryForm public function Submits a temporary form.
HandlerBase::usesGroupBy public function Provides the handler some groupby. 13
HandlerBase::validateExposed public function Validate the exposed handler form. 5
HandlerBase::validateExtraOptionsForm public function Validate the options form. 1
InOperator::$valueOptions protected property Stores all operations which are available on the form.
InOperator::$valueTitle protected property The filter title.
InOperator::acceptExposedInput public function Determines if the input from a filter should change the generated query. Overrides FilterPluginBase::acceptExposedInput 3
InOperator::adminSummary public function Display the filter on the administrative summary. Overrides FilterPluginBase::adminSummary 2
InOperator::buildExposeForm public function Options form subform for exposed filter options. Overrides FilterPluginBase::buildExposeForm 1
InOperator::defaultExposeOptions public function Provide default options for exposed filters. Overrides FilterPluginBase::defaultExposeOptions
InOperator::defineOptions protected function Information about options for all kinds of purposes will be held here. Overrides FilterPluginBase::defineOptions 1
InOperator::init public function Overrides \Drupal\views\Plugin\views\HandlerBase::init(). Overrides FilterPluginBase::init 2
InOperator::opEmpty protected function
InOperator::operatorOptions public function Build strings from the operators() for &#039;select&#039; options. Overrides FilterPluginBase::operatorOptions 1
InOperator::operators public function Returns an array of operator information, keyed by operator ID. Overrides FilterOperatorsInterface::operators 1
InOperator::operatorValues protected function
InOperator::query public function Add this filter to the query. Overrides FilterPluginBase::query 6
InOperator::reduceValueOptions public function When using exposed filters, we may be required to reduce the set.
InOperator::validate public function Validate that the plugin is correct and can be saved. Overrides FilterPluginBase::validate 1
InOperator::valueForm protected function Options form subform for setting options. Overrides FilterPluginBase::valueForm 3
InOperator::valueSubmit protected function Perform any necessary changes to the form values prior to storage. Overrides FilterPluginBase::valueSubmit 3
ModerationStateFilter::$bundleInfo protected property The bundle information service.
ModerationStateFilter::$entityTypeManager protected property The entity type manager.
ModerationStateFilter::$valueFormType protected property Overrides InOperator::$valueFormType
ModerationStateFilter::$workflowStorage protected property The storage handler of the workflow entity type.
ModerationStateFilter::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides HandlerBase::calculateDependencies
ModerationStateFilter::create public static function Creates an instance of the plugin. Overrides PluginBase::create
ModerationStateFilter::getCacheContexts public function The cache contexts associated with this object. Overrides FilterPluginBase::getCacheContexts
ModerationStateFilter::getCacheTags public function The cache tags associated with this object. Overrides FilterPluginBase::getCacheTags
ModerationStateFilter::getValueOptions public function Gets the value options. Overrides InOperator::getValueOptions
ModerationStateFilter::getWorkflowIds protected function Gets the list of Workflow IDs configured for this filter.
ModerationStateFilter::onDependencyRemoval public function Allows a plugin to define whether it should be removed. Overrides DependentWithRemovalPluginInterface::onDependencyRemoval
ModerationStateFilter::opSimple protected function Overrides InOperator::opSimple
ModerationStateFilter::__construct public function Creates an instance of ModerationStateFilter. Overrides HandlerBase::__construct
ModerationStateJoinViewsHandlerTrait::ensureMyTable public function
PluginBase::$definition public property Plugins&#039; definition.
PluginBase::$displayHandler public property The display object this plugin is for.
PluginBase::$options public property Options for this plugin will be held here.
PluginBase::$position public property The handler position.
PluginBase::$renderer protected property Stores the render API renderer. 3
PluginBase::$usesOptions protected property Denotes whether the plugin has an additional options form. 8
PluginBase::$view public property The top object of a view. 1
PluginBase::destroy public function Clears a plugin. Overrides ViewsPluginInterface::destroy 2
PluginBase::doFilterByDefinedOptions protected function Do the work to filter out stored options depending on the defined options.
PluginBase::filterByDefinedOptions public function Filter out stored options depending on the defined options. Overrides ViewsPluginInterface::filterByDefinedOptions
PluginBase::getAvailableGlobalTokens public function Returns an array of available token replacements. Overrides ViewsPluginInterface::getAvailableGlobalTokens
PluginBase::getProvider public function Returns the plugin provider. Overrides ViewsPluginInterface::getProvider
PluginBase::getRenderer protected function Returns the render API renderer. 1
PluginBase::globalTokenForm public function Adds elements for available core tokens to a form. Overrides ViewsPluginInterface::globalTokenForm
PluginBase::globalTokenReplace public function Returns a string with any core tokens replaced. Overrides ViewsPluginInterface::globalTokenReplace
PluginBase::INCLUDE_ENTITY constant Include entity row languages when listing languages.
PluginBase::INCLUDE_NEGOTIATED constant Include negotiated languages when listing languages.
PluginBase::listLanguages protected function Makes an array of languages, optionally including special languages.
PluginBase::pluginTitle public function Return the human readable name of the display. Overrides ViewsPluginInterface::pluginTitle
PluginBase::preRenderAddFieldsetMarkup public static function Moves form elements into fieldsets for presentation purposes. Overrides ViewsPluginInterface::preRenderAddFieldsetMarkup
PluginBase::preRenderFlattenData public static function Flattens the structure of form elements. Overrides ViewsPluginInterface::preRenderFlattenData
PluginBase::queryLanguageSubstitutions public static function Returns substitutions for Views queries for languages.
PluginBase::setOptionDefaults protected function Fills up the options of the plugin with defaults.
PluginBase::summaryTitle public function Returns the summary of the settings in the display. Overrides ViewsPluginInterface::summaryTitle 6
PluginBase::themeFunctions public function Provide a full list of possible theme templates used by this style. Overrides ViewsPluginInterface::themeFunctions 1
PluginBase::unpackOptions public function Unpacks options over our existing defaults. Overrides ViewsPluginInterface::unpackOptions
PluginBase::usesOptions public function Returns the usesOptions property. Overrides ViewsPluginInterface::usesOptions 8
PluginBase::viewsTokenReplace protected function Replaces Views&#039; tokens in a given string. 1
PluginBase::VIEWS_QUERY_LANGUAGE_SITE_DEFAULT constant Query string to indicate the site default language.
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 6
PluginInspectionInterface::getPluginId public function Gets the plugin ID of the plugin instance. 2
TrustedCallbackInterface::THROW_EXCEPTION constant Untrusted callbacks throw exceptions.
TrustedCallbackInterface::TRIGGER_SILENCED_DEPRECATION constant Untrusted callbacks trigger silenced E_USER_DEPRECATION errors.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.