class RulesFormsFormWrapper in Rules Forms Support 7.2
Wrapper class for form arrays.
Form data is wrapped as an EntityMetadataArrayObject.
Hierarchy
- class \EntityMetadataWrapper
- class \EntityStructureWrapper implements \IteratorAggregate
- class \RulesFormsStructureWrapper
- class \RulesFormsFormWrapper
- class \RulesFormsStructureWrapper
- class \EntityStructureWrapper implements \IteratorAggregate
Expanded class hierarchy of RulesFormsFormWrapper
1 string reference to 'RulesFormsFormWrapper'
- rules_forms_rules_data_info in ./
rules_forms.rules.inc - Implements hook_rules_data_info().
File
- includes/
rules_forms.wrapper.inc, line 61 - Manages and Process Form structure.
View source
class RulesFormsFormWrapper extends RulesFormsStructureWrapper {
/**
* Returns the form ID of the form.
*/
public function getFormId() {
$data = $this
->value();
if (isset($data['form_id'])) {
return $data['form_id']['#value'];
}
return NULL;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
EntityMetadataWrapper:: |
protected | property | ||
EntityMetadataWrapper:: |
protected | property | ||
EntityMetadataWrapper:: |
protected | property | ||
EntityMetadataWrapper:: |
protected | property | 1 | |
EntityMetadataWrapper:: |
public | function | Determines whether the given user has access to view or edit this property. Apart from relying on access metadata of properties, this takes into account information about entity level access, if available: | 1 |
EntityMetadataWrapper:: |
protected | function | Returns whether data is available to work with. | |
EntityMetadataWrapper:: |
public | function | Returns a string to use to identify this wrapper in error messages. | 1 |
EntityMetadataWrapper:: |
public | function | Gets info about the wrapped data. | |
EntityMetadataWrapper:: |
public | function | Returns the label for the currently set property value if there is one available, i.e. if an options list has been specified. | 2 |
EntityMetadataWrapper:: |
public | function | Returns the options list specifying possible values for the property, if defined. | |
EntityMetadataWrapper:: |
public | function | Returns the raw, unprocessed data. Most times this is the same as returned by value(), however for already processed and sanitized textual data, this will return the unprocessed data in contrast to value(). | |
EntityMetadataWrapper:: |
public | function | Set a new data value. | 2 |
EntityMetadataWrapper:: |
public | function | Gets the (entity)type of the wrapped data. | 1 |
EntityMetadataWrapper:: |
protected | function | Updates the parent data structure of a data property with the latest data value. | |
EntityMetadataWrapper:: |
public | function | Returns whether $value is a valid value to set. | 1 |
EntityMetadataWrapper:: |
public | function | Returns the wrapped data. If no options are given the data is returned as described in the info. | 3 |
EntityMetadataWrapper:: |
public | function | ||
EntityStructureWrapper:: |
protected | property | ||
EntityStructureWrapper:: |
protected | property | ||
EntityStructureWrapper:: |
protected | property | ||
EntityStructureWrapper:: |
public | function |
Clears the data value and the wrapper cache. Overrides EntityMetadataWrapper:: |
1 |
EntityStructureWrapper:: |
public | function | Returns the identifier of the data structure. If there is none, NULL is returned. | 1 |
EntityStructureWrapper:: |
public | function | ||
EntityStructureWrapper:: |
public | function | Gets the info about the given property. | |
EntityStructureWrapper:: |
public | function | Gets the language used for retrieving properties. | |
EntityStructureWrapper:: |
protected | function | Gets the raw value of a property. | |
EntityStructureWrapper:: |
protected | function | Gets the value of a property. | |
EntityStructureWrapper:: |
public | function | Sets a new language to use for retrieving properties. | |
EntityStructureWrapper:: |
protected | function | ||
EntityStructureWrapper:: |
public | function | Returns a reference on the property info. | |
EntityStructureWrapper:: |
protected | function | Sets a property. | |
EntityStructureWrapper:: |
protected | function | May be used to lazy-load additional info about the data, depending on the concrete passed data. | 1 |
EntityStructureWrapper:: |
public | function |
Construct a new EntityStructureWrapper object. Overrides EntityMetadataWrapper:: |
1 |
EntityStructureWrapper:: |
public | function | Magic method: Get a wrapper for a property. | |
EntityStructureWrapper:: |
public | function | Magic method: Can be used to check if a property is known. | |
EntityStructureWrapper:: |
public | function | Magic method: Set a property. | |
EntityStructureWrapper:: |
public | function |
Prepare for serializiation. Overrides EntityMetadataWrapper:: |
1 |
RulesFormsFormWrapper:: |
public | function | Returns the form ID of the form. | |
RulesFormsStructureWrapper:: |
public | function |
Overrides EntityStructureWrapper::get() to ensure data is properly wrapped. Overrides EntityStructureWrapper:: |