PEAR Manual
PrevNext

Config_Container::createItem()

Config_Container::createItem() -- Create new child for section item

Synopsis

require_once 'Config/Container.php';

object &Config_Container::createItem (string $type, mixed $item, string $content [, array $attributes = NULL [, string $where = 'bottom' [, object $target = NULL]]])

Description

This method must be called on a section, the created item can be anything. It adds a new child to the current item. If a position is specified, the child will be created at there. It is recommended to use the helper methods instead of calling this method directly.

Parameter

string $type

type of item: directive, section, comment, blank...

mixed $item

item name

string $content

item content

array $attributes

item attributes

string $where

choose a position 'bottom', 'top', 'after', 'before'

object $target

needed if you choose 'before' or 'after' for $where

Return value

object - reference to new item

Throws

Table 24-1. Possible PEAR_Error values

Error codeError valueMeaningSolution
 ""  

Note

This function can not be called statically.

Example

Example 24-1. Create some new items using createItem()

$section =& new Config_Container('section', 'conf');
$section->createItem('directive', 'user', 'root');
$section->createItem('directive', 'pass', 'root');
$header =& $section->createItem('comment', null, 'Database Configuration', 'top');
$section->createItem('blank', null, null, 'after', $header);
PrevHomeNext
Config_Container::createDirective()UpConfig_Container::createSection()