[ Index ]

PHP Cross Reference of Drupal 6 (gatewave)

title

Body

[close]

/sites/all/modules/rules/rules_admin/ -> rules_admin.rule_proxy.inc (summary)

(no description)

File Size: 296 lines (8 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

rules_admin_rule_proxy:: (21 methods):
  rules_admin_rule_proxy()
  get_rule()
  get_rule_name()
  set_rule_name()
  get_element()
  get_element_parent_id()
  save_changes()
  _generate_index()
  get_indexed_rule()
  _generate_index_rule()
  save_rule()
  delete_rule()
  clean_rule()
  _clean_rule()
  get_set()
  get_set_info()
  get_new_variables()
  element_get_new_variables()
  get_available_variables()
  get_defined_variables()
  _get_available_variables()


Class: rules_admin_rule_proxy  - X-Ref

This is a smally proxy for the real rule. It provides some useful operations for the admin UI.
It builds a small index for the elements of a rule, so that they can be easily identified and modified.

rules_admin_rule_proxy($rule_name, &$rule)   X-Ref
Constructor

param: $rule_name The name of the rule
param: $rule The rule to create a proxy for.

get_rule()   X-Ref
Gets the referenced rule


get_rule_name()   X-Ref
Gets the rule's name


set_rule_name($name)   X-Ref
No description

get_element($id)   X-Ref
Gets an element of the referenced rule by id


get_element_parent_id($id)   X-Ref
Gets the id of the parent element


save_changes()   X-Ref
Saves the changes in the rule and clears the cache if necessary.


_generate_index(&$elements)   X-Ref
Creates an id for each element and stores a reference on it


get_indexed_rule()   X-Ref
Gets the rule with set #id properties, useful for rendering.
Note: Any possible changes done, won't appear in the returned rule.


_generate_index_rule(&$elements)   X-Ref
No description

save_rule()   X-Ref
Saves a the rule in the database


delete_rule()   X-Ref
Deletes the rule configuration from the database


clean_rule()   X-Ref
Cleans the given rule. This means, array keys that are neither elements
nor properties are removed.


_clean_rule(&$element)   X-Ref
No description

get_set()   X-Ref
Gets the set of this rule, which contains only active rules.


get_set_info()   X-Ref
Gets the info about the set of this rule


get_new_variables($id = NULL)   X-Ref
Gets the info about all new defined variables in this rule,
before the element with the given id


element_get_new_variables($element)   X-Ref
Gets info about all new defined variables by the given element


get_available_variables($id = NULL)   X-Ref
Gets info about all available variables
This are the arguments of the rule's set as well as further arguments that
might be provided by actions of this or preceding rules. Variables set to be hidden
are left out.

param: $id The id of the element of the current rule until which we should get new variables.

get_defined_variables()   X-Ref
Gets info about all defined variables
This are all available variables as well as variables defined in and after this rule.


_get_available_variables($all = FALSE)   X-Ref
Gets new variables defined by actions in rules, which are evaluated until this rule.

param: $all



Generated: Thu Mar 24 11:18:33 2011 Cross-referenced by PHPXref 0.7