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

Révision ed9a13f1

Ajouté par Assos Assos il y a plus de 3 ans

ID ed9a13f1ed5cebae0b2b2b611e89e5772fa4cc4c
Parent d0ed0aa6
Enfant 80344a30

Weekly update of contrib modules

     /**
      * @file
      * Definition of FeedsSourceInterface and FeedsSource class.
      * Definition of FeedsSourceInterface, FeedsState and FeedsSource class.
      */
     /**
-...
     define('FEEDS_PROCESS_EXPIRE', 'process_expire');
     /**
      * Declares an interface for a class that defines default values and form
      * descriptions for a FeedSource.
      * Defines an interface for a feed source.
      */
     interface FeedsSourceInterface {
       /**
        * Returns if a plugin handles source specific configuration.
+       *
        * Crutch: for ease of use, we implement FeedsSourceInterface for every
        * plugin, but then we need to have a handle which plugin actually implements
        * a source.
        * source configuration.
+       *
        * @see FeedsPlugin class.
        * @see FeedsPlugin
+       *
        * @return
        * @return bool
        *   TRUE if a plugin handles source specific configuration, FALSE otherwise.
        */
       public function hasSourceConfig();
-...
       public function sourceDefaults();
       /**
        * Return a Form API form array that defines a form configuring values. Keys
        * correspond to the keys of the return value of sourceDefaults().
        * Returns a Form API form array that defines a form configuring values.
+       *
        * Keys correspond to the keys of the return value of sourceDefaults().
        */
       public function sourceForm($source_config);
-...
        * A source is being deleted.
        */
       public function sourceDelete(FeedsSource $source);
+    }
     /**
      * Status of an import or clearing operation on a source.
      */
     class FeedsState {
       /**
        * Floating point number denoting the progress made. 0.0 meaning no progress
        * 1.0 = FEEDS_BATCH_COMPLETE meaning finished.
        * Floating point number denoting the progress made.
+       *
        * 0.0 meaning no progress.
        * 1.0 = FEEDS_BATCH_COMPLETE, meaning finished.
+       *
        * @var float
        */
       public $progress;
       /**
        * Used as a pointer to store where left off. Must be serializable.
+       *
        * @var mixed
        */
       public $pointer;
       /**
        * Natural numbers denoting more details about the progress being made.
+       *
        * @var int
        */
       public $total;
       public $created;
-...
       /**
        * IDs of entities to be removed.
+       *
        * @var array
        */
       public $removeList;
-...
        */
       public function __construct() {
         $this->progress = FEEDS_BATCH_COMPLETE;
         $this->total =
         $this->created =
         $this->updated =
         $this->deleted =
         $this->unpublished =
         $this->blocked =
         $this->skipped =
         $this->failed = 0;
         $this->total
           = $this->created
           = $this->updated
           = $this->deleted
           = $this->unpublished
           = $this->blocked
           = $this->skipped
           = $this->failed
           = 0;
+      }
       /**
-...
        * - $progress is larger than $total
        * - $progress approximates $total so that $finished rounds to 1.0
+       *
        * @param $total
        * @param int $total
        *   A natural number that is the total to be worked off.
        * @param $progress
        * @param int $progress
        *   A natural number that is the progress made on $total.
        */
       public function progress($total, $progress) {
-...
           $this->progress = FEEDS_BATCH_COMPLETE;
+        }
+      }
+    }
     /**
      * Holds the source of a feed to import.
+     *
      * This class encapsulates a source of a feed. It stores where the feed can be
      * found and how to import it.
+     *
-...
      */
     class FeedsSource extends FeedsConfigurable {
       // Contains the node id of the feed this source info object is attached to.
       // Equals 0 if not attached to any node - i. e. if used on a
       // standalone import form within Feeds or by other API users.
       /**
        * Contains the node id of the feed this source info object is attached to.
+       *
        * Equals 0 if not attached to any node - for example when used on a
        * standalone import form within Feeds or by other API users.
+       *
        * @var int
        */
       protected $feed_nid;
       // The FeedsImporter object that this source is expected to be used with.
       /**
        * The FeedsImporter object that this source is expected to be used with.
+       *
        * @var FeedsImporter
        */
       protected $importer;
       // A FeedsSourceState object holding the current import/clearing state of this
       // source.
       /**
        * Holds the current state of an import, clear or expire task.
+       *
        * Array keys can be:
        * - FEEDS_START
        *   Timestamp of when a task has started.
        * - FEEDS_FETCH
        *   A FeedsState object holding the state of the fetch stage, used during
        *   imports.
        * - FEEDS_PARSE
        *   A FeedsState object holding the state of the parse stage, used during
        *   imports.
        * - FEEDS_PROCESS
        *   A FeedsState object holding the state of the process stage, used during
        *   imports.
        * - FEEDS_PROCESS_CLEAR
        *   A FeedsState object holding the state of the clear task.
        * - FEEDS_PROCESS_EXPIRE
        *   A FeedsState object holding the state of the expire task.
+       *
        * @var FeedsState[]|array|null
        */
       protected $state;
       // Fetcher result, used to cache fetcher result when batching.
       /**
        * Fetcher result, used to cache fetcher result when batching.
+       *
        * @var FeedsFetcherResult
        */
       protected $fetcher_result;
       // Timestamp when this source was imported the last time.
       /**
        * Timestamp of when this source was imported the last time.
+       *
        * @var int
        */
       protected $imported;
       // Holds an exception object in case an exception occurs during importing.
       /**
        * Holds an exception object in case an exception occurs during importing.
+       *
        * @var Exception|null
        */
       protected $exception;
       /**
        * Instantiate a unique object per class/id/feed_nid. Don't use
        * directly, use feeds_source() instead.
        * The account switcher.
+       *
        * @var FeedsAccountSwitcherInterface
        */
       public static function instance($importer_id, $feed_nid) {
       protected $accountSwitcher;
       /**
        * Instantiates an unique FeedsSource per class, importer ID and Feed node ID.
+       *
        * Don't use this method directly, use feeds_source() instead.
+       *
        * @param string $importer_id
        *   The machine name of the importer.
        * @param int $feed_nid
        *   The node id of a feed node if the source is attached to a feed node.
        * @param FeedsAccountSwitcherInterface $account_switcher
        *   The account switcher to use to be able to perform actions as a different
        *   user.
        */
       public static function instance($importer_id, $feed_nid, FeedsAccountSwitcherInterface $account_switcher = NULL) {
         $class = variable_get('feeds_source_class', 'FeedsSource');
         $instances = &drupal_static(__METHOD__, array());
         if (!isset($instances[$class][$importer_id][$feed_nid])) {
           $instances[$class][$importer_id][$feed_nid] = new $class($importer_id, $feed_nid);
           $instances[$class][$importer_id][$feed_nid] = new $class($importer_id, $feed_nid, $account_switcher);
+        }
         return $instances[$class][$importer_id][$feed_nid];
+      }
       /**
        * Constructor.
+       *
        * @param string $importer_id
        *   The machine name of the importer.
        * @param int $feed_nid
        *   The feed node ID for this Feeds source. This should be '0' if the
        *   importer is not attached to a content type.
        * @param FeedsAccountSwitcherInterface $account_switcher
        *   The account switcher to use to be able to perform actions as a different
        *   user.
        */
       protected function __construct($importer_id, $feed_nid) {
       protected function __construct($importer_id, $feed_nid, FeedsAccountSwitcherInterface $account_switcher = NULL) {
         $this->feed_nid = $feed_nid;
         $this->importer = feeds_importer($importer_id);
         if (is_null($account_switcher)) {
           $this->accountSwitcher = new FeedsAccountSwitcher();
+        }
         else {
           $this->accountSwitcher = $account_switcher;
+        }
         parent::__construct($importer_id);
         $this->load();
+      }
       /**
        * Returns the FeedsImporter object that this source is expected to be used with.
        * Returns the FeedsImporter object for this source.
+       *
        * @return FeedsImporter
        *   The importer associated with this Feeds source.
        */
       public function importer() {
         return $this->importer;
-...
       /**
        * Preview = fetch and parse a feed.
+       *
        * @return
        *   FeedsParserResult object.
        * @return FeedsParserResult
        *   A FeedsParserResult instance.
+       *
        * @throws
        *   Throws Exception if an error occurs when fetching or parsing.
        * @throws Exception
        *   If an error occurs when fetching or parsing.
        */
       public function preview() {
         $result = $this->importer->fetcher->fetch($this);
-...
        * Schedule periodic or background import tasks.
+       *
        * @param bool $force
        *   (optional) force scheduling to happen.
        *   (optional) If true, forces the scheduling to happen.
        *   Defaults to true.
        */
       public function scheduleImport($force = TRUE) {
-...
        * Schedule background expire tasks.
+       *
        * @param bool $force
        *   (optional) force scheduling to happen.
        *   (optional) If true, forces the scheduling to happen.
        *   Defaults to true.
        */
       public function scheduleExpire($force = TRUE) {
-...
        * This method only executes the current batch chunk, then returns. If you are
        * looking to import an entire source, use FeedsSource::startImport() instead.
+       *
        * @return
        * @return float
        *   FEEDS_BATCH_COMPLETE if the import process finished. A decimal between
        *   0.0 and 0.9 periodic if import is still in progress.
+       *
        * @throws
        *   Throws Exception if an error occurs when importing.
        * @throws Exception
        *   In case an error occurs when importing.
        */
       public function import() {
         $this->acquireLock();
-...
        * looking to delete all items of a source, use FeedsSource::startClear()
        * instead.
+       *
        * @return
        * @return float
        *   FEEDS_BATCH_COMPLETE if the clearing process finished. A decimal between
        *   0.0 and 0.9 periodic if clearing is still in progress.
+       *
        * @throws
        *   Throws Exception if an error occurs when clearing.
        * @throws Exception
        *   In case an error occurs when clearing.
        */
       public function clear() {
         $this->acquireLock();
-...
       /**
        * Return a state object for a given stage. Lazy instantiates new states.
+       *
        * @todo Rename getConfigFor() accordingly to config().
+       *
        * @param $stage
        * @param string $stage
        *   One of FEEDS_FETCH, FEEDS_PARSE, FEEDS_PROCESS or FEEDS_PROCESS_CLEAR.
+       *
        * @return
        * @return FeedsState|mixed
        *   The FeedsState object for the given stage.
        *   In theory, this could return something else, if $this->state has been
        *   polluted with e.g. integer timestamps.
+       *
        * @see FeedsSource::$state
        */
       public function state($stage) {
         if (!is_array($this->state)) {
-...
+          }
           // Special case for PostgreSQL: if using that database type, we cannot
           // search in the data column of the queue table, because the Drupal database
           // layer adds '::text' to bytea columns, which results into the data column
           // becoming unreadable in conditions. So instead, we check for the first 10
           // records in the queue to see if the given importer ID + feed NID is
           // amongst them.
           // search in the data column of the queue table, because the Drupal
           // database layer adds '::text' to bytea columns, which results into the
           // data column becoming unreadable in conditions. So instead, we check for
           // the first 10 records in the queue to see if the given importer ID +
           // feed NID is amongst them.
           if (Database::getConnection()->databaseType() == 'pgsql') {
             $items = db_query("SELECT data, created FROM {queue} WHERE name = :name AND expire = 0 LIMIT 10", array(
               ':name' => 'feeds_source_import',
-...
       public function unlock() {
         $this->clearStates();
         $this->save();
         $this->releaseLock();
         try {
           $this->releaseLock();
+        }
         catch (FeedsAccountSwitcherException $exception) {
           // Ignore switch back exceptions.
+        }
+      }
       /**
-...
        * @todo Patch CTools to move constants from export.inc to ctools.module.
        */
       public function load() {
         if ($record = db_query("SELECT imported, config, state, fetcher_result FROM {feeds_source} WHERE id = :id AND feed_nid = :nid", array(':id' => $this->id, ':nid' => $this->feed_nid))->fetchObject()) {
         $record = db_query("SELECT imported, config, state, fetcher_result FROM {feeds_source} WHERE id = :id AND feed_nid = :nid", array(
           ':id' => $this->id,
           ':nid' => $this->feed_nid,
         ))->fetchObject();
         if ($record) {
           // While FeedsSource cannot be exported, we still use CTool's export.inc
           // export definitions.
           ctools_include('export');
-...
+      }
       /**
        * Delete configuration. Removes configuration information
        * from database, does not delete configuration itself.
        * Removes the feed source from the database.
        */
       public function delete() {
         // Alert implementers of FeedsSourceInterface to the fact that we're
-...
       /**
        * Only return source if configuration is persistent and valid.
+       *
        * @see FeedsConfigurable::existing().
        * @see FeedsConfigurable::existing()
        */
       public function existing() {
         // Ensure that the source configuration is valid.
-...
        * @param FeedsSourceInterface $client
        *   An object that is an implementer of FeedsSourceInterface.
+       *
        * @return
        * @return array
        *   An array stored for $client.
        */
       public function getConfigFor(FeedsSourceInterface $client) {
-...
+       *
        * @param FeedsSourceInterface $client
        *   An object that is an implementer of FeedsSourceInterface.
        * @param $config
        * @param array $config
        *   The configuration for $client.
+       *
        * @return
        *   An array stored for $client.
        */
       public function setConfigFor(FeedsSourceInterface $client, $config) {
       public function setConfigFor(FeedsSourceInterface $client, array $config) {
         $this->config[get_class($client)] = $config;
+      }
       /**
        * Return defaults for feed configuration.
+       *
        * @return array
        *   The default feed configuration, keyed per Feeds plugin.
        */
       public function configDefaults() {
         // Collect information from plugins.
-...
       /**
        * Background job helper. Starts a background job using the Drupal queue.
+       *
        * @see FeedsSource::startImport().
        * @see FeedsSource::startClear().
+       *
        * @param string $method
        *   Method to execute on importer; one of 'import' or 'clear'.
+       *
        * @see FeedsSource::startImport()
        * @see FeedsSource::startClear()
        */
       protected function startBackgroundJob($method) {
         $job = array(
-...
       /**
        * Batch API helper. Starts a Batch API job.
+       *
        * @see FeedsSource::startImport().
        * @see FeedsSource::startClear().
        * @see feeds_batch()
+       *
        * @param $title
        * @param string $title
        *   Title to show to user when executing batch.
        * @param $method
        * @param string $method
        *   Method to execute on importer; one of 'import' or 'clear'.
+       *
        * @see FeedsSource::startImport()
        * @see FeedsSource::startClear()
        * @see feeds_batch()
        */
       protected function startBatchAPIJob($title, $method) {
         $batch = array(
-...
         if (!lock_acquire("feeds_source_{$this->id}_{$this->feed_nid}", 60.0)) {
           throw new FeedsLockException(t('Cannot acquire lock for source @id / @feed_nid.', array('@id' => $this->id, '@feed_nid' => $this->feed_nid)));
+        }
         // Switch account.
         $this->switchAccount();
+      }
       /**
-...
        */
       protected function releaseLock() {
         lock_release("feeds_source_{$this->id}_{$this->feed_nid}");
         // Switch back to original account.
         $this->switchBack();
+      }
       /**
        * Switches account to the feed owner or user 1.
+       *
        * To the feed owner is switched if the importer is attached to a content
        * type. When using the standalone form, there is no feed owner, so then a
        * switch to user 1 happens instead.
        */
       protected function switchAccount() {
         // Use author of feed node.
         if ($this->feed_nid) {
           $node = node_load($this->feed_nid);
           if (!empty($node->uid)) {
             $account = user_load($node->uid);
+          }
+        }
         // If the owner of the feed node is anonymous or if the importer is not
         // attached to a content type, pick user 1 instead.
         if (empty($account)) {
           $account = user_load(1);
+        }
         $this->accountSwitcher->switchTo($account);
+      }
       /**
        * Switches back to the original user.
        */
       protected function switchBack() {
         $this->accountSwitcher->switchBack();
+      }
       /**

Formats disponibles : Unified diff

Projet

Général

Profil

Club Drupal

Révision ed9a13f1

Ajouté par Assos Assos il y a plus de 3 ans