\Pho\FrameworkFieldHelper

Helps set up fields.

Used by AbstractEdge and Handlers\Set (for Nodes)

Summary

Methods
Properties
Constants
__construct()
withIndex()
isUnique()
process()
probe()
No public properties found
No constants found
No protected methods found
$value
$settings
$with_index
$is_unique
N/A
No private methods found
No private properties found
N/A

Properties

$value

$value : 

Type

$settings

$settings : 

Type

$with_index

$with_index : boolean

whether the field has index

Type

boolean

$is_unique

$is_unique : boolean

whether the field is set to be unique

Type

boolean

Methods

__construct()

__construct(mixed  $value, array  $settings) 

Constructor.

Parameters

mixed $value

The value to check.

array $settings

Particle field settings.

Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/emresokullu/Code/website/phpdoc/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1275 Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/emresokullu/Code/website/phpdoc/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1275

withIndex()

withIndex() : boolean

Whether the field has index on it.

Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/emresokullu/Code/website/phpdoc/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1275 Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/emresokullu/Code/website/phpdoc/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1275

Returns

boolean

isUnique()

isUnique() : boolean

Whether the field must be unique

Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/emresokullu/Code/website/phpdoc/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1275 Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/emresokullu/Code/website/phpdoc/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1275

Returns

boolean

process()

process() : mixed

Applies directives to the value to return

Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/emresokullu/Code/website/phpdoc/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1275 Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/emresokullu/Code/website/phpdoc/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1275

Returns

mixed

probe()

probe() : void

Checks if the field meets the requirements of the constraints in the particle's FIELDS constant.

Throws

\InvalidArgumentException

thrown when there argument does not meet the constraints.