/drupal7/sites/all/modules/rules/includes/rules.state.inc - Diff - Club Drupal - Forge Centrale Marseille

Révision 950416da

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

ID 950416da18ccc6556a1242fc2a59d3ae096045a0
Parent 0a17cb7f
Enfant cd5c298a

Weekly update of contrib modules

     <?php
     /**
      * @file Contains the state and data related stuff.
      * @file
      * Contains the state and data related stuff.
      */
     /**
-...
       /**
        * Globally keeps the ids of rules blocked due to recursion prevention.
+       *
        * @var array
        */
       static protected $blocked = array();
       /**
        * The known variables.
+       *
        * @var array
        */
       public $variables = array();
       /**
        * Holds info about the variables.
+       *
        * @var array
        */
       protected $info = array();
-...
       protected $save;
       /**
        * Holds the arguments while an element is executed. May be used by the
        * element to easily access the wrapped arguments.
        * Holds the arguments while an element is executed.
+       *
        * May be used by the element to easily access the wrapped arguments.
        */
       public $currentArguments;
-...
        */
       protected $currentlyBlocked;
       /**
        * Constructs a RulesState object.
        */
       public function __construct() {
         // Use an object in order to ensure any cloned states reference the same
         // save information.
-...
+       *
        * If necessary, the specified handler is invoked to fetch the variable.
+       *
        * @param $name
        * @param string $name
        *   The name of the variable to return.
+       *
        * @return
-...
+       *
        * @param $selector
        *   The data selector of the wrapper to save or just a variable name.
        * @param $immediate
        * @param $wrapper
        * @param bool $immediate
        *   Pass FALSE to postpone saving to later on. Else it's immediately saved.
        */
       public function saveChanges($selector, $wrapper, $immediate = FALSE) {
-...
+      }
       /**
        * Merges the info about to be saved variables form the given state into the
        * existing state. Therefor we can aggregate saves from invoked components.
        * Merged in saves are removed from the given state, but not mergable saves
        * Merges info from the given state into the existing state.
+       *
        * Merges the info about to-be-saved variables from the given state into the
        * existing state. Therefore we can aggregate saves from invoked components.
        * Merged-in saves are removed from the given state, but not-mergeable saves
        * remain there.
+       *
        * @param $state
-...
       /**
        * Returns an entity metadata wrapper as specified in the selector.
+       *
        * @param $selector
        * @param string $selector
        *   The selector string, e.g. "node:author:mail".
        * @param $langcode
        * @param string $langcode
        *   (optional) The language code used to get the argument value if the
        *   argument value should be translated. Defaults to LANGUAGE_NONE.
+       *
-...
         try {
           foreach (explode(':', $parts[1]) as $name) {
             if ($wrapper instanceof EntityListWrapper || $wrapper instanceof EntityStructureWrapper) {
               // Make sure we are usign the right language. Wrappers might be cached
               // Make sure we are using the right language. Wrappers might be cached
               // and have previous langcodes set, so always set the right language.
               if ($wrapper instanceof EntityStructureWrapper) {
                 $wrapper->language($langcode);
-...
       /**
        * Magic method. Only serialize variables and their info.
+       *
        * Additionally we remember currently blocked configs, so we can restore them
        * upon deserialization using restoreBlocks().
        */
       public function __sleep () {
       public function __sleep() {
         $this->currentlyBlocked = self::$blocked;
         return array('info', 'variables', 'currentlyBlocked');
+      }
       /**
        * Magic method. Unserialize variables and their info.
        */
       public function __wakeup() {
         $this->save = new ArrayObject();
+      }
       /**
        * Restore the before serialization blocked configurations.
        * Restores the before-serialization blocked configurations.
+       *
        * Warning: This overwrites any possible currently blocked configs. Thus
        * do not invoke this method, if there might be evaluations active.
        * do not invoke this method if there might be evaluations active.
        */
       public function restoreBlocks() {
         self::$blocked = $this->currentlyBlocked;
+      }
       /**
        * Defines always available variables.
        * Defines always-available variables.
+       *
        * @param $key
        *   (optional)
        */
       public static function defaultVariables($key = NULL) {
         // Add a variable for accessing site-wide data properties.
-...
         );
         return isset($key) ? $vars[$key] : $vars;
+      }
+    }
     /**
      * A class holding static methods related to data.
      */
     class RulesData  {
     class RulesData {
       /**
        * Returns whether the type match. They match if type1 is compatible to type2.
-...
        *   The name of the type to check for whether it is compatible to type2.
        * @param $param_info
        *   The type expression to check for.
        * @param $ancestors
        *   Whether sub-type relationships for checking type compatibility should be
        *   taken into account. Defaults to TRUE.
        * @param bool $ancestors
        *   (optional) Whether sub-type relationships for checking type compatibility
        *   should be taken into account. Defaults to TRUE.
+       *
        * @return
        * @return bool
        *   Whether the types match.
        */
       public static function typesMatch($var_info, $param_info, $ancestors = TRUE) {
-...
           $cache = &rules_get_cache();
           self::typeCalcAncestors($cache, $var_type);
           // If one of the types is an ancestor return TRUE.
           return (bool)array_intersect_key($cache['data_info'][$var_type]['ancestors'], array_flip($valid_types));
           return (bool) array_intersect_key($cache['data_info'][$var_type]['ancestors'], array_flip($valid_types));
+        }
         return FALSE;
+      }
-...
+      }
       /**
        * Returns matching data variables or properties for the given info and the to
        * be configured parameter.
        * Returns data for the given info and the to-be-configured parameter.
+       *
        * Returns matching data variables or properties for the given info and the
        * to-be-configured parameter.
+       *
        * @param $source
        *   Either an array of info about available variables or a entity metadata
        *   wrapper.
        * @param $param_info
        *   The information array about the to be configured parameter.
        * @param $prefix
        * @param string $prefix
        *   An optional prefix for the data selectors.
        * @param $recursions
        * @param int $recursions
        *   The number of recursions used to go down the tree. Defaults to 2.
        * @param $suggestions
        * @param bool $suggestions
        *   Whether possibilities to recurse are suggested as soon as the deepest
        *   level of recursions is reached. Defaults to TRUE.
+       *
        * @return
        *  An array of info about matching variables or properties that match, keyed
        *  with the data selector.
        * @return array
        *   An array of info about matching variables or properties that match, keyed
        *   with the data selector.
        */
       public static function matchingDataSelector($source, $param_info, $prefix = '', $recursions = 2, $suggestions = TRUE) {
         // If an array of info is given, get entity metadata wrappers first.
-...
               $matches += self::matchingDataSelector($wrapper, $param_info, $prefix . $name . ':', $recursions - 1, $suggestions);
+            }
             elseif ($suggestions) {
               // We may not recurse any more, but indicate the possibility to recurse.
               // We may not recurse any more,
               // but indicate the possibility to recurse.
               $matches[$prefix . $name . ':'] = $wrapper->info();
               if (!is_array($source) && $source instanceof EntityListWrapper) {
                 // Add some more possible list items.
-...
+      }
       /**
        * Adds asserted metadata to the variable info. In case there are already
        * assertions for a variable, the assertions are merged such that both apply.
        * Adds asserted metadata to the variable info.
+       *
        * In case there are already assertions for a variable, the assertions are
        * merged such that both apply.
+       *
        * @see RulesData::applyMetadataAssertions()
        */
-...
+      }
       /**
        * Property info alter callback for the entity metadata wrapper for applying
        * the rules metadata assertions.
        * Property info alter callback for the entity metadata wrapper.
+       *
        * Used for applying the rules metadata assertions.
+       *
        * @see RulesData::addMetadataAssertions()
        */
