/drupal7/sites/all/modules/rules/ui/ui.core.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 core ui functions.
      * @file
      * Contains core Rules UI functions.
      */
     /**
-...
     interface RulesPluginUIInterface {
       /**
        * Adds the whole configuration form of this rules configuration. For rule
        * elements that are part of a configuration this method just adds the
        * elements configuration form.
        * Adds the whole configuration form of this rules configuration.
+       *
        * For rule elements that are part of a configuration this method just adds
        * the elements configuration form.
+       *
        * @param $form
        *   The form array where to add the form.
-...
        *    - 'restrict events': Optionally set an array of event names to restrict
        *      the events that are available for adding.
+       *
        *  @todo
        *    Implement the 'restrict *' options.
        * @todo Implement the 'restrict *' options.
        */
       public function form(&$form, &$form_state, $options = array());
-...
       public function form_validate($form, &$form_state);
       /**
        * Form submit handler for the element configuration form.
+       *
        * Submit the configuration form of this rule element. This makes sure to
        * put the updated configuration in the form state. For saving changes
        * permanently, just call $config->save() afterwards.
-...
+        }
         return isset($this->index[$id]) ? $this->index[$id] : FALSE;
+      }
+    }
     /**
      * Faces UI extender for all kind of Rules plugins. Provides various useful
      * methods for any rules UI.
      * Faces UI extender for all kind of Rules plugins.
+     *
      * Provides various useful methods for any rules UI.
      */
     class RulesPluginUI extends FacesExtender implements RulesPluginUIInterface {
-...
       protected $element;
       /**
        * The base path determines where a Rules overview UI lives. All forms that
        * want to display Rules (overview) forms need to set this variable. This is
        * necessary in order to get correct operation links, paths, redirects, bread
        * crumbs etc. for the form() and overviewTable() methods.
        * The base path determines where a Rules overview UI lives.
+       *
        * All forms that want to display Rules (overview) forms need to set this
        * variable. This is necessary in order to get correct operation links,
        * paths, redirects, breadcrumbs etc. for the form() and overviewTable() methods.
+       *
        * @see RulesUIController
        * @see rules_admin_reaction_overview()
-...
+      }
       /**
        * Implements RulesPluginUIInterface.
        * Generates the element edit form.
        * Implements RulesPluginUIInterface. Generates the element edit form.
+       *
        * Note: Make sure that you set RulesPluginUI::$basePath before using this
        * method, otherwise paths, links, redirects etc. won't be correct.
-...
           );
+        }
         if (!empty($form['provides'])) {
           $help = '<div class="description">' . t('Adjust the names and labels of provided variables, but note that renaming of already utilizied variables invalidates the existing uses.') . '</div>';
           $help = '<div class="description">' . t('Adjust the names and labels of provided variables, but note that renaming of already utilized variables invalidates the existing uses.') . '</div>';
           $form['provides'] += array(
             '#tree' => TRUE,
             '#prefix' => '<h4 class="rules-form-heading">' . t('Provided variables') . '</h4>' . $help,
-...
+        }
         // For translatable parameters, pre-populate an internal translation source
         // key so data type forms or input evaluators (i18n) may produce suiting
         // help.
         // key so data type forms or input evaluators (i18n) may show a suitable
         // help message.
         if (drupal_multilingual() && !empty($info['translatable'])) {
           $parameter = $this->element->pluginParameterInfo();
           $info['custom translation language'] = !empty($parameter['language']);
-...
+        }
         // Add a link for switching the input mode when JS is enabled and a button
         // to switch it without javascript, in case switching is possible.
         // to switch it without JavaScript, in case switching is possible.
         if ($supports_input_mode && empty($info['restriction'])) {
           $value = $mode == 'selector' ? t('Switch to the direct input mode') : t('Switch to data selection');
-...
           '#required' => TRUE,
           '#weight' => -5,
         );
         // @todo: For Drupal 8 use "owner" for generating machine names and
         // @todo For Drupal 8 use "owner" for generating machine names and
         // module only for the modules providing default configurations.
         if (!empty($this->element->module) && !empty($this->element->name) && $this->element->module == 'rules' && strpos($this->element->name, 'rules_') === 0) {
           // Remove the Rules module prefix from the machine name.
-...
             $description = t('The variables used by the component. They can not be edited for configurations that are provided in code.');
+          }
           else {
             $description = t('Variables are normally input <em>parameters</em> for the component – data that should be available for the component to act on. Additionaly, action components may <em>provide</em> variables back to the caller. Each variable must have a specified data type, a label and a unique machine readable name containing only lowercase alphanumeric characters and underscores. See <a href="@url">the online documentation</a> for more information about variables.',
             $description = t('Variables are normally input <em>parameters</em> for the component – data that should be available for the component to act on. Additionally, action components may <em>provide</em> variables back to the caller. Each variable must have a specified data type, a label and a unique machine readable name containing only lowercase alphanumeric characters and underscores. See <a href="@url">the online documentation</a> for more information about variables.',
               array('@url' => rules_external_help('variables'))
             );
+          }
-...
               '#type' => 'checkbox',
               '#title' => t('Configure access for using this component with a permission.'),
               '#default_value' => !empty($this->element->access_exposed),
               '#description' => t('By default, the @plugin-type for using this component may be only used by users that have access to configure the component. If checked, access is determined by a permission instead.', array('@plugin-type' => $plugin_type))
               '#description' => t('By default, the @plugin-type for using this component may be only used by users that have access to configure the component. If checked, access is determined by a permission instead.', array('@plugin-type' => $plugin_type)),
             );
             $form['settings']['access']['permissions'] = array(
               '#type' => 'container',
-...
+          }
+        }
         // TODO: Attach field form thus description.
         // @todo Attach field form thus description.
+      }
       /**
-...
         $form_values = RulesPluginUI::getFormStateValues($form['settings'], $form_state);
         $this->element->label = $form_values['label'];
         // If the name was changed we have to redirect to the URL that contains
         // the new name, instead of rebuilding on the old URL with the old name
         // the new name, instead of rebuilding on the old URL with the old name.
         if ($form['settings']['name']['#default_value'] != $form_values['name']) {
           $module = isset($this->element->module) ? $this->element->module : 'rules';
           $this->element->name = $module . '_' . $form_values['name'];
-...
        * Returns the name of class for the given data type.
+       *
        * @param $data_type
        *   The name of the data typ
        *   The name of the data type
        * @param $parameter_info
        *   (optional) An array of info about the to be configured parameter. If
        *   given, this array is complemented with data type defaults also.
-...
       /**
        * Implements RulesPluginUIInterface.
        * Show a preview of the configuration settings.
+       *
        * Shows a preview of the configuration settings.
        */
       public function buildContent() {
         $config_name = $this->element->root()->name;
-...
           '#title' => $this->element->label(),
           '#href' => $this->element->isRoot() ? RulesPluginUI::path($config_name) : RulesPluginUI::path($config_name, 'edit', $this->element),
           '#prefix' => '<div class="rules-element-label">',
           '#suffix' => '</div>'
           '#suffix' => '</div>',
         );
         // Put the elements below in a "description" div.
         $content['description'] = array(
-...
           $element = array();
           if (!empty($this->element->settings[$name . ':select'])) {
             $element['content'] = array(
              '#markup' => '[' . $this->element->settings[$name . ':select'] . ']',
               '#markup' => '[' . $this->element->settings[$name . ':select'] . ']',
             );
+          }
           elseif (isset($this->element->settings[$name]) && (!isset($parameter['default value']) || $parameter['default value'] != $this->element->settings[$name])) {
             $class = $this->getDataTypeClass($parameter['type'], $parameter);
             $method = empty($parameter['options list']) ? 'render' : 'renderOptionsLabel';
             // We cannot use method_exists() here as it would trigger a PHP bug,
             // @see http://drupal.org/node/1258284
             // We cannot use method_exists() here as it would trigger a PHP bug.
             // @see https://www.drupal.org/node/1258284
             $element = call_user_func(array($class, $method), $this->element->settings[$name], $name, $parameter, $this->element);
+          }
           // Only add parameters that are really configured / not default.
-...
        */
       public function help() {}
       /**
        * Deprecated by the controllers overviewTable() method.
        */
-...
+      }
       /**
        * Generates an operation path.
+       *
        * Generates a path using the given operation for the element with the given
        * id of the configuration with the given name.
        */
-...
         else {
           $base_path = isset($element) && $element instanceof RulesTriggerableInterface ? 'admin/config/workflow/rules/reaction' : 'admin/config/workflow/rules/components';
+        }
         return implode('/', array_filter(array($base_path . '/manage', $name, $op, $element_id, $parameter)));
         // Only append the '/manage' path if it is not already present.
         if (substr($base_path, -strlen('/manage')) != '/manage') {
           $base_path .= '/manage';
+        }
         return implode('/', array_filter(array($base_path, $name, $op, $element_id, $parameter)));
+      }
       /**
        * Determines the default redirect target for an edited/deleted element. This
        * is a parent element which is either a rule or the configuration root.
        * Determines the default redirect target for an edited/deleted element.
+       *
        * This is a parent element which is either a rule or the configuration root.
        */
       public static function defaultRedirect(RulesPlugin $element) {
         while (!$element->isRoot()) {
-...
           ->fetchCol('tag');
         return drupal_map_assoc($result);
+      }
+    }
     /**
-...
     class RulesAbstractPluginUI extends RulesPluginUI {
       /**
        * Overrides RulesPluginUI::form().
+       *
        * Overridden to invoke the abstract plugins form alter callback and to add
        * the negation checkbox for conditions.
        */
