Documentation

Security
in package

Security class

Tags
author

Dodonov A.A.

Table of Contents

$securityRules  : SecurityRules|null
Security rules
getFileValue()  : string|array<string|int, mixed>
Method returns file value
getIntValue()  : int
Returning int value
getSecurityRules()  : SecurityRules
Method returns security rules
getStringValue()  : string
Returning string value
storeFile()  : string
Method stores file on disk
storeFileContent()  : string
Method stores file on disk

Properties

Methods

getFileValue()

Method returns file value

public static getFileValue(string|array<string|int, mixed> $value, bool $storeFiles) : string|array<string|int, mixed>
Parameters
$value : string|array<string|int, mixed>

data about the uploaded file

$storeFiles : bool

must be the file stored in the file system of the service or not

Tags
codeCoverageIgnore
Return values
string|array<string|int, mixed>

path to the stored file or the array $value itself

getIntValue()

Returning int value

public static getIntValue(mixed $value) : int
Parameters
$value : mixed

value to be made secure

Tags
codeCoverageIgnore
Return values
int

secure value

getStringValue()

Returning string value

public static getStringValue(string $value) : string
Parameters
$value : string

value to be made secure

Tags
codeCoverageIgnore
Return values
string

secure value

storeFile()

Method stores file on disk

public static storeFile(string $filePath, string $pathPrefix[, bool $decoded = false ]) : string
Parameters
$filePath : string

path to the saving file

$pathPrefix : string

prefix to file

$decoded : bool = false

if the file was not encodded in base64

Tags
codeCoverageIgnore
Return values
string

Path to file or null if the image was not loaded

storeFileContent()

Method stores file on disk

public static storeFileContent(string $fileContent, string $pathPrefix[, bool $decoded = false ]) : string
Parameters
$fileContent : string

content of the saving file

$pathPrefix : string

prefix to file

$decoded : bool = false

if the file was not encodded in base64

Tags
codeCoverageIgnore
Return values
string

Path to file

Search results