PEAR Manual
PrevNext

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

Error codeError valueMeaningSolution
 ""  

Note

This function can not be called statically.

Example

Example 24-1. Create a new directive using createComment()

$section =& new Config_Container('section', 'conf');
$section->createComment('Database Configuration');
PrevHomeNext
Config_Container::createBlank()UpConfig_Container::createDirective()