Config_Container::createComment
Prev Next

Config_Container::createComment

Config_Container::createComment() – アイテムにコメントを追加する

Synopsis

require_once 'Config/Container.php';

objectConfig_Container::createComment ( string $content = '' , string $where = 'bottom' , object $target = = null )

Description

現在のアイテムが"section"でなければいけません。 この関数は、 createItem() をヘルパー関数として呼びます。

Parameter

string $content

コメントの内容

string $where

新しいアイテムを生成する位置。('top', 'bottom', 'before', 'after')

object $target

$whereで、 'before'か 'after'を指定した場合のみ必要。

Return value

object - 新しいアイテムのリファレンスを返します。

Throws

Possible PEAR_Error values
エラーコード エラー値 意味 解決策
  "    

Note

This function can not be called statically.

Example

createComment() を使用して新しいディレクティブを作成する

<?php
$section =& new Config_Container('section', 'conf');
$section->createComment('Database Configuration');
?>
Prev Config Next
Config_Container::createBlank PEAR Manual Config_Container::createDirective