Overview

Namespaces

  • Composer
    • Autoload
  • Geekwright
    • RegDom
  • League
    • OAuth2
      • Client
        • Provider
  • None
  • Xmf
    • Database
    • Jwt
    • Key
    • Module
      • Helper

Classes

  • ArrayStorage
  • Basic
  • FileStorage
  • KeyAbstract

Interfaces

  • StorageInterface
  • Overview
  • Namespace
  • Class
  • Tree

Class FileStorage

Xmf\Key\StorageInterface

load a database table

Xmf\Key\FileStorage implements Xmf\Key\StorageInterface
Namespace: Xmf\Key
Package: Xmf
Category: Xmf\Key\FileStorage
Copyright: 2016 XOOPS Project (http://xoops.org)
License: GPL 2 or later (http://www.gnu.org/licenses/gpl-2.0.html)
Author: Richard Griffith richard@geekwright.com
Link: http://xoops.org
Located at lass/libraries/vendor/xoops/xmf/src/Xmf/Key/FileStorage.php
Methods summary
protected string
# fileName( string $name )

Fetch key data by name

Fetch key data by name

Parameters

$name
key name

Returns

string
file name
protected string
# systemSecret( )

Construct a string related to the system to make name less predictable

Construct a string related to the system to make name less predictable

Returns

string
public boolean
# save( string $name, string $data )

Save key data by name

Save key data by name

Parameters

$name
key name
$data
key data, serialized to string if required

Returns

boolean
true if key saved, otherwise false

Implementation of

Xmf\Key\StorageInterface::save()
public string|false
# fetch( string $name )

Fetch key data by name

Fetch key data by name

Parameters

$name
key name

Returns

string|false
key data (possibly serialized) or false on error

Implementation of

Xmf\Key\StorageInterface::fetch()
public boolean
# exists( string $name )

Check if key data exists

Check if key data exists

Parameters

$name
key name

Returns

boolean
true if key exists, otherwise false

Implementation of

Xmf\Key\StorageInterface::exists()
public boolean
# delete( string $name )

Delete a key

Delete a key

Parameters

$name
key name

Returns

boolean
true if key deleted, otherwise false

Implementation of

Xmf\Key\StorageInterface::delete()
API documentation generated by ApiGen