-...
             $property_info['properties'][$key]['rules assertion'] = $assertion[$key];
             $property_info['properties'][$key]['property info alter'] = array('RulesData', 'applyMetadataAssertions');
             // Apply any 'type' and 'bundle' assertion directly to the propertyinfo.
             // Apply any 'type' and 'bundle' assertion directly to the property
             // info.
             if (isset($assertion[$key]['#info']['type'])) {
               $type = $assertion[$key]['#info']['type'];
               // Support asserting a type in case of generic entity references only.
-...
+      }
       /**
        * Property info alter callback for the entity metadata wrapper to inject
        * metadata for the 'site' variable. In contrast to doing this via
        * hook_rules_data_info() this callback makes use of the already existing
        * Property info alter callback for the entity metadata wrapper.
+       *
        * Used to inject metadata for the 'site' variable. In contrast to doing this
        * via hook_rules_data_info() this callback makes use of the already existing
        * property info cache for site information of entity metadata.
+       *
        * @see RulesPlugin::availableVariables()
-...
         // have specified further metadata.
         return RulesData::applyMetadataAssertions($wrapper, $property_info);
+      }
+    }
     /**
-...
        *   The type of the passed data.
        * @param $data
        *   Optional. The data to wrap or its identifier.
        * @param $info
        * @param array $info
        *   Optional. Used internally to pass info about properties down the tree.
        */
       public function __construct($type, $data = NULL, $info = array()) {
-...
+      }
       /**
        * Prepare for serializiation.
        * Prepare for serialization.
        */
       public function __sleep() {
         $vars = parent::__sleep();
-...
         return $vars;
+      }
       /**
        * Prepare for unserialization.
        */
       public function __wakeup() {
         if ($this->id !== FALSE) {
           // Make sure data is set, so the data will be loaded when needed.
-...
        *   The loaded data object, or FALSE if loading failed.
        */
       abstract protected function load($id);
+    }
     /**
      * Interface that allows custom wrapper classes to declare that they are savable.
      * Used to declare custom wrapper classes as savable.
      */
     interface RulesDataWrapperSavableInterface {
-...
        * Save the currently wrapped data.
        */
       public function save();
+    }

Formats disponibles : Unified diff

Projet

Général

Profil

Club Drupal

Révision 950416da

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