FacturaScripts

ApiPlugins extends ApiPlugins
in package
uses ExtensionsTrait

Class created by Core/Internal/PluginsDeploy

Table of Contents

Constants

API_VERSION  = 3
INCIDENT_EXPIRATION_TIME  = 600
IP_LIST  = 'api-ip-list'
MAX_INCIDENT_COUNT  = 5

Properties

$apiKey  : ApiKey
$extensionCache  : array<string|int, mixed>
Cache for extension lookups by method name.
$extensions  : array<string|int, mixed>
Stores class extensions.
$request  : Request
$response  : Response
$url  : string

Methods

__call()  : mixed
Executes the first matched extension.
__construct()  : mixed
addExtension()  : void
clearExtensions()  : void
Clears all registered extensions.
getExtensions()  : array<string|int, mixed>
Returns a list of all registered extension names.
getPageData()  : array<string|int, mixed>
hasExtension()  : bool
pipe()  : mixed
pipeFalse()  : bool
removeExtension()  : bool
Removes all extensions with the specified name.
run()  : void
db()  : DataBase
getUriParam()  : string
runResource()  : void
buildExtensionCache()  : void
Builds and caches sorted extensions for a method name.

Constants

INCIDENT_EXPIRATION_TIME

public mixed INCIDENT_EXPIRATION_TIME = 600

Properties

$extensionCache

Cache for extension lookups by method name.

protected static array<string|int, mixed> $extensionCache = []

$extensions

Stores class extensions.

protected static array<string|int, mixed> $extensions = []

Methods

__call()

Executes the first matched extension.

public __call(string $name[, array<string|int, mixed> $arguments = [] ]) : mixed
Parameters
$name : string
$arguments : array<string|int, mixed> = []
Tags
throws
BadMethodCallException

__construct()

public __construct(string $className[, string $url = '' ]) : mixed
Parameters
$className : string
$url : string = ''

addExtension()

public static addExtension(mixed $extension[, int $priority = 100 ]) : void
Parameters
$extension : mixed
$priority : int = 100

Priority for all methods in this extension (0-1000, default 100)

clearExtensions()

Clears all registered extensions.

public static clearExtensions() : void

getExtensions()

Returns a list of all registered extension names.

public static getExtensions() : array<string|int, mixed>
Return values
array<string|int, mixed>

getPageData()

public getPageData() : array<string|int, mixed>
Return values
array<string|int, mixed>

hasExtension()

public hasExtension(mixed $name) : bool
Parameters
$name : mixed
Return values
bool

pipe()

public pipe(string $name, array<string|int, mixed> ...$arguments) : mixed
Parameters
$name : string
$arguments : array<string|int, mixed>

pipeFalse()

public pipeFalse(string $name, array<string|int, mixed> ...$arguments) : bool
Parameters
$name : string
$arguments : array<string|int, mixed>
Return values
bool

removeExtension()

Removes all extensions with the specified name.

public static removeExtension(string $name) : bool
Parameters
$name : string
Return values
bool —

True if at least one extension was removed

getUriParam()

protected getUriParam(string $num) : string
Parameters
$num : string
Return values
string

buildExtensionCache()

Builds and caches sorted extensions for a method name.

private buildExtensionCache(string $name) : void
Parameters
$name : string 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results