X-Git-Url: http://www.aleph1.co.uk/gitweb/?a=blobdiff_plain;f=web%2Fmodules%2Fcontrib%2Fdevel%2Fdevel_generate%2Fsrc%2FDevelGenerateBaseInterface.php;fp=web%2Fmodules%2Fcontrib%2Fdevel%2Fdevel_generate%2Fsrc%2FDevelGenerateBaseInterface.php;h=c2b814a2bc6c038e8537fa991603d4df624bd4d4;hb=a2bd1bf0c2c1f1a17d188f4dc0726a45494cefae;hp=0000000000000000000000000000000000000000;hpb=57c063afa3f66b07c4bbddc2d6129a96d90f0aad;p=yaffs-website

diff --git a/web/modules/contrib/devel/devel_generate/src/DevelGenerateBaseInterface.php b/web/modules/contrib/devel/devel_generate/src/DevelGenerateBaseInterface.php
new file mode 100644
index 000000000..c2b814a2b
--- /dev/null
+++ b/web/modules/contrib/devel/devel_generate/src/DevelGenerateBaseInterface.php
@@ -0,0 +1,77 @@
+<?php
+
+namespace Drupal\devel_generate;
+
+use Drupal\Component\Plugin\PluginInspectionInterface;
+use Drupal\Core\Form\FormStateInterface;
+
+/**
+ * Base interface definition for "DevelGenerate" plugins.
+ *
+ * This interface details base wrapping methods that most DevelGenerate implementations
+ * will want to directly inherit from Drupal\devel_generate\DevelGenerateBase.
+ *
+ * DevelGenerate impementationa plugins should developing settingsForm() and generateElements()
+ * to achieve its own behaviour.
+ *
+ */
+interface DevelGenerateBaseInterface extends PluginInspectionInterface {
+
+  /**
+   * Returns the array of settings, including defaults for missing settings.
+   *
+   * @return array
+   *   The array of settings.
+   */
+  function getSetting($key);
+
+  /**
+   * Returns the default settings for the plugin.
+   *
+   * @return array
+   *   The array of default setting values, keyed by setting names.
+   */
+  function getDefaultSettings();
+
+  /**
+   * Returns the current settings for the plugin.
+   *
+   * @return array
+   *   The array of current setting values, keyed by setting names.
+   */
+  function getSettings();
+
+  /**
+   * Returns the form for the plugin.
+   *
+   * @return array
+   *   The array of default setting values, keyed by setting names.
+   */
+  function settingsForm(array $form, FormStateInterface $form_state);
+
+  /**
+   * Form validation handler.
+   *
+   * @param array $form
+   *   An associative array containing the structure of the form.
+   * @param \Drupal\Core\Form\FormStateInterface $form_state
+   *   The current state of the form.
+   */
+  function settingsFormValidate(array $form, FormStateInterface $form_state);
+
+  /**
+   * Execute the instructions in common for all DevelGenerate plugin
+   *
+   * @param array $values
+   *   The input values from the settings form.
+   */
+  function generate(array $values);
+
+  /**
+   * Responsible for validating Drush params.
+   *
+   * @Return an array of values ready to be used for generateElements()
+   */
+  function validateDrushParams($args);
+
+}