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

Possible PEAR_Error values
Error code Error value Meaning Solution
  "    

Note

This function can not be called statically.

Example

Create a new directive using createComment()

<?php
$section 
=& new Config_Container('section''conf');
$section->createComment('Database Configuration');
?>
Add blank line to item (Previous) Add directive to item (Next)
Last updated: Tue, 30 Sep 2014 — 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.