Config_Container::createDirective (Previous) (Next) Config_Container::createSection
View this page in Last updated: Sun, 28 Sep 2008
English | Dutch | French | German | Hungarian | Japanese | Polish | Russian | Spanish | Plain HTML

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 37-1. Possible PEAR_Error values

Error codeError valueMeaningSolution
 ""  

Note

This function can not be called statically.

Example

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


<?php
$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);
?>
Config_Container::createDirective (Previous) (Next) Config_Container::createSection
Download Documentation Last updated: Sun, 28 Sep 2008
Do you think that something on this page is wrong? Please file a bug report or add a note.
User Notes:
There are no user contributed notes for this page.