-...
           form_set_error(implode('][', $e->keys), $e->getMessage());
+        }
+      }
+    }
     /**
-...
           '#tree' => TRUE,
           '#theme' => 'rules_elements',
           '#empty' => t('None'),
           '#caption' => t('Elements')
           '#caption' => t('Elements'),
         );
         $form['elements']['#attributes']['class'][] = 'rules-container-plugin';
         // Recurse over all element childrens or use the provided iterator.
         // Recurse over all element children or use the provided iterator.
         $iterator = isset($iterator) ? $iterator : $this->element->elements();
         $root_depth = $this->element->depth();
         foreach ($iterator as $key => $child) {
-...
           );
           $form['elements'][$id]['parent_id'] = array(
             '#type' => 'hidden',
             // If another iterator is passed in, the childs parent may not equal
             // If another iterator is passed in, the child parent may not equal
             // the current element. Thus ask the child for its parent.
             '#default_value' => $child->parentElement()->elementId(),
           );
-...
         return $render;
+      }
       public function buildContent() {
         $content = parent::buildContent();
         // Don't link the title for embedded container plugins, except for rules.
         if (!$this->element->isRoot() && !($this->element instanceof Rule)) {
           $content['label']['#type'] = 'markup';
           $content['label']['#markup'] = check_plain($content['label']['#title']);
           unset($content['label']['#title']);
+        }
-...
+        }
         return $content;
+      }
+    }
     /**
-...
         $form['elements']['#attributes']['class'][] = 'rules-condition-container';
         $form['elements']['#caption'] = t('Conditions');
         // By default skip
         // By default skip.
         if (!empty($options['init']) && !$this->element->isRoot()) {
           $config = $this->element->root();
           $form['init_help'] = array(
-...
           $this->element->negate($form_values['negate']);
+        }
+      }
+    }
     /**
-...
     class RulesActionContainerUI extends RulesContainerPluginUI {
       public function form(&$form, &$form_state, $options = array(), $iterator = NULL) {
         parent::form($form,  $form_state, $options, $iterator);
         parent::form($form, $form_state, $options, $iterator);
         // Add the add-* operation links.
         $form['elements']['#add'] = self::addOperations();
         $form['elements']['#attributes']['class'][] = 'rules-action-container';
         $form['elements']['#caption'] = t('Actions');
+      }
+    }
     /**
-...
        *   (optional) Whether group labels for grouping inside a category should be
        *   return. Defaults to FALSE.
+       *
        * @return string|boolean
        * @return string|bool
        *   The group label to use, or FALSE if none can be found.
        */
       public static function getItemGroup($item_info, $in_category = FALSE) {
         if (isset($item_info['category']) && !$in_category) {
           return self::getCategory($item_info, 'label');
+        }
         else if (!empty($item_info['group'])) {
         elseif (!empty($item_info['group'])) {
           return $item_info['group'];
+        }
         return FALSE;
-...
+      }
       /**
        * Returns an array of options to use with a select for the items specified
        * Returns an array of options to use with a select.
+       *
        * Returns an array of options to use with a selectfor the items specified
        * in the given hook.
+       *
        * @param $item_type
-...
        * @param $items
        *   (optional) An array of items to restrict the options to.
+       *
        * @return
        * @return array
        *   An array of options.
        */
       public static function getOptions($item_type, $items = NULL) {
-...
         $ungrouped = array();
         $data = $items ? $items : rules_fetch_data($item_type . '_info');
         foreach ($data as $name => $info) {
           // Verfiy the current user has access to use it.
           // Verify the current user has access to use it.
           if (!user_access('bypass rules access') && !empty($info['access callback']) && !call_user_func($info['access callback'], $item_type, $name)) {
             continue;
+          }
-...
+        }
         return $ungrouped + $sorted_groups;
+      }
+    }
     /**

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