API - XOOPS 2.5.11 Beta 2
By monxoops.fr
KeyAbstract Class Reference
Inheritance diagram for KeyAbstract:

Public Member Functions

 __construct (StorageInterface $storage, $name)
 
 getSigning ()
 
 getVerifying ()
 
 create ()
 
 kill ()
 

Protected Attributes

 $storage
 
 $name
 

Constructor & Destructor Documentation

◆ __construct()

__construct ( StorageInterface  $storage,
  $name 
)

KeyAbstract constructor.

Parameters
StorageInterface$storagekey store
string$namecase insensitive key name, allow only A-Z, 0-9, _ and -

Member Function Documentation

◆ create()

create ( )
abstract

create the key and store it for use

Returns
boolean true if key was created and stored, otherwise false

Reimplemented in Basic.

◆ getSigning()

getSigning ( )
abstract

get key for use in signing

Returns
string signing key

Reimplemented in Basic.

◆ getVerifying()

getVerifying ( )
abstract

get key for use in verifying

Returns
string verifying key

Reimplemented in Basic.

◆ kill()

kill ( )
abstract

delete the key

Returns
boolean true if key was deleted, otherwise false

Reimplemented in Basic.

Field Documentation

◆ $name

$name
protected

◆ $storage

$storage
protected

The documentation for this class was generated from the following file: