Config_Container::getItem() -- Tries to find specific items
Description
This method tries to find the items that respond to the specified parameters.
This method can only be called on an object of type
'section'. Note that root is a section.
This method is not recursive and tries to keep the current structure.
Parameter
- string
$type
type of item: directive, section,
comment, blank...
- string
$name
item name
- mixed
$content
find item with this content
- array
$attributes
find item with attribute set to the given value
- integer
$index
index of the item in the returned object list.
If it is not set, will try to return the last item with this name.
Return value
mixed - reference to item found or FALSE when not found
Note
This function can not be called
statically.
Example
Example 24-1. A few examples on how to find items using getItem() // will return the last directive found
$directives =& $obj->getItem('directive');
// will return the last directive found with content 'root'
$directives =& $obj->getItem('directive', null, 'root');
// will return the fourth directive with name 'bar'
$directive_bar_4 =& $obj->getItem('directive', 'bar', null, null, 4);
// will return the last section named 'foo'
$section_foo =& $obj->getItem('section', 'foo');
// will return the last section with attribute 'id' set to 'db'
$section_foo =& $obj->getItem('section', 'foo', null, array('id' => 'db')); |
|