Documentation

FunctionTrait

Function trait

Tags
category

Pop

author

Nick Sagona, III dev@nolainteractive.com

copyright

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

license

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

version
4.1.0

Table of Contents

$arguments  : array<string|int, mixed>
Arguments
addArgument()  : FunctionTrait
Add an argument
addArguments()  : FunctionTrait
Add arguments
addParameter()  : FunctionTrait
Add an argument (alias method for convenience)
addParameters()  : FunctionTrait
Add arguments (alias method for convenience)
getArgument()  : array<string|int, mixed>
Get an argument
getArguments()  : array<string|int, mixed>
Get the arguments
getParameter()  : array<string|int, mixed>
Get an argument (alias method for convenience)
getParameters()  : array<string|int, mixed>
Get the arguments (alias method for convenience)
hasArgument()  : bool
Has an argument
hasArguments()  : bool
Has arguments
hasParameter()  : bool
Has an argument (alias method for convenience)
hasParameters()  : bool
Has arguments (alias method for convenience)
formatArguments()  : string
Format the arguments

Properties

$arguments

Arguments

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

Methods

addArgument()

Add an argument

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

addParameter()

Add an argument (alias method for convenience)

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

addParameters()

Add arguments (alias method for convenience)

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

getArgument()

Get an argument

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

getArguments()

Get the arguments

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

getParameter()

Get an argument (alias method for convenience)

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

getParameters()

Get the arguments (alias method for convenience)

public getParameters() : 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

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

formatArguments()

Format the arguments

protected formatArguments() : string
Return values
string

Search results