Documentation

StorageInterface
in

Debug storage interface

Tags
category

Pop

author

Nick Sagona, III dev@nolainteractive.com

copyright

Copyright (c) 2009-2024 NOLA Interactive, LLC. (http://www.nolainteractive.com)

license

http://www.popphp.org/license New BSD License

version
2.2.0

Table of Contents

Methods

clear()  : void
Clear all debug data
decodeValue()  : mixed
Decode the value based on the format
delete()  : void
Delete debug data by ID
encodeValue()  : string
Encode the value based on the format
getById()  : mixed
Get debug data by ID
getByType()  : mixed
Get debug data by type
getFormat()  : string|null
Get the storage format
has()  : bool
Determine if debug data exists by ID
isJson()  : bool
Determine if the format is JSON
isPhp()  : bool
Determine if the format is PHP
isText()  : bool
Determine if the format is PHP
save()  : void
Save debug data
setFormat()  : StorageInterface
Set the storage format

Methods

decodeValue()

Decode the value based on the format

public decodeValue(mixed $value) : mixed
Parameters
$value : mixed

delete()

Delete debug data by ID

public delete(string $id) : void
Parameters
$id : string

encodeValue()

Encode the value based on the format

public encodeValue(mixed $value) : string
Parameters
$value : mixed
Return values
string

getById()

Get debug data by ID

public getById(string $id) : mixed
Parameters
$id : string

getByType()

Get debug data by type

public getByType(string $type) : mixed
Parameters
$type : string

getFormat()

Get the storage format

public getFormat() : string|null
Return values
string|null

has()

Determine if debug data exists by ID

public has(string $id) : bool
Parameters
$id : string
Return values
bool

isJson()

Determine if the format is JSON

public isJson() : bool
Return values
bool

isPhp()

Determine if the format is PHP

public isPhp() : bool
Return values
bool

isText()

Determine if the format is PHP

public isText() : bool
Return values
bool

save()

Save debug data

public save(string $id, mixed $value) : void
Parameters
$id : string
$value : mixed

        
On this page

Search results