Class: Comments

Source Location: /Comments.php

Class Overview

Strings
   |
   --PHPCode
      |
      --Comments

Created on 1 april 09

Author(s):

Pierre-Dominique Vienne <pvienne@me.com>

Version:

Variables

Methods

getComments

Inherited Variables

Class: PHPCode

PHPCode::$aEnd_tags
PHPCode::$aPHPCode
PHPCode::$aStart_tags

Class: Strings

Strings::$api_render
Strings::$charset
Strings::$colors
Strings::$directoutput
Strings::$error
Strings::$msgtypes
Strings::$value

Inherited Methods

Class: PHPCode

PHPCode::getCode(): Code obtention function

Class: Strings

Strings::__construct(): Construction function
Strings::console(): Console function
Strings::IsUTF8(): UTF8 detection function
Strings::QuoteStrip(): Quotes stripping function
Strings::RemoveAccent(): Accents removal function
Strings::RemoveSpaces(): Spaces removal function
Strings::stringHasNumbers(): Numbers detection function
Strings::ToUTF8(): UTF8 conversion function
Strings::ucwordsw(): Special uppercase function

Class Details

[line 16]
Created on 1 april 09

This class manages PHP Comments objects.

Changes: 1.0 to 2.0: phpdoc compatible in the way to generate documentation

Tags:

author:	Pierre-Dominique Vienne <pvienne@me.com>
version:	2.0
license:	GNU Public License

[ Top ]

Class Variables

$aComments = array()

[line 33]

Variable that contains PHP Comments

Tags:

access:

public

Type:

string

[ Top ]

$aComments_endtags = array("*/")

[line 27]

Variable that contains PHP Comments end tags

Tags:

access:

protected

Type:

array

[ Top ]

$aComments_starttags = array("/*")

[line 22]

Variable that contains PHP Comments open tags

Tags:

access:

protected

Type:

array

[ Top ]

Class Methods

method getComments [line 63]

object getComments(
string
$this->value)

Comments obtention function

This function is used to get PHP code comments from a string ($this->value) Result is stored in $this->aComments

<?php
$oComments = new Comments();
$oComments->value = 'ab <?php phpcode with comments ?> foo <? print_r($value); ?>';
$oComments->getComments();
echo $oComments->aComments[0];
// comments inserted in code
?>

Tags:

return:	object
staticvar:	array $this->aComments_starttags: array containing open PHP comments tags
staticvar:	array $this->aComments_endtags: array containing end PHP comments tags
since:	Version 1.0
uses:	STRregexs::ProtectRegex()

Parameters:

string

$this->value

text to be processed (required)

[ Top ]

Documentation generated on Wed, 26 Aug 2009 12:30:02 +0200 by phpDocumentor 1.4.1