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

Possible PEAR_Error values
Error code Error value Meaning Solution
  "    

Note

This function can not be called statically.

Example

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'nullnull'after'$header);
?>
Config_Container::createDirective (Previous) Config_Container::createSection (Next)
Last updated: Tue, 02 Jun 2009 — 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.