Config_Container::getItem

Config_Container::getItem() – Tries to find specific items

Synopsis

require_once 'Config/Container.php';

mixed Config_Container::getItem ( string $type = null , string $name = null , mixed $content = null , array $attributes = null , int $index = -1 )

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

A few examples on how to find items using getItem()

<?php
// 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'nullnull4);

// 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'));
?>
Get item content (Previous) Return item index in its parent children array (Next)
Last updated: Sat, 20 Sep 2014 — Download Documentation
Do you think that something on this page is wrong? Please file a bug report or add a note.
View this page in:

User Notes:

There are no user contributed notes for this page.