/drupal7/sites/all/modules/feeds/includes/FeedsConfigurable.inc - Diff - Club Drupal - Forge Centrale Marseille

Révision ed9a13f1

Ajouté par Assos Assos il y a presque 4 ans

ID ed9a13f1ed5cebae0b2b2b611e89e5772fa4cc4c
Parent d0ed0aa6
Enfant 80344a30

Weekly update of contrib modules

+    }
     /**
      * Base class for configurable classes. Captures configuration handling, form
      * handling and distinguishes between in-memory configuration and persistent
      * configuration.
      * Base class for configurable classes.
+     *
      * Captures configuration handling, form handling and distinguishes between
      * in-memory configuration and persistent configuration.
+     *
      * Due to the magic method __get(), protected properties from this class and
      * from classes that extend this class will be publicly readable (but not
-...
      */
     abstract class FeedsConfigurable {
       // Holds the actual configuration information.
       /**
        * Holds the actual configuration information.
+       *
        * @var array
        */
       protected $config;
       // A unique identifier for the configuration.
       /**
        * An unique identifier for the configuration.
+       *
        * @var string
        */
       protected $id;
       /*
       CTools export type of this object.
       @todo Should live in FeedsImporter. Not all child classes
       of FeedsConfigurable are exportable. Same goes for $disabled.
       Export type can be one of
       FEEDS_EXPORT_NONE - the configurable only exists in memory
       EXPORT_IN_DATABASE - the configurable is defined in the database.
       EXPORT_IN_CODE - the configurable is defined in code.
       EXPORT_IN_CODE | EXPORT_IN_DATABASE - the configurable is defined in code, but
                                             overridden in the database.*/
       /**
        * CTools export type of this object.
+       *
        * Export type can be one of:
        * - FEEDS_EXPORT_NONE - the configurable only exists in memory.
        * - EXPORT_IN_DATABASE - the configurable is defined in the database.
        * - EXPORT_IN_CODE - the configurable is defined in code.
        * - EXPORT_IN_CODE | EXPORT_IN_DATABASE - the configurable is defined in
        *   code, but overridden in the database.
+       *
        * @var int
+       *
        * @todo Should live in FeedsImporter. Not all child classes
        * of FeedsConfigurable are exportable. Same goes for $disabled.
        */
       protected $export_type;
       /**
        * CTools export enabled status of this object.
+       *
        * @var bool
        */
       protected $disabled;
       /**
        * Instantiates a FeedsConfigurable object.
        * Provides a statically cached instance of a FeedsConfigurable subclass.
+       *
        * Don't use directly, use feeds_importer() or feeds_plugin() instead.
+       *
        * @param string $class
        *   The name of a subclass of FeedsConfigurable.
        * @param string $id
        *   The ID of this configuration object.
+       *
        * @return FeedsConfigurable
        *   An instance of this class.
+       *
        * @throws InvalidArgumentException
        *   When an empty configuration identifier is passed.
+       *
        * @see feeds_importer()
        * @see feeds_plugin()
        */
       public static function instance($class, $id) {
         // @todo Verify that $class is an existing subclass of FeedsConfigurable.
         if (!strlen($id)) {
           throw new InvalidArgumentException(t('Empty configuration identifier.'));
+        }
-...
       /**
        * Constructor, set id and load default configuration.
+       *
        * @param string $id
        *   The ID of this configuration object.
        */
       protected function __construct($id) {
         // Set this object's id.
-...
+      }
       /**
        * Determine whether this object is persistent and enabled. I. e. it is
        * defined either in code or in the database and it is enabled.
        * Determines whether this object is persistent and enabled.
+       *
        * This means that it exists either in code or in the database and it is
        * enabled.
+       *
        * @return $this
+       *
        * @throws FeedsNotExistingException
        *   When the object is not persistent or is not enabled.
        */
       public function existing() {
         if (!$this->doesExist()) {
-...
+      }
       /**
        * Save a configuration. Concrete extending classes must implement a save
        * operation.
        * Saves a configuration.
+       *
        * Concrete extending classes must implement a save operation.
        */
       public abstract function save();
       abstract public function save();
       /**
        * Copy a configuration.
+       *
        * @param FeedsConfigurable $configurable
        *   The FeedsConfigurable instance to take the configuration from.
        */
       public function copy(FeedsConfigurable $configurable) {
         $this->setConfig($configurable->config);
-...
       /**
        * Set configuration.
+       *
        * @param $config
        * @param array $config
        *   Array containing configuration information. Config array will be filtered
        *   by the keys returned by configDefaults() and populated with default
        *   values that are not included in $config.
-...
       /**
        * Similar to setConfig but adds to existing configuration.
+       *
        * @param $config
        * @param array $config
        *   Array containing configuration information. Will be filtered by the keys
        *   returned by configDefaults().
        */
-...
       /**
        * Implements getConfig().
+       *
        * Return configuration array, ensure that all default values are present.
        * Returns configuration array, ensure that all default values are present.
+       *
        * @return array
        *   The configuration for this object.
        */
       public function getConfig() {
         $defaults = $this->configDefaults();
-...
+      }
       /**
        * Return configuration form for this object. The keys of the configuration
        * form must match the keys of the array returned by configDefaults().
        * Returns configuration form for this object.
+       *
        * The keys of the configuration form must match the keys of the array
        * returned by configDefaults().
+       *
        * @param array $form_state
        *   The current state of the form.
+       *
        * @return
        * @return array
        *   FormAPI style form definition.
        */
       public function configForm(&$form_state) {
-...
+       *
        * Set errors with form_set_error().
+       *
        * @param $values
        * @param array $values
        *   An array that contains the values entered by the user through configForm.
        */
       public function configFormValidate(&$values) {
+      }
       /**
        *  Submission handler for configForm().
        * Submission handler for configForm().
+       *
        *  @param $values
        * @param array $values
        *   An array that contains the values entered by the user through configForm.
        */
       public function configFormSubmit(&$values) {
         $this->addConfig($values);
-...
       public function dependencies() {
         return array();
+      }
+    }
     /**
      * Config form wrapper. Use to render the configuration form of
      * a FeedsConfigurable object.
      * FeedsConfigurable config form wrapper.
+     *
      * @param $configurable
      *   FeedsConfigurable object.
      * @param $form_method
      * Used to render the configuration form of a FeedsConfigurable object.
+     *
      * @param FeedsConfigurable $configurable
      *   The FeedsConfigurable instance for which a configuration form must be
      *   rendered.
      * @param string $form_method
      *   The form method that should be rendered.
+     *
      * @return
      * @return array|null
      *   Config form array if available. NULL otherwise.
      */
     function feeds_get_form($configurable, $form_method) {
     function feeds_get_form(FeedsConfigurable $configurable, $form_method) {
       if (method_exists($configurable, $form_method)) {
         return drupal_get_form(get_class($configurable) . '_feeds_form', $configurable, $form_method);
+      }
+    }
     /**
      * Config form callback. Don't call directly, but use
      * Form constructor for a Feeds configuration form.
+     *
      * Don't call directly, but use
      * feeds_get_form($configurable, 'method') instead.
+     *
      * @param
      *   FormAPI $form_state.
      * @param
      *   FeedsConfigurable object.
      * @param
      * @param array $form
      *   The form.
      * @param array $form_state
      *   The current state of the form.
      * @param FeedsConfigurable $configurable
      *   The object to perform the save() operation on.
      * @param $form_method
      * @param string $form_method
      *   The $form_method that should be rendered.
+     *
      * @return array
      *   Form array.
      */
     function feeds_form($form, &$form_state, $configurable, $form_method) {
     function feeds_form(array $form, array &$form_state, FeedsConfigurable $configurable, $form_method) {
       $form = $configurable->$form_method($form_state);
       $form['#configurable'] = $configurable;
       $form['#feeds_form_method'] = $form_method;
-...
+    }
     /**
      * Validation handler for feeds_form().
      * Form validation handler for feeds_form().
+     *
      * @see feeds_form()
      */
     function feeds_form_validate($form, &$form_state) {
       _feeds_form_helper($form, $form_state, 'Validate');
-...
     /**
      * Submit handler for feeds_form().
+     *
      * @see feeds_form()
      */
     function feeds_form_submit($form, &$form_state) {
       _feeds_form_helper($form, $form_state, 'Submit');
-...
     /**
      * Helper for Feeds validate and submit callbacks.
+     *
      * @param array $form
      *   The form.
      * @param array $form_state
      *   The current state of the form.
      * @param string $action
      *   The action to perform on the form, for example:
      *   - Validate;
      *   - Submit.
+     *
      * @todo This is all terrible. Remove.
      */
     function _feeds_form_helper($form, &$form_state, $action) {
     function _feeds_form_helper(array $form, array &$form_state, $action) {
       $method = $form['#feeds_form_method'] . $action;
       $class = get_class($form['#configurable']);
       $id = $form['#configurable']->id;

Formats disponibles : Unified diff

Projet

Général

Profil

Club Drupal

Révision ed9a13f1

Ajouté par Assos Assos il y a presque 4 ans