PHP Class Pinq\Queries\Functions\Parameters\ParameterBase

Author: Elliot Levin ([email protected])
Inheritance: implements Countable
Datei anzeigen Open project: timetoogo/pinq Class Usage Examples

Protected Properties

Property Type Description
$expressions Pinq\Expressions\ParameterExpression[]
$hasRequiredUnusedParameters boolean
$requiredUnusedExpressions Pinq\Expressions\ParameterExpression[]
$unusedExpressions Pinq\Expressions\ParameterExpression[]
$unusedParameterDefaultMap

Public Methods

Method Description
count ( )
getAll ( ) : ParameterExpression[] Gets an array of all parameters.
getRequiredUnusedParameters ( ) : ParameterExpression[] Gets any unused parameters without a default value.
getUnused ( ) : ParameterExpression[] Gets an array of unused parameters.
getUnusedParameterDefaultMap ( ) : Expression[] Returns an array containing default value expressions indexed by their respective unused parameter name.
hasRequiredUnusedParameters ( ) : boolean Whether there is an unused parameters without a default value.
hasUnused ( ) : boolean Whether there are any unused parameters.

Protected Methods

Method Description
__construct ( array $parameterExpressions, $usedParameters )

Method Details

__construct() protected method

protected __construct ( array $parameterExpressions, $usedParameters )
$parameterExpressions array

count() public method

public count ( )

getAll() final public method

Gets an array of all parameters.
final public getAll ( ) : ParameterExpression[]
return Pinq\Expressions\ParameterExpression[]

getRequiredUnusedParameters() public method

Gets any unused parameters without a default value.
public getRequiredUnusedParameters ( ) : ParameterExpression[]
return Pinq\Expressions\ParameterExpression[]

getUnused() public method

Gets an array of unused parameters.
public getUnused ( ) : ParameterExpression[]
return Pinq\Expressions\ParameterExpression[]

getUnusedParameterDefaultMap() public method

This is useful as it will introduce variables in the scope of the function that may be validly used.
public getUnusedParameterDefaultMap ( ) : Expression[]
return Pinq\Expressions\Expression[]

hasRequiredUnusedParameters() public method

Whether there is an unused parameters without a default value.
public hasRequiredUnusedParameters ( ) : boolean
return boolean

hasUnused() public method

Whether there are any unused parameters.
public hasUnused ( ) : boolean
return boolean

Property Details

$expressions protected_oe property

protected ParameterExpression[],Pinq\Expressions $expressions
return Pinq\Expressions\ParameterExpression[]

$hasRequiredUnusedParameters protected_oe property

protected bool $hasRequiredUnusedParameters
return boolean

$requiredUnusedExpressions protected_oe property

protected ParameterExpression[],Pinq\Expressions $requiredUnusedExpressions
return Pinq\Expressions\ParameterExpression[]

$unusedExpressions protected_oe property

protected ParameterExpression[],Pinq\Expressions $unusedExpressions
return Pinq\Expressions\ParameterExpression[]

$unusedParameterDefaultMap protected_oe property

protected $unusedParameterDefaultMap