class DevelGenerate

Same name in other branches
  1. 8.x-1.x devel_generate/src/Annotation/DevelGenerate.php \Drupal\devel_generate\Annotation\DevelGenerate
  2. 4.x devel_generate/src/Annotation/DevelGenerate.php \Drupal\devel_generate\Annotation\DevelGenerate

Defines a DevelGenerate annotation object.

DevelGenerate handle the bulk creation of entites.

Additional annotation keys for DevelGenerate can be defined in hook_devel_generate_info_alter().

Hierarchy

Expanded class hierarchy of DevelGenerate

See also

\Drupal\devel_generate\DevelGeneratePluginManager

\Drupal\devel_generate\DevelGenerateBaseInterface

1 file declares its use of DevelGenerate
DevelGeneratePluginManager.php in devel_generate/src/DevelGeneratePluginManager.php
8 classes are annotated with DevelGenerate
BlockContentDevelGenerate in devel_generate/src/Plugin/DevelGenerate/BlockContentDevelGenerate.php
Provides a BlockContentDevelGenerate plugin.
ContentDevelGenerate in devel_generate/src/Plugin/DevelGenerate/ContentDevelGenerate.php
Provides a ContentDevelGenerate plugin.
ExampleDevelGenerate in devel_generate/tests/modules/devel_generate_example/src/Plugin/DevelGenerate/ExampleDevelGenerate.php
Provides a ExampleDevelGenerate plugin.
MediaDevelGenerate in devel_generate/src/Plugin/DevelGenerate/MediaDevelGenerate.php
Provides a plugin that generates media entities.
MenuDevelGenerate in devel_generate/src/Plugin/DevelGenerate/MenuDevelGenerate.php
Provides a MenuDevelGenerate plugin.

... See full list

File

devel_generate/src/Annotation/DevelGenerate.php, line 21

Namespace

Drupal\devel_generate\Annotation
View source 
class DevelGenerate extends Plugin {
    
    /**
     * The human-readable name of the DevelGenerate type.
     *
     * @ingroup plugin_translatable
     */
    public Translation $label;
    
    /**
     * A short description of the DevelGenerate type.
     *
     * @ingroup plugin_translatable
     */
    public Translation $description;
    
    /**
     * A url to access the plugin settings form.
     */
    public string $url;
    
    /**
     * The permission required to access the plugin settings form.
     */
    public string $permission;
    
    /**
     * The name of the DevelGenerate class.
     *
     * This is not provided manually, it will be added by the discovery mechanism.
     */
    public string $class;
    
    /**
     * An array of settings passed to the DevelGenerate settingsForm.
     *
     * The keys are the names of the settings and the values are the default
     * values for those settings.
     */
    public array $settings = [];
    
    /**
     * Modules that should be enabled in order to make the plugin discoverable.
     */
    public array $dependencies = [];

}

Members

Title Modifiers Object type Summary Overriden Title Overrides
DevelGenerate::$class public property The name of the DevelGenerate class.
DevelGenerate::$dependencies public property Modules that should be enabled in order to make the plugin discoverable.
DevelGenerate::$description public property A short description of the DevelGenerate type.
DevelGenerate::$label public property The human-readable name of the DevelGenerate type.
DevelGenerate::$permission public property The permission required to access the plugin settings form.
DevelGenerate::$settings public property An array of settings passed to the DevelGenerate settingsForm.
DevelGenerate::$url public property A url to access the plugin settings form.
Plugin::$definition protected property The plugin definition read from the class annotation. 1
Plugin::get public function Gets the value of an annotation. Overrides AnnotationInterface::get 6
Plugin::getClass public function Gets the class of the annotated class. Overrides AnnotationInterface::getClass 1
Plugin::getId public function Gets the unique ID for this annotated class. Overrides AnnotationInterface::getId
Plugin::getProvider public function Gets the name of the provider of the annotated class. Overrides AnnotationInterface::getProvider 1
Plugin::parse protected function Parses an annotation into its definition.
Plugin::setClass public function Sets the class of the annotated class. Overrides AnnotationInterface::setClass 1
Plugin::setProvider public function Sets the name of the provider of the annotated class. Overrides AnnotationInterface::setProvider
Plugin::__construct public function Constructs a Plugin object. 3