\FAA\ObjEndpoint

Summary

Methods

Properties

Constants

__construct()
__get()
ToPlainObject()
Name()
Callback()
Regex()
Method()
IncludePath()
Matches()
NamedSegments()
NamedSegment()
ProvideWidget()

$
$
$
$
$
$
$
$
$

No constants found

No protected methods found

No protected properties found

N/A

No private methods found

$data
$includePath
$name
$_matches

N/A

Properties

$

$ :string

callback

Type

string

$

$ :array<mixed,string>|string

description

Type

array<mixed,string>|string

$

$ :boolean

is_named_matcher

Type

boolean

$

$ :boolean

active

Type

boolean

$

$ :string

regex

Type

string

$

$ :string

method

Type

string

$

$ :array

responses

Type

array

$

$ :array

named_arguments

Type

array

$

$ :mixed|null

_regex

Type

mixed|null

$data

$data :array

Type

array—The storage

$includePath

$includePath :string|null

Include path to widget

Type

string|null

$name

$name :string

Name of the widget

Type

string

$_matches

$_matches :

Buffer for matches

Type

Methods

__construct()

__construct(string  $name,string  $include,array  $entry)

Endpoint constructor.

Create a new endpoint object and resolve the named endpoint arguments on the fly

Parameters

string	$name	The endpoint name
string	$include	The absolute include path
array	$entry	The raw array from endpoint item entry

__get()

__get(string  $name): mixed|null

Magic getter function

Parameters

string

$name

The value name

Returns

mixed|null

ToPlainObject()

ToPlainObject(): \stdClass

Convert to class

Returns

\stdClass

Name()

Name(): string

Get the name directly

Returns

string

Callback()

Callback(): string

Get the callback function directly

Returns

string

Regex()

Regex(boolean  $original = false): string

Get the regular expression matcher

Parameters

boolean

$original

Returns

string

Method()

Method(): string

Get the method name

Returns

string

IncludePath()

IncludePath(): string

Get path Get the absolute include path

Returns

string —

The absolute include path

Matches()

Matches(  $matches)

List of found matching groups in endpoint url

Parameters

$matches

NamedSegments()

NamedSegments(): array|null

Get the segments

Returns

array|null

NamedSegment()

NamedSegment(  $name): mixed|null

Get a named request path

Parameters

$name

Returns

mixed|null

ProvideWidget()

ProvideWidget(): \FAA\Obj\Result

Provide widget Provide a widget instance

Returns

\FAA\Obj\Result —

A result object with widget instance