REFLECTIONCLASS.GETDOCCOMMENT(3) 1 REFLECTIONCLASS.GETDOCCOMMENT(3)ReflectionClass::getDocComment - Gets doc comments
SYNOPSIS
public string ReflectionClass::getDocComment (void )
DESCRIPTION
Gets doc comments from a class.
Warning
This function is currently not documented; only its argument list is available.
PARAMETERS
This function has no parameters.
RETURN VALUES
The doc comment if it exists, otherwise FALSE
EXAMPLES
Example #1
ReflectionClass::getDocComment example
<?php
/**
* A test class
*
* @param foo bar
* @return baz
*/
class TestClass { }
$rc = new ReflectionClass('TestClass');
var_dump($rc->getDocComment())
?>
The above example will output:
string(55) "/**
* A test class
*
* @param foo bar
* @return baz
*/"
SEE ALSO
ReflectionClass::getName.
PHP Documentation Group REFLECTIONCLASS.GETDOCCOMMENT(3)
Check Out this Related Man Page
REFLECTIONOBJECT(3) 1 REFLECTIONOBJECT(3)The ReflectionObject classINTRODUCTION
The ReflectionObject class reports information about an object.
CLASS SYNOPSIS
ReflectionObject
ReflectionObjectextends
ReflectionClassReflector
Constants
o const integer$ReflectionObject::IS_IMPLICIT_ABSTRACT16
o const integer$ReflectionObject::IS_EXPLICIT_ABSTRACT32
o const integer$ReflectionObject::IS_FINAL64
Properties
o public$name
Methods
o public ReflectionObject::__construct (object $argument)
o publicstatic string ReflectionObject::export (string $argument, [bool $return])
Inherited methods
o public ReflectionClass::__construct (mixed $argument)
o publicstatic string ReflectionClass::export (mixed $argument, [bool $return = false])
o public mixed ReflectionClass::getConstant (string $name)
o public array ReflectionClass::getConstants (void )
o public ReflectionMethod ReflectionClass::getConstructor (void )
o public array ReflectionClass::getDefaultProperties (void )
o public string ReflectionClass::getDocComment (void )
o public int ReflectionClass::getEndLine (void )
o public ReflectionExtension ReflectionClass::getExtension (void )
o public string ReflectionClass::getExtensionName (void )
o public string ReflectionClass::getFileName (void )
o public array ReflectionClass::getInterfaceNames (void )
o public array ReflectionClass::getInterfaces (void )
o public ReflectionMethod ReflectionClass::getMethod (string $name)
o public array ReflectionClass::getMethods ([int $filter])
o public int ReflectionClass::getModifiers (void )
o public string ReflectionClass::getName (void )
o public string ReflectionClass::getNamespaceName (void )
o public object ReflectionClass::getParentClass (void )
o public array ReflectionClass::getProperties ([int $filter])
o public ReflectionProperty ReflectionClass::getProperty (string $name)
o public string ReflectionClass::getShortName (void )
o public int ReflectionClass::getStartLine (void )
o public array ReflectionClass::getStaticProperties (void )
o public mixed ReflectionClass::getStaticPropertyValue (string $name, [mixed &$def_value])
o public array ReflectionClass::getTraitAliases (void )
o public array ReflectionClass::getTraitNames (void )
o public array ReflectionClass::getTraits (void )
o public bool ReflectionClass::hasConstant (string $name)
o public bool ReflectionClass::hasMethod (string $name)
o public bool ReflectionClass::hasProperty (string $name)
o public bool ReflectionClass::implementsInterface (string $interface)
o public bool ReflectionClass::inNamespace (void )
o public bool ReflectionClass::isAbstract (void )
o public bool ReflectionClass::isCloneable (void )
o public bool ReflectionClass::isFinal (void )
o public bool ReflectionClass::isInstance (object $object)
o public bool ReflectionClass::isInstantiable (void )
o public bool ReflectionClass::isInterface (void )
o public bool ReflectionClass::isInternal (void )
o public bool ReflectionClass::isIterateable (void )
o public bool ReflectionClass::isSubclassOf (string $class)
o public bool ReflectionClass::isTrait (void )
o public bool ReflectionClass::isUserDefined (void )
o public object ReflectionClass::newInstance (mixed $args, [mixed $...])
o public object ReflectionClass::newInstanceArgs ([array $args])
o public object ReflectionClass::newInstanceWithoutConstructor (void )
o public void ReflectionClass::setStaticPropertyValue (string $name, string $value)
o public string ReflectionClass::__toString (void )
PROPERTIES
o $name
- Name of the object's class. Read-only, throws ReflectionException in attempt to write.
PHP Documentation Group REFLECTIONOBJECT(3)