ApiOpenStudio PHPDoc

ProcessorHelper
in package

Class ProcessorHelper

Helper class for ApiOpenStudio Processors.

Table of Contents

$namespaces  : array<string|int, mixed>
List of namespaces to search for processors.
getProcessorString()  : string
Return processor namespace and class name string.
isProcessor()  : bool
Validate whether an object or array is a processor.

Properties

$namespaces

List of namespaces to search for processors.

private array<string|int, mixed> $namespaces = array('Security', 'Endpoint', 'Output', 'Processor', 'Core')

Methods

getProcessorString()

Return processor namespace and class name string.

public getProcessorString(string $className[, array<string|int, mixed>|null $namespaces = null ]) : string
Parameters
$className : string

Class name of processor.

$namespaces : array<string|int, mixed>|null = null

Namepsaces to search.

Tags
throws
ApiException

Unknown Processor.

Return values
string

Class string.

isProcessor()

Validate whether an object or array is a processor.

public isProcessor(mixed &$obj) : bool
Parameters
$obj : mixed

Object to test.

Return values
bool

Search results