SXMLListModel Class Reference
[XML Objects]
Base class for XML models consisting of lists.
More...
Public Member Functions | |
| count () | |
| INSERT BRIEF DESCRIPTION HERE. | |
| current () | |
| INSERT BRIEF DESCRIPTION HERE. | |
| getListAttribute () | |
| INSERT BRIEF DESCRIPTION HERE. | |
| getListChildAttribute () | |
| INSERT BRIEF DESCRIPTION HERE. | |
| key () | |
| INSERT BRIEF DESCRIPTION HERE. | |
| next () | |
| INSERT BRIEF DESCRIPTION HERE. | |
| offsetExists ($offset) | |
| INSERT BRIEF DESCRIPTION HERE. | |
| offsetGet ($offset) | |
| INSERT BRIEF DESCRIPTION HERE. | |
| offsetSet ($offset, $value) | |
| INSERT BRIEF DESCRIPTION HERE. | |
| offsetUnset ($offset) | |
| INSERT BRIEF DESCRIPTION HERE. | |
| rewind () | |
| INSERT BRIEF DESCRIPTION HERE. | |
| valid () | |
| INSERT BRIEF DESCRIPTION HERE. | |
Protected Member Functions | |
| getXMLImpl ($root, $forceRegen) | |
| INSERT BRIEF DESCRIPTION HERE. | |
| registerListAttribute ($la, $childName) | |
| INSERT BRIEF DESCRIPTION HERE. | |
| setXMLImpl ($xml) | |
| INSERT BRIEF DESCRIPTION HERE. | |
Detailed Description
Base class for XML models consisting of lists.This class uses SXMLModel, but adds some utility features making it easier for having lists of objects and parsing those lists.
Definition at line 11 of file SXMLListModel.php5.
Member Function Documentation
| SXMLListModel::count | ( | ) |
INSERT BRIEF DESCRIPTION HERE.
INSERT FULL DESCRIPTION HERE
- Returns:
- [TYPE]: RETURN DESCRIPTION
Definition at line 216 of file SXMLListModel.php5.
Referenced by offsetExists(), and valid().
| SXMLListModel::current | ( | ) |
INSERT BRIEF DESCRIPTION HERE.
INSERT FULL DESCRIPTION HERE
- Returns:
- [TYPE]: RETURN DESCRIPTION
Definition at line 231 of file SXMLListModel.php5.
| SXMLListModel::getListAttribute | ( | ) |
INSERT BRIEF DESCRIPTION HERE.
INSERT FULL DESCRIPTION HERE
- Returns:
- [TYPE]: RETURN DESCRIPTION
Definition at line 36 of file SXMLListModel.php5.
| SXMLListModel::getListChildAttribute | ( | ) |
INSERT BRIEF DESCRIPTION HERE.
INSERT FULL DESCRIPTION HERE
- Returns:
- [TYPE]: RETURN DESCRIPTION
Definition at line 47 of file SXMLListModel.php5.
| SXMLListModel::getXMLImpl | ( | $ | root, | |
| $ | forceRegen | |||
| ) | [protected] |
INSERT BRIEF DESCRIPTION HERE.
For internal use only.
INSERT FULL DESCRIPTION HERE
- Parameters:
-
$root [TYPE]: DESCRIPTION $forceRegen [TYPE]: DESCRIPTION
- Returns:
- [TYPE]: RETURN DESCRIPTION
Reimplemented from SModel2.
Definition at line 102 of file SXMLListModel.php5.
References SModel2::getAttributes(), SObject::getErrorFrom(), SObject::getWarningFrom(), and SObject::setWarning().
| SXMLListModel::key | ( | ) |
INSERT BRIEF DESCRIPTION HERE.
INSERT FULL DESCRIPTION HERE
- Returns:
- [TYPE]: RETURN DESCRIPTION
Definition at line 244 of file SXMLListModel.php5.
| SXMLListModel::next | ( | ) |
INSERT BRIEF DESCRIPTION HERE.
INSERT FULL DESCRIPTION HERE
- Returns:
- [TYPE]: RETURN DESCRIPTION
Definition at line 255 of file SXMLListModel.php5.
| SXMLListModel::offsetExists | ( | $ | offset | ) |
INSERT BRIEF DESCRIPTION HERE.
INSERT FULL DESCRIPTION HERE
- Parameters:
-
$offset [TYPE]: DESCRIPTION
- Returns:
- [TYPE]: RETURN DESCRIPTION
Definition at line 173 of file SXMLListModel.php5.
References count().
| SXMLListModel::offsetGet | ( | $ | offset | ) |
INSERT BRIEF DESCRIPTION HERE.
INSERT FULL DESCRIPTION HERE
- Parameters:
-
$offset [TYPE]: DESCRIPTION
- Returns:
- [TYPE]: RETURN DESCRIPTION
Definition at line 202 of file SXMLListModel.php5.
| SXMLListModel::offsetSet | ( | $ | offset, | |
| $ | value | |||
| ) |
INSERT BRIEF DESCRIPTION HERE.
INSERT FULL DESCRIPTION HERE
- Parameters:
-
$offset [TYPE]: DESCRIPTION $value [TYPE]: DESCRIPTION
- Returns:
- [TYPE]: RETURN DESCRIPTION
Definition at line 160 of file SXMLListModel.php5.
| SXMLListModel::offsetUnset | ( | $ | offset | ) |
INSERT BRIEF DESCRIPTION HERE.
INSERT FULL DESCRIPTION HERE
- Parameters:
-
$offset [TYPE]: DESCRIPTION
- Returns:
- [TYPE]: RETURN DESCRIPTION
Definition at line 189 of file SXMLListModel.php5.
| SXMLListModel::registerListAttribute | ( | $ | la, | |
| $ | childName | |||
| ) | [protected] |
INSERT BRIEF DESCRIPTION HERE.
For internal use only.
INSERT FULL DESCRIPTION HERE
- Parameters:
-
$la [TYPE]: DESCRIPTION $childName [TYPE]: DESCRIPTION
- Returns:
- [TYPE]: RETURN DESCRIPTION
Definition at line 24 of file SXMLListModel.php5.
Referenced by SDRResourceList::__construct(), and SDRRelationshipList::__construct().
| SXMLListModel::rewind | ( | ) |
INSERT BRIEF DESCRIPTION HERE.
INSERT FULL DESCRIPTION HERE
- Returns:
- [TYPE]: RETURN DESCRIPTION
Definition at line 266 of file SXMLListModel.php5.
| SXMLListModel::setXMLImpl | ( | $ | xml | ) | [protected] |
INSERT BRIEF DESCRIPTION HERE.
For internal use only.
INSERT FULL DESCRIPTION HERE
- Parameters:
-
$xml [TYPE]: DESCRIPTION
- Returns:
- [TYPE]: RETURN DESCRIPTION
Reimplemented from SModel2.
Definition at line 59 of file SXMLListModel.php5.
References SModel2::getAttributeType().
| SXMLListModel::valid | ( | ) |
INSERT BRIEF DESCRIPTION HERE.
INSERT FULL DESCRIPTION HERE
- Returns:
- [TYPE]: RETURN DESCRIPTION
Definition at line 277 of file SXMLListModel.php5.
References count().
The documentation for this class was generated from the following file:
- SWAT/model2/SXMLListModel.php5
