API Documentation
\
Pop
Acl
Assertion
Audit
Adapter
Model
Auth
Http
Cache
Adapter
Code
Generator
Config
Console
Controller
Cookie
Css
Color
Csv
Db
Adapter
Profiler
Gateway
Parser
Record
Relationships
Sql
Migration
Predicate
Schema
Seeder
Debug
Handler
Storage
Dir
Dom
Event
Form
Element
Input
Select
Filter
Ftp
Http
Client
Response
I18n
Format
Image
Adapter
Adjust
Color
Draw
Effect
Filter
Layer
Type
Kettle
Controller
Event
Model
Loader
Log
Writer
Mail
Client
Message
Transport
Smtp
Auth
Stream
Byte
Filter
Model
Module
Nav
Paginator
Pdf
Build
Font
Standard
TrueType
Table
Cmap
Html
Image
PdfObject
Document
Page
Annotation
Color
Field
Text
Router
Match
Service
Session
Validator
View
Template
Stream
Popcorn

\Pop\Code\GeneratorFunctionGenerator

Function generator code class

Summary

Methods
Properties
Constants
__construct()
setClosure()
isClosure()
setDesc()
getDesc()
setIndent()
getIndent()
setName()
getName()
setBody()
appendToBody()
getBody()
setDocblock()
getDocblock()
addArgument()
addArguments()
addParameter()
addParameters()
getArgument()
getArguments()
getArgumentNames()
getParameter()
getParameters()
getParameterNames()
render()
__toString()
No public properties found
No constants found
formatArguments()
parseFunction()
$docblock
$arguments
$name
$closure
$body
$indent
$output
N/A
No private methods found
No private properties found
N/A

Properties

$arguments

$arguments : array

Function arguments

Type

array

$name

$name : string

Function name

Type

string

$closure

$closure : boolean

Function interface flag

Type

boolean

$body

$body : string

Function body

Type

string

$indent

$indent : string

Function indent

Type

string

$output

$output : string

Function output

Type

string

Methods

__construct()

__construct(string  $name, mixed  $func = null)

Constructor

Instantiate the function generator object

Parameters

string $name
mixed $func

setClosure()

setClosure(boolean  $closure = false) : \Pop\Code\Generator\FunctionGenerator

Set the function closure flag

Parameters

boolean $closure

Returns

\Pop\Code\Generator\FunctionGenerator

isClosure()

isClosure() : boolean

Get the function closure flag

Returns

boolean

getDesc()

getDesc() : string

Get the function description

Returns

string

getIndent()

getIndent() : string

Get the function indent

Returns

string

getName()

getName() : string

Get the function name

Returns

string

setBody()

setBody(string  $body, boolean  $newline = true) : \Pop\Code\Generator\FunctionGenerator

Set the function body

Parameters

string $body
boolean $newline

Returns

\Pop\Code\Generator\FunctionGenerator

appendToBody()

appendToBody(string  $body, boolean  $newline = true) : \Pop\Code\Generator\FunctionGenerator

Append to the function body

Parameters

string $body
boolean $newline

Returns

\Pop\Code\Generator\FunctionGenerator

getBody()

getBody() : string

Get the function body

Returns

string

addArgument()

addArgument(string  $name, mixed  $value = null, string  $type = null) : \Pop\Code\Generator\FunctionGenerator

Add a function argument

Parameters

string $name
mixed $value
string $type

Returns

\Pop\Code\Generator\FunctionGenerator

addParameter()

addParameter(string  $name, mixed  $value = null, string  $type = null) : \Pop\Code\Generator\FunctionGenerator

Add a function argument (alias method for convenience)

Parameters

string $name
mixed $value
string $type

Returns

\Pop\Code\Generator\FunctionGenerator

addParameters()

addParameters(array  $args) : \Pop\Code\Generator\FunctionGenerator

Add function arguments (alias method for convenience)

Parameters

array $args

Returns

\Pop\Code\Generator\FunctionGenerator

getArgument()

getArgument(string  $name) : array

Get a function argument

Parameters

string $name

Returns

array

getArguments()

getArguments() : array

Get the function arguments

Returns

array

getArgumentNames()

getArgumentNames() : array

Get the function arguments

Returns

array

getParameter()

getParameter(string  $name) : array

Get a function argument (alias method for convenience)

Parameters

string $name

Returns

array

getParameters()

getParameters() : array

Get the function arguments (alias method for convenience)

Returns

array

getParameterNames()

getParameterNames() : array

Get the function arguments (alias method for convenience)

Returns

array

render()

render(boolean  $ret = false) : mixed

Render function

Parameters

boolean $ret

Returns

mixed

__toString()

__toString() : string

Print function

Returns

string

formatArguments()

formatArguments() : string

Method to format the arguments

Returns

string

parseFunction()

parseFunction(mixed  $func) : void

Method to format the arguments

Parameters

mixed $func