PHP Класс Pop\Code\Generator\InterfaceGenerator

Автор: Nick Sagona, III ([email protected])
Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$docblock DocblockGenerator Docblock generator object
$indent string Class indent
$methods array Array of method generator objects
$name string Class name
$namespace NamespaceGenerator Namespace generator object
$output string Class output
$parent string Parent interface that is extended

Открытые методы

Метод Описание
__construct ( string $name, string $parent = null ) : InterfaceGenerator Constructor
__toString ( ) : string Print method
addMethod ( MethodGenerator $method ) : ClassGenerator Add a class method
factory ( string $name, string $parent = null ) : InterfaceGenerator Static method to instantiate the interface generator object and return itself to facilitate chaining methods together.
getDocblock ( ) : DocblockGenerator Access the docblock generator object
getIndent ( ) : string Get the interface indent
getMethod ( mixed $method ) : /Pop\Code\MethodGenerator Get a method property
getName ( ) : string Get the interface name
getNamespace ( ) : NamespaceGenerator Access the namespace generator object
getParent ( ) : string Get the interface parent
removeMethod ( mixed $method ) : ClassGenerator Remove a method property
render ( boolean $ret = false ) : mixed Render method
setDocblock ( DocblockGenerator $docblock ) : ClassGenerator Set the docblock generator object
setIndent ( string $indent = null ) : InterfaceGenerator Set the interface indent
setName ( string $name ) : InterfaceGenerator Set the interface name
setNamespace ( NamespaceGenerator $namespace ) : ClassGenerator Set the namespace generator object
setParent ( string $parent = null ) : InterfaceGenerator Set the interface parent

Защищенные методы

Метод Описание
formatMethods ( ) : string Method to format the methods

Описание методов

__construct() публичный Метод

Instantiate the interface generator object
public __construct ( string $name, string $parent = null ) : InterfaceGenerator
$name string
$parent string
Результат InterfaceGenerator

__toString() публичный Метод

Print method
public __toString ( ) : string
Результат string

addMethod() публичный Метод

Add a class method
public addMethod ( MethodGenerator $method ) : ClassGenerator
$method MethodGenerator
Результат ClassGenerator

factory() публичный статический Метод

Static method to instantiate the interface generator object and return itself to facilitate chaining methods together.
public static factory ( string $name, string $parent = null ) : InterfaceGenerator
$name string
$parent string
Результат InterfaceGenerator

formatMethods() защищенный Метод

Method to format the methods
protected formatMethods ( ) : string
Результат string

getDocblock() публичный Метод

Access the docblock generator object
public getDocblock ( ) : DocblockGenerator
Результат DocblockGenerator

getIndent() публичный Метод

Get the interface indent
public getIndent ( ) : string
Результат string

getMethod() публичный Метод

Get a method property
public getMethod ( mixed $method ) : /Pop\Code\MethodGenerator
$method mixed
Результат /Pop\Code\MethodGenerator

getName() публичный Метод

Get the interface name
public getName ( ) : string
Результат string

getNamespace() публичный Метод

Access the namespace generator object
public getNamespace ( ) : NamespaceGenerator
Результат NamespaceGenerator

getParent() публичный Метод

Get the interface parent
public getParent ( ) : string
Результат string

removeMethod() публичный Метод

Remove a method property
public removeMethod ( mixed $method ) : ClassGenerator
$method mixed
Результат ClassGenerator

render() публичный Метод

Render method
public render ( boolean $ret = false ) : mixed
$ret boolean
Результат mixed

setDocblock() публичный Метод

Set the docblock generator object
public setDocblock ( DocblockGenerator $docblock ) : ClassGenerator
$docblock DocblockGenerator
Результат ClassGenerator

setIndent() публичный Метод

Set the interface indent
public setIndent ( string $indent = null ) : InterfaceGenerator
$indent string
Результат InterfaceGenerator

setName() публичный Метод

Set the interface name
public setName ( string $name ) : InterfaceGenerator
$name string
Результат InterfaceGenerator

setNamespace() публичный Метод

Set the namespace generator object
public setNamespace ( NamespaceGenerator $namespace ) : ClassGenerator
$namespace NamespaceGenerator
Результат ClassGenerator

setParent() публичный Метод

Set the interface parent
public setParent ( string $parent = null ) : InterfaceGenerator
$parent string
Результат InterfaceGenerator

Описание свойств

$docblock защищенное свойство

Docblock generator object
protected DocblockGenerator,Pop\Code\Generator $docblock
Результат DocblockGenerator

$indent защищенное свойство

Class indent
protected string $indent
Результат string

$methods защищенное свойство

Array of method generator objects
protected array $methods
Результат array

$name защищенное свойство

Class name
protected string $name
Результат string

$namespace защищенное свойство

Namespace generator object
protected NamespaceGenerator,Pop\Code\Generator $namespace
Результат NamespaceGenerator

$output защищенное свойство

Class output
protected string $output
Результат string

$parent защищенное свойство

Parent interface that is extended
protected string $parent
Результат string