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

Config_Container::createComment()

Config_Container::createComment() -- Add comment to item

Synopsis

require_once 'Config/Container.php';

objectConfig_Container::createComment ([string $content = '' [, string $where = 'bottom' [, object $target = NULL]]])

Description

The current item must be a section. This is a helper method that calls createItem()

Parameter

string $content

Comment content

string $where

Where to create the new item ('top', 'bottom', 'before', 'after')

object $target

Required only if 'before' or 'after' is used 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 a new directive using createComment()


<?php
$section =& new Config_Container('section', 'conf');
$section->createComment('Database Configuration');
?>
Config_Container::createBlank (Previous) (Next) Config_Container::createDirective
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.