Documentation

FunctionGenerator extends AbstractGenerator
in package
Uses NameTrait, DocblockTrait, FunctionTrait, BodyTrait

Function generator class

Tags
category

Pop

author

Nick Sagona, III dev@nolainteractive.com

copyright

Copyright (c) 2009-2024 NOLA Interactive, LLC. (http://www.nolainteractive.com)

license

http://www.popphp.org/license New BSD License

version
5.0.0

Table of Contents

Properties

$arguments  : array<string|int, mixed>
Arguments
$body  : string|null
Function body
$closure  : bool
Function interface flag
$docblock  : DocblockGenerator|null
Docblock generator object
$indent  : int
Function indent
$name  : string|null
Name
$output  : string|null
Output string
$returnTypes  : array<string|int, mixed>
Return Types

Methods

__construct()  : mixed
Constructor
__toString()  : string
Print function
addArgument()  : static
Add an argument
addArguments()  : static
Add arguments
addParameter()  : static
Add an argument (alias method for convenience)
addParameters()  : static
Add arguments (alias method for convenience)
addReturnType()  : static
Add a return type
addReturnTypes()  : static
Add return types
appendToBody()  : static
Append to the function body
getArgument()  : array<string|int, mixed>|null
Get an argument
getArguments()  : array<string|int, mixed>
Get the arguments
getBody()  : string|null
Get the function body
getDesc()  : string|null
Get the docblock description
getDocblock()  : DocblockGenerator|null
Access the docblock generator object
getIndent()  : int
Get the indent
getName()  : string|null
Get the name
getOutput()  : string
Get the output
getParameter()  : array<string|int, mixed>|null
Get an argument (alias method for convenience)
getParameters()  : array<string|int, mixed>
Get the arguments (alias method for convenience)
getReturnTypes()  : array<string|int, mixed>
Get the return types
hasArgument()  : bool
Has an argument
hasArguments()  : bool
Has arguments
hasBody()  : bool
Has method body
hasDesc()  : bool
Has a docblock description
hasDocblock()  : bool
Has docblock generator object
hasIndent()  : bool
Has indent
hasName()  : bool
Get the name
hasOutput()  : bool
Has output
hasParameter()  : bool
Has an argument (alias method for convenience)
hasParameters()  : bool
Has arguments (alias method for convenience)
hasReturnType()  : bool
Has return type
hasReturnTypes()  : bool
Has return types
indentBody()  : static
Append to the function body
isClosure()  : bool
Get the function closure flag
isRendered()  : bool
Is rendered (alias to hasOutput())
printIndent()  : string
Print the indent
render()  : string
Render function
setAsClosure()  : FunctionGenerator
Set the function closure flag
setBody()  : static
Set the function body
setDesc()  : static
Set the docblock description
setDocblock()  : static
Set the docblock generator object
setIndent()  : AbstractGenerator
Set the indent
setName()  : static
Set the name
formatArguments()  : string|null
Format the arguments

Properties

$arguments

Arguments

protected array<string|int, mixed> $arguments = []

$name

Name

protected string|null $name = null

$returnTypes

Return Types

protected array<string|int, mixed> $returnTypes = []

Methods

__construct()

Constructor

public __construct([string|null $name = null ][, bool $closure = false ]) : mixed

Instantiate the function generator object

Parameters
$name : string|null = null
$closure : bool = false

__toString()

Print function

public __toString() : string
Return values
string

addArgument()

Add an argument

public addArgument(string $name[, mixed $value = null ][, string|null $type = null ]) : static
Parameters
$name : string
$value : mixed = null
$type : string|null = null
Return values
static

addArguments()

Add arguments

public addArguments(array<string|int, mixed> $args) : static
Parameters
$args : array<string|int, mixed>
Tags
throws
InvalidArgumentException
Return values
static

addParameter()

Add an argument (alias method for convenience)

public addParameter(string $name[, mixed $value = null ][, string|null $type = null ]) : static
Parameters
$name : string
$value : mixed = null
$type : string|null = null
Return values
static

addParameters()

Add arguments (alias method for convenience)

public addParameters(array<string|int, mixed> $args) : static
Parameters
$args : array<string|int, mixed>
Return values
static

addReturnType()

Add a return type

public addReturnType(string $type) : static
Parameters
$type : string
Return values
static

addReturnTypes()

Add return types

public addReturnTypes(array<string|int, mixed> $types) : static
Parameters
$types : array<string|int, mixed>
Return values
static

appendToBody()

Append to the function body

public appendToBody(string $body) : static
Parameters
$body : string
Return values
static

getArgument()

Get an argument

public getArgument(string $name) : array<string|int, mixed>|null
Parameters
$name : string
Return values
array<string|int, mixed>|null

getArguments()

Get the arguments

public getArguments() : array<string|int, mixed>
Return values
array<string|int, mixed>

getBody()

Get the function body

public getBody() : string|null
Return values
string|null

getDesc()

Get the docblock description

public getDesc() : string|null
Return values
string|null

getName()

Get the name

public getName() : string|null
Return values
string|null

getParameter()

Get an argument (alias method for convenience)

public getParameter(string $name) : array<string|int, mixed>|null
Parameters
$name : string
Return values
array<string|int, mixed>|null

getParameters()

Get the arguments (alias method for convenience)

public getParameters() : array<string|int, mixed>
Return values
array<string|int, mixed>

getReturnTypes()

Get the return types

public getReturnTypes() : array<string|int, mixed>
Return values
array<string|int, mixed>

hasArgument()

Has an argument

public hasArgument(string $name) : bool
Parameters
$name : string
Return values
bool

hasArguments()

Has arguments

public hasArguments() : bool
Return values
bool

hasBody()

Has method body

public hasBody() : bool
Return values
bool

hasDesc()

Has a docblock description

public hasDesc() : bool
Return values
bool

hasDocblock()

Has docblock generator object

public hasDocblock() : bool
Return values
bool

hasName()

Get the name

public hasName() : bool
Return values
bool

hasParameter()

Has an argument (alias method for convenience)

public hasParameter(string $name) : bool
Parameters
$name : string
Return values
bool

hasParameters()

Has arguments (alias method for convenience)

public hasParameters() : bool
Return values
bool

hasReturnType()

Has return type

public hasReturnType(string $type) : bool
Parameters
$type : string
Return values
bool

hasReturnTypes()

Has return types

public hasReturnTypes() : bool
Return values
bool

indentBody()

Append to the function body

public indentBody(int $indent) : static
Parameters
$indent : int
Return values
static

isClosure()

Get the function closure flag

public isClosure() : bool
Return values
bool

isRendered()

Is rendered (alias to hasOutput())

public isRendered() : bool
Return values
bool

printIndent()

Print the indent

public printIndent() : string
Return values
string

setBody()

Set the function body

public setBody(string $body[, int $indent = 4 ]) : static
Parameters
$body : string
$indent : int = 4
Return values
static

setDesc()

Set the docblock description

public setDesc([string|null $desc = null ]) : static
Parameters
$desc : string|null = null
Return values
static

setName()

Set the name

public setName(string $name) : static
Parameters
$name : string
Return values
static

formatArguments()

Format the arguments

protected formatArguments() : string|null
Return values
string|null 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results