class Comment

Same name in this branch

9 core/modules/comment/src/Entity/Comment.php \Drupal\comment\Entity\Comment
9 core/modules/comment/src/Plugin/migrate/source/d6/Comment.php \Drupal\comment\Plugin\migrate\source\d6\Comment
9 core/modules/comment/src/Plugin/migrate/source/d7/Comment.php \Drupal\comment\Plugin\migrate\source\d7\Comment
9 core/modules/comment/tests/modules/d6_comment_test/src/Plugin/migrate/source/d6/Comment.php \Drupal\d6_comment_test\Plugin\migrate\source\d6\Comment

Same name in other branches

8.9.x core/modules/comment/src/Entity/Comment.php \Drupal\comment\Entity\Comment
8.9.x core/modules/comment/src/Plugin/views/wizard/Comment.php \Drupal\comment\Plugin\views\wizard\Comment
8.9.x core/modules/comment/src/Plugin/migrate/source/d6/Comment.php \Drupal\comment\Plugin\migrate\source\d6\Comment
8.9.x core/modules/comment/src/Plugin/migrate/source/d7/Comment.php \Drupal\comment\Plugin\migrate\source\d7\Comment
10 core/modules/comment/src/Entity/Comment.php \Drupal\comment\Entity\Comment
10 core/modules/comment/src/Plugin/views/wizard/Comment.php \Drupal\comment\Plugin\views\wizard\Comment
10 core/modules/comment/src/Plugin/migrate/source/d6/Comment.php \Drupal\comment\Plugin\migrate\source\d6\Comment
10 core/modules/comment/src/Plugin/migrate/source/d7/Comment.php \Drupal\comment\Plugin\migrate\source\d7\Comment
11.x core/modules/comment/src/Entity/Comment.php \Drupal\comment\Entity\Comment
11.x core/modules/comment/src/Plugin/views/wizard/Comment.php \Drupal\comment\Plugin\views\wizard\Comment
11.x core/modules/comment/src/Plugin/migrate/source/d6/Comment.php \Drupal\comment\Plugin\migrate\source\d6\Comment
11.x core/modules/comment/src/Plugin/migrate/source/d7/Comment.php \Drupal\comment\Plugin\migrate\source\d7\Comment

Tests creating comment views with the wizard.

Plugin annotation


@ViewsWizard(
  id = "comment",
  base_table = "comment_field_data",
  title = @Translation("Comments")
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
  - class \Drupal\views\Plugin\views\PluginBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\Core\Plugin\ContainerFactoryPluginInterface, \Drupal\views\Plugin\views\ViewsPluginInterface, \Drupal\Component\Plugin\DependentPluginInterface, \Drupal\Core\Security\TrustedCallbackInterface
    - class \Drupal\views\Plugin\views\wizard\WizardPluginBase extends \Drupal\views\Plugin\views\PluginBase implements \Drupal\views\Plugin\views\wizard\WizardInterface
      - class \Drupal\comment\Plugin\views\wizard\Comment extends \Drupal\views\Plugin\views\wizard\WizardPluginBase

Expanded class hierarchy of Comment

348 string references to 'Comment'

ActionTest::providerSource in core/modules/system/tests/src/Kernel/Plugin/migrate/source/ActionTest.php: The data provider.
AuthorNameFormatter::isApplicable in core/modules/comment/src/Plugin/Field/FieldFormatter/AuthorNameFormatter.php: Returns if the formatter can be used for the provided field.
BigPipeRegressionTest::testCommentForm_2698811 in core/modules/ckeditor/tests/src/FunctionalJavascript/BigPipeRegressionTest.php: Ensure comment form works with history and big_pipe modules.
CategoryAutocompleteTest::providerTestAutocompleteSuggestions in core/modules/block/tests/src/Unit/CategoryAutocompleteTest.php: Data provider for testAutocompleteSuggestions().
CategoryAutocompleteTest::setUp in core/modules/block/tests/src/Unit/CategoryAutocompleteTest.php

... See full list

File

core/modules/comment/src/Plugin/views/wizard/Comment.php, line 20

Namespace

Drupal\comment\Plugin\views\wizard

View source

class Comment extends WizardPluginBase {
    
    /**
     * Set the created column.
     *
     * @var string
     */
    protected $createdColumn = 'created';
    
    /**
     * Set default values for the filters.
     */
    protected $filters = [
        'status_node' => [
            'value' => TRUE,
            'table' => 'node_field_data',
            'field' => 'status',
            'plugin_id' => 'boolean',
            'relationship' => 'node',
            'entity_type' => 'node',
            'entity_field' => 'status',
        ],
    ];
    
    /**
     * {@inheritdoc}
     */
    protected function rowStyleOptions() {
        $options = [];
        $options['entity:comment'] = $this->t('comments');
        $options['fields'] = $this->t('fields');
        return $options;
    }
    
    /**
     * {@inheritdoc}
     */
    protected function defaultDisplayOptions() {
        $display_options = parent::defaultDisplayOptions();
        // Add permission-based access control.
        $display_options['access']['type'] = 'perm';
        $display_options['access']['options']['perm'] = 'access comments';
        // Add a relationship to nodes.
        $display_options['relationships']['node']['id'] = 'node';
        $display_options['relationships']['node']['table'] = 'comment_field_data';
        $display_options['relationships']['node']['field'] = 'node';
        $display_options['relationships']['node']['entity_type'] = 'comment_field_data';
        $display_options['relationships']['node']['required'] = 1;
        $display_options['relationships']['node']['plugin_id'] = 'standard';
        // Remove the default fields, since we are customizing them here.
        unset($display_options['fields']);
        
        /* Field: Comment: Title */
        $display_options['fields']['subject']['id'] = 'subject';
        $display_options['fields']['subject']['table'] = 'comment_field_data';
        $display_options['fields']['subject']['field'] = 'subject';
        $display_options['fields']['subject']['entity_type'] = 'comment';
        $display_options['fields']['subject']['entity_field'] = 'subject';
        $display_options['fields']['subject']['label'] = '';
        $display_options['fields']['subject']['alter']['alter_text'] = 0;
        $display_options['fields']['subject']['alter']['make_link'] = 0;
        $display_options['fields']['subject']['alter']['absolute'] = 0;
        $display_options['fields']['subject']['alter']['trim'] = 0;
        $display_options['fields']['subject']['alter']['word_boundary'] = 0;
        $display_options['fields']['subject']['alter']['ellipsis'] = 0;
        $display_options['fields']['subject']['alter']['strip_tags'] = 0;
        $display_options['fields']['subject']['alter']['html'] = 0;
        $display_options['fields']['subject']['hide_empty'] = 0;
        $display_options['fields']['subject']['empty_zero'] = 0;
        $display_options['fields']['subject']['plugin_id'] = 'field';
        $display_options['fields']['subject']['type'] = 'string';
        $display_options['fields']['subject']['settings'] = [
            'link_to_entity' => TRUE,
        ];
        return $display_options;
    }

}

Members

Title Sort descending	Modifiers	Object type	Summary	Overriden Title	Overrides
Comment::$createdColumn	protected	property	Set the created column.	Overrides WizardPluginBase::$createdColumn
Comment::$filters	protected	property	Set default values for the filters.	Overrides WizardPluginBase::$filters
Comment::defaultDisplayOptions	protected	function	Assembles the default display options for the view.	Overrides WizardPluginBase::defaultDisplayOptions
Comment::rowStyleOptions	protected	function	Retrieves row style plugin names.	Overrides WizardPluginBase::rowStyleOptions
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
PluginBase::$definition	public	property	Plugins' 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::$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::buildOptionsForm	public	function	Provide a form to edit options for this plugin.	Overrides ViewsPluginInterface::buildOptionsForm	16
PluginBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin.	Overrides DependentPluginInterface::calculateDependencies	14
PluginBase::defineOptions	protected	function	Information about options for all kinds of purposes will be held here.		18
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::init	public	function	Initialize the plugin.	Overrides ViewsPluginInterface::init	6
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::query	public	function	Add anything to the query that we might need to.	Overrides ViewsPluginInterface::query	8
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::submitOptionsForm	public	function	Handle any special handling on the validate form.	Overrides ViewsPluginInterface::submitOptionsForm	16
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::trustedCallbacks	public static	function	Lists the trusted callbacks provided by the implementing class.	Overrides TrustedCallbackInterface::trustedCallbacks	6
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::validate	public	function	Validate that the plugin is correct and can be saved.	Overrides ViewsPluginInterface::validate	6
PluginBase::validateOptionsForm	public	function	Validate the options form.	Overrides ViewsPluginInterface::validateOptionsForm	15
PluginBase::viewsTokenReplace	protected	function	Replaces Views' 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.
TrustedCallbackInterface::TRIGGER_WARNING		constant	Untrusted callbacks trigger E_USER_WARNING errors.
WizardPluginBase::$availableSorts	protected	property	The available store criteria.
WizardPluginBase::$base_table	protected	property	The base table connected with the wizard.
WizardPluginBase::$bundleInfoService	protected	property	The bundle info service.
WizardPluginBase::$entityType	protected	property	Contains the information from entity_get_info of the $entity_type.
WizardPluginBase::$entityTypeId	protected	property	The entity type connected with the wizard.
WizardPluginBase::$filter_defaults	protected	property	Default values for filters.
WizardPluginBase::$parentFormSelector	protected	property	The parent form selector service.
WizardPluginBase::$sorts	protected	property	Views items configuration arrays for sorts added by the wizard.
WizardPluginBase::$validated_views	protected	property	An array of validated view objects, keyed by a hash.
WizardPluginBase::addDisplays	protected	function	Adds the array of display options to the view, with appropriate overrides.
WizardPluginBase::alterDisplayOptions	protected	function	Alters the full array of display options before they are added to the view.
WizardPluginBase::blockDisplayOptions	protected	function	Retrieves the block display options.		1
WizardPluginBase::buildDisplayOptions	protected	function	Builds an array of display options for the view.		1
WizardPluginBase::buildFilters	protected	function	Builds the form structure for selecting the view's filters.		1
WizardPluginBase::buildForm	public	function	Form callback to build other elements in the "show" form.	Overrides WizardInterface::buildForm
WizardPluginBase::buildFormStyle	protected	function	Adds the style options to the wizard form.
WizardPluginBase::buildSorts	protected	function	Builds the form structure for selecting the view's sort order.
WizardPluginBase::create	public static	function	Creates an instance of the plugin.	Overrides PluginBase::create	1
WizardPluginBase::createView	public	function	Creates a view from values that have already been validated.	Overrides WizardInterface::createView
WizardPluginBase::defaultDisplayFilters	protected	function	Retrieves all filter information used by the default display.
WizardPluginBase::defaultDisplayFiltersUser	protected	function	Retrieves filter information based on user input for the default display.		2
WizardPluginBase::defaultDisplaySorts	protected	function	Retrieves all sort information used by the default display.
WizardPluginBase::defaultDisplaySortsUser	protected	function	Retrieves sort information based on user input for the default display.
WizardPluginBase::getAvailableSorts	public	function	Gets the availableSorts property.		2
WizardPluginBase::getCreatedColumn	public	function	Gets the createdColumn property.
WizardPluginBase::getFilters	public	function	Gets the filters property.		1
WizardPluginBase::getSelected	public static	function	Gets the current value of a #select element, from within a form constructor function.
WizardPluginBase::getSorts	public	function	Gets the sorts property.
WizardPluginBase::instantiateView	protected	function	Instantiates a view object from form values.
WizardPluginBase::pageDisplayOptions	protected	function	Retrieves the page display options.		1
WizardPluginBase::pageFeedDisplayOptions	protected	function	Retrieves the feed display options.
WizardPluginBase::restExportDisplayOptions	protected	function	Retrieves the REST export display options from the submitted form values.
WizardPluginBase::retrieveValidatedView	protected	function	Retrieves a validated view for a form submission.
WizardPluginBase::setDefaultOptions	protected	function	Sets options for a display and makes them the default options if possible.
WizardPluginBase::setOverrideOptions	protected	function	Sets options for a display, inheriting from the defaults when possible.
WizardPluginBase::setValidatedView	protected	function	Stores a validated view from a form submission.
WizardPluginBase::validateView	public	function	Implements Drupal\views\Plugin\views\wizard\WizardInterface::validate().	Overrides WizardInterface::validateView
WizardPluginBase::__construct	public	function	Constructs a WizardPluginBase object.	Overrides PluginBase::__construct	1

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

class Comment

Plugin annotation

Hierarchy

File

Namespace

Members

Search drupal 9

API Navigation

Breadcrumb

class Comment

Plugin annotation

Hierarchy

File

Namespace

Members

Search drupal 9

API Navigation