EdgeRule
in package
FinalYes
Declarative allow/deny rule for edges between slot patterns.
Tags
Table of Contents
Properties
- $allow : bool
- $attributes : array<string|int, mixed>
- $from : string|array<string|int, mixed>|null
- $label : string|null
- $to : string|array<string|int, mixed>|null
Methods
- __construct() : mixed
- allow() : self
- allowLabeled() : self
- connect() : RuleSet<string|int, EdgeRule>
- Allow movement between $from and $to in both directions.
- deny() : self
- disconnect() : RuleSet<string|int, EdgeRule>
- Deny movement between two patterns in both directions.
- meta() : self
Properties
$allow read-only
public
bool
$allow
$attributes read-only
public
array<string|int, mixed>
$attributes
= []
$from read-only
public
string|array<string|int, mixed>|null
$from
$label read-only
public
string|null
$label
= null
$to read-only
public
string|array<string|int, mixed>|null
$to
= null
Methods
__construct()
public
__construct(bool $allow, array<int|string, string|null>|string|null $from[, array<int|string, string|null>|string|null $to = null ][, string|null $label = null ][, array<string|int, mixed> $attributes = [] ]) : mixed
Parameters
- $allow : bool
- $from : array<int|string, string|null>|string|null
- $to : array<int|string, string|null>|string|null = null
- $label : string|null = null
- $attributes : array<string|int, mixed> = []
Tags
allow()
public
static allow(array<int|string, string|null>|string|null $from[, array<int|string, string|null>|string|null $to = null ][, array<string|int, mixed> $meta = [] ]) : self
Parameters
- $from : array<int|string, string|null>|string|null
- $to : array<int|string, string|null>|string|null = null
- $meta : array<string|int, mixed> = []
Tags
Return values
selfallowLabeled()
public
static allowLabeled([string|null $label = null ], array<int|string, string|null>|string|null $from[, array<int|string, string|null>|string|null $to = null ][, array<string|int, mixed> $meta = [] ]) : self
Parameters
- $label : string|null = null
- $from : array<int|string, string|null>|string|null
- $to : array<int|string, string|null>|string|null = null
- $meta : array<string|int, mixed> = []
Tags
Return values
selfconnect()
Allow movement between $from and $to in both directions.
public
static connect(array<int|string, string|null>|string|null $patternA[, array<int|string, string|null>|string|null $patternB = null ][, array<string|int, mixed> $meta = [] ]) : RuleSet<string|int, EdgeRule>
Parameters
- $patternA : array<int|string, string|null>|string|null
- $patternB : array<int|string, string|null>|string|null = null
- $meta : array<string|int, mixed> = []
Tags
Return values
RuleSet<string|int, EdgeRule>deny()
public
static deny([string|null $label = null ], array<int|string, string|null>|string|null $from[, array<int|string, string|null>|string|null $to = null ][, array<string|int, mixed> $meta = [] ]) : self
Parameters
- $label : string|null = null
- $from : array<int|string, string|null>|string|null
- $to : array<int|string, string|null>|string|null = null
- $meta : array<string|int, mixed> = []
Tags
Return values
selfdisconnect()
Deny movement between two patterns in both directions.
public
static disconnect(array<int|string, string|null>|string|null $patternA[, array<int|string, string|null>|string|null $patternB = null ][, array<string|int, mixed> $meta = [] ]) : RuleSet<string|int, EdgeRule>
Parameters
- $patternA : array<int|string, string|null>|string|null
- $patternB : array<int|string, string|null>|string|null = null
- $meta : array<string|int, mixed> = []
Tags
Return values
RuleSet<string|int, EdgeRule>meta()
public
meta(array<string|int, mixed> $attributes) : self
Parameters
- $attributes : array<string|int, mixed>