Documentation

userFileOption extends fileOption
in package

File option objekt

Tags
author

Stefan Seehafer sea75300@yahoo.de

copyright

(c) 2011-2022, Stefan Seehafer

license

http://www.gnu.org/licenses/gpl.txt GPLv3

Table of Contents

EXTENSION_CACHE  = '.fpcm'
$doCrypt  : bool
Do encryption
$path  : string
Complete file path
__construct()  : void
Constructor
read()  : mixed
Fetch data from file option
remove()  : bool
Remove file option
write()  : bool
Write content to file option
decrypt()  : string
Decrypts data
encrypt()  : string
Encrypts data
getExt()  : string
Return extension for cache file
getType()  : string
Return path type
getCryptInstance()  : crypt
Returns \fpcm\classes\crypt class instance

Constants

EXTENSION_CACHE

public mixed EXTENSION_CACHE = '.fpcm'

Properties

$doCrypt

Do encryption

private bool $doCrypt = false

Methods

__construct()

Constructor

public __construct(string $option[, bool $doCrypt = false ]) : void
Parameters
$option : string
$doCrypt : bool = false
Return values
void

read()

Fetch data from file option

public read() : mixed
Return values
mixed

remove()

Remove file option

public remove() : bool
Return values
bool

write()

Write content to file option

public write(mixed $data) : bool
Parameters
$data : mixed
Return values
bool

decrypt()

Decrypts data

protected decrypt(mixed $param) : string
Parameters
$param : mixed
Return values
string

encrypt()

Encrypts data

protected encrypt(mixed $param) : string
Parameters
$param : mixed
Return values
string

getExt()

Return extension for cache file

protected getExt() : string
Return values
string

getType()

Return path type

protected getType() : string
Return values
string

getCryptInstance()

Returns \fpcm\classes\crypt class instance

private getCryptInstance() : crypt
Return values
crypt

Search results