PEAR 手册
后退前进

Config_Container::createComment()

Config_Container::createComment() -- 为一个条目添加注释

大纲

require_once 'Config/Container.php';

对象 Config_Container::createComment ([字符串 $content = '' [, 字符串 $where = 'bottom' [, 对象 $target = NULL]]])

基本描述

当前条目必须作为一个节存在。 它是 createItem() 函数的一个辅助方法。

参数

字符串 $content

注释内容。

字符串 $where

添加注释内容的位置（一般为'top', 'bottom', 'before', 'after'）。

对象 $target

仅当 $where 参数使用 'before' 或 'after' 时使用。

返回值

对象 - 新条目类型。

Throws

表 24-1. 可能出现的 PEAR_Error 值

Error codeError valueMeaningSolution
 ""  

注意

该函数不能被静态调用。

例子

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

$section =& new Config_Container('section', 'conf');
$section->createComment('Database Configuration');
后退首页前进
Config_Container::createBlank()起点Config_Container::createDirective()