FileAccess Orion

ArrayToObject()

Convert array to object


    public
            static        ArrayToObject(array<string|int, mixed> $array) : stdClass|null

Convert the given array element to object, using the json methods

Parameters

$array : array<string|int, mixed>: The input values to convert

Return values

stdClass|null —

The converted element as object

CalculateFolderSize()

Calculate size of a specific folder use a recursive working function to calculate a folder size


    public
            static        CalculateFolderSize(string $folder) : array<string|int, mixed>

Parameters

$folder : string: The path to calculate the size of

Return values

array<string|int, mixed> —

A assoc structure holding the folder information

CallExecutable()

Execute a system command Uses installed executable to perform a system call


    public
            static        CallExecutable(string $cmd[, string $folder = '' ][, string $outfile = '' ]) : Result

Parameters

$cmd : string: The command to execute
$folder : string = '': The working directory
$outfile : string = '': Optional output file of the call result

Return values

Result —

A system result object

CallHook()

Call hook


    public
            static        CallHook(string $name[, mixed|Result|BaseContent &$returns = false ][, mixed|BaseContent &$parameter = null ]) : bool

Calls the interfaces and plugins that are registered on this hook

Available system hooks are:

OnClearAllCache Called when all system caches are cleared at once, has no given argument

OnIndex Called in search index cron job. Has a reference to the job and the list of indexed elements. $parameter contains the content type (ct), the list of changes (list) and the name of the plugin (handler)

OnNewIndex Called in Cache::RecreateIndex with list of files inside the storage folder.

OnSyncronize Called on sync. Gets the list of changed files based on the history buffer. Arguments are similar to OnNewIndex.

RequestOnUrlParsed Called in request constructor, can be used to modify the request itself and the parsed url. Has a reference to the request and the parsed url

OnGetEntityAttributes Called in entity attribute loader. Can be used to modify the whole entity object e.g. add custom fields or tabs.

OnLoadEntityFormPreset Called when using the widget method to get a content type preset. Call is Widget::loadEntityFormPreset $returns is the parsed content type object with resolved attributes.

OnRegisterWidgetIncludes Called on TemplateEngine::renderExtension. Gets as argument the includes list in $param->returns

OnBasketLoadFieldPresetStatus Called in Basket::LoadFieldPresetStatus. Gets as argument the list of available status switches in $param->returns These include a label, value and a set of fields

OnDeleteContent Called in BaseContent when successfully deleted. Gets a reference to the status object and the deleted object. State is referenced in $returns, the deleted object in $parameter

OnAddOrUpdateContent Called in BaseContent when successfully updated or, created. Gets a reference to the status object and the object. State is referenced in $returns, the changed object in $parameter

OnBeforeAddOrUpdateContent Called in base content right before the saver operation State is referenced in $returns, the changed object in $parameter

OnBeforeUserAdminSave Called before saving user data. Gets a reference to the user data payload and a result object.

OnAfterUserAdminSave Called after saving user data. Gets a reference to the user, extras and the payload.

OnUserAdminLoad Called in users widget, when loading own user data (loadSingle). Gets return data and the widget as argument. $returns contains the plain user object, $parameter is a reference to the user widget.

OnUserOwnLoad Called in users widget, when loading own user data (LoadOwn, SendGoogleAuthMail). Gets return data and the widget as argument. $returns contains the plain user object, $parameter is a reference to the user widget.

BasketChangeStatus Hook is called when basket status was changed successfully. $returns contains reference to a system result object. $parameter is an object with the basket instance in key 'basket' and the changes in key 'payload' plus the language

OnBeforeConvertBasketToTask Called right before converting basket to task, has information about the basket and the payload for the new task

OnInitTaskWidget Called in project tasks widget after preparation of data in init call The returns contains an array with the preset data, parameter is the original user request

OnPrepareSiteMapLinks Called in site map generator with returns as result object and $parameter filled with list of links

OnProjectLoadEmployeeRoles Called in project widget when loading employee roles, $returns is the list of roles

OnAfterSendMail Called after successful sending email

OnBeforeResendSendMail Called before sending email to customer (again)

OnAfterPermissionCheck Called in check access to directory, The argument is of type AccessHookArgument, the result a result

OnGetAccessList Called when fetching the user session as last step. Arguments are the response and the user object

OnAfterBasketRegisterUser Called in basket widget after registration of basket is done. Arguments are the result object and an array with user_id and payload as values

OnPreImportContents Called when executing the import cronjob Argument is a file entry after the unzip process

OnRenameFolder Called when renaming the folder by short attribute update or when moving it entirely Called with Result object as return and a FolderMoveHookArgument as parameter

OnDisplay404 Called right before serving the 404 page. Allows the plugins to do some checks before. Argument is the Request object, return is a result object.

OnAddOrUpdateTask Called in task widget on create or update of task Called with Result object as return and a Task as parameter

OnAddService Called on create new service Returns is a result object and param is class with relation and payload

OnCleanupGarbage Called in garbage collect cron job Called with Result object as return and a Job as parameter

OnGetLoginRedirectUrl Called in the getter for the redirect url after successful login Called with Result object as return and the original request url as parameter

OnAfterRelationDelete Called after relation was deleted Called with Result object as return and the combination of relation and content as parameter

OnExecuteSearchUser Call in user search handler Gets the result object nd the search parameters as arguments

OnGetSearchFieldsUser Called after fetch user fields for search The returns argument is the fields of the user

OnUserStatusChange Called after the user active status is change but before saving the user Param is array with user from and target status

OnAfterUserLoginByPassword Called after user password check, param is object with user, credentials and a found indication

OnAfterUserRegisterSession Called after session registration, this is the point where the user is actually logged in Param is the user object.

OnPreUserRegisterSession Called before session registration is done, param is the user object

OnMapArrayIncludes Called after static assets are parsed in template handling Param is the list of links and the result object

OnRenderLoginExtraPre / OnRenderLoginExtra Called on rendering the login template, Response my be usd to add an additional html content

OnAfterRestUserPassword Called after password reset, with arguments result and the user object

OnSearchRelationAttributeList Called in relation attribute search handler when a service related attribute list is queried Parameter is the action with post body payload and the language

OnEmployeeAssignmentStatusChange Called when the assignment status of an employee is changed. Param are the task and the result object

OnBeforeRegisterUser Called on before the user is registered, can be used to modify the user data upfront

OnAfterRegisterUser Called after registration of user was done, param is the user itself

OnBeforeMarkSubscriptionForSwitch Called before users subscription should be changed, param is the user and returns is the result object

OnAfterMarkSubscriptionForSwitch Called when users subscription should be changed, param is the user and returns is the result object

OnMarkSubscriptionForTermination Called when users subscription should be changed, param is the user and returns is the result object

OnNewsletterUserRequiresNotification Called right before new newsletters are queued for a user, the argument is a class with the user and th related newsletter object

OnCronJobRegistered On new cron job from table. Argument is the cron job instance

OnCronJobCompleted On complete cron job from table. Argument is the cron job instance

OnCronJobStarted On start cron job from table. Argument is the cron job instance

OnCronJobProgressChanged Called when the progress was changed and persisted. Argument is the cron job

OnAfterSendMail After email was send, param is the email instance

OnMailRegistered Right after email was registered for sending by cronjob. Param is the email instance

Parameters

$name : string: Name of hook
$returns : mixed|Result|BaseContent = false: Return reference, regularly a Result object
$parameter : mixed|BaseContent = null: Secondary argument, use to add additional information for the call

Return values

bool —

Chmod()

Change the permissions of a file


    public
            static        Chmod(string $file, int $octal) : bool

Parameters

$file : string
$octal : int

Return values

bool —

ClassExists()

Class exists


    public
            static        ClassExists(string $className) : bool

A cached version of class exists to prevent autoloader from starting

Parameters

$className : string: The name of the class

Return values

bool —

Status is existing

ClearCache()

Clear the static cache


    public
            static        ClearCache() : void

Return values

void —

CollatorExists()

Check if collators available Test if the ICU collator functions ae available. This function is cached.


    public
            static        CollatorExists() : bool

Return values

bool —

True when collator is available

ConfigGetPreset()

Load a config preset Fetch a preset from default system storage location and return it decoded


    public
            static        ConfigGetPreset(string $name[, bool $mode = true ]) : Result

Parameters

$name : string: The preset name
$mode : bool = true: Decode to assoc or boolean

Return values

Result —

A system result object

Context()

Get/Set the global context


    public
            static        Context([AppContext|null $context = null ]) : AppContext|Request|CronJob|CommandLineContext

Parameters

$context : AppContext|null = null

Return values

AppContext|Request|CronJob|CommandLineContext —

CopyFile()

Copy file Copy a single file with obtaining lock on index before


    public
            static        CopyFile(string $source, string $target[, bool $override = true ]) : Result

Parameters

$source : string: Absolute path to source
$target : string: Absolute path to target
$override : bool = true: Override forced even if file names are equal

Return values

Result —

A system result object

CopyFolder()

Copy folder


    public
            static        CopyFolder(string $source, string $target[, bool $override = true ]) : Result

This method copies the source folder to the target folder path. The folder itself is not copied but all of its contents. This method creates the target folder if it is not present.

Parameters

$source : string: The source folder destination
$target : string: The target folder name
$override : bool = true: Override forced even if file names are equal

Return values

Result —

A system result object

CorsDomains()

Set or get the domains that are allowed for cors


    public
            static        CorsDomains([null $domains = null ]) : Result

If none are defined we will automatically add the * wildcard

Parameters

$domains : null = null

Return values

Result —

DataBase()


    public
            static        DataBase(string $name) : DBAL|null

Parameters

$name : string

Return values

DBAL|null —

Debug()

log debug object writs a formatted log message including back trace to the global log file


    public
            static        Debug(mixed $object) : void

Parameters

$object : mixed: The object to be logged

Return values

void —

DecodeJson()

Parse json from string to object or assoc


    public
            static        DecodeJson(string $data[, bool $mode = true ][, array<string|int, mixed>|string|null $crypt = null ]) : Result

Use the json parse function to decode a string to assoc or object It will use the given code in crypt to decrypt or fall back to system key

Parameters

$data : string: The payload to decode
$mode : bool = true: Parse as assoc or object, default is true and therefor assoc array
$crypt : array<string|int, mixed>|string|null = null: The key or, an array with cipher, key and the iv

Return values

Result —

A default system result object

DecodeJsonFile()

Parse json from file to object or assoc


    public
            static        DecodeJsonFile(string $path[, bool $mode = true ][, string|null $crypt = null ]) : Result

Use the json parse to fetch text data from a given path and return it as object with assoc or object payload

Parameters

$path : string: The absolute path to a certain storage file
$mode : bool = true: Parse as assoc or object, default assoc
$crypt : string|null = null: Decrypt string before parsing

Return values

Result —

A default system result object

DeleteFile()

Deletes single file This method deletes a single file, it will wait when the system is in git lock mode


    public
            static        DeleteFile(string $path) : bool

Parameters

$path : string: The target file path

Return values

bool —

True on success otherwise false

DropFolder()

Delete a full folder


    public
            static        DropFolder(string $folder[, bool $full = false ]) : array<string|int, mixed>

this method clears or delete a folder recursively, side effect will fill list of delete folders and files

Parameters

$folder : string: The path to delete
$full : bool = false: Also remove the root folder

Return values

array<string|int, mixed> —

List of deleted folders and files

EncodeJson()

Serialize a given input to json representation


    public
            static        EncodeJson(mixed $data[, int $mode = JSON_PRETTY_PRINT ][, array<string|int, mixed>|string|null $crypt = null ]) : Result

use the json parse function to decode an assoc or object

Parameters

$data : mixed: The payload to encode
$mode : int = JSON_PRETTY_PRINT: Serialize readable or not formatted
$crypt : array<string|int, mixed>|string|null = null: Encrypt key or, array with key cipher and iv

Return values

Result —

A default system result object

ExtractExtension()

Extract file extension


    public
            static        ExtractExtension(string $path) : bool|string

May return false if no extension could be found

Parameters

$path : string: A complete file path

Return values

bool|string —

The file extension or, false if not matched

ExtractFileName()

Extract file name


    public
            static        ExtractFileName(string $path[, bool $without_extension = false ]) : string

Parameters

$path : string: A complete file path
$without_extension : bool = false

Return values

string —

The file name

ExtractFolder()

Extract folder path from root


    public
            static        ExtractFolder(string $path) : string

With input /var/www/school/test.json will result in /var/www/school/

Parameters

$path : string: A complete file path

Return values

string —

The file root folder

ExtractFolderName()

Extract folder name from root


    public
            static        ExtractFolderName(string $path) : string

Parameters

$path : string: A complete file path

Return values

string —

The file root folder

ExtractHostName()

Get reduced hostname reduce a hostname to defined components, e.g. when you give www.test.de and set length to 2 you will get test.de


    public
            static        ExtractHostName([string|null $host = null ][, int $length = 2 ][, bool $port = true ]) : string|null

Parameters

$host : string|null = null: Hostname to reduce
$length : int = 2: The maximum length of components
$port : bool = true: Remove the port number when set false

Return values

string|null —

The reduced domain to given components count

FileExists()

Check if file exists


    public
            static        FileExists(string $fileName[, bool $caseSensitive = true ]) : bool|string

Does check if a file is existing, will also check if the file exists as lower case by glob as fallback.

Parameters

$fileName : string: The path to the file
$caseSensitive : bool = true: Use case-sensitive path, defaults to true

Return values

bool|string —

File exists

FilterFolderFilesByModificationTime()

Get a list of files that are either older or newer a certain time point


    public
            static        FilterFolderFilesByModificationTime(string $root, int $timestamp[, bool $older = true ]) : Result

Parameters

$root : string: The start point for the recursion
$timestamp : int: The time point to flip
$older : bool = true: When true result list files are older than the time stamp otherwise newer

Return values

Result —

A system result object containing the files

GenerateUUIDv4()

Generate an unique id


    public
            static        GenerateUUIDv4() : string

Return values

string —

GetClassNames()

List classes in folder Fetch a list of classes inside the folder


    public
            static        GetClassNames(array<string|int, mixed> $paths[, string|null $ignore = null ]) : array<string|int, mixed>

Parameters

$paths : array<string|int, mixed>: List of paths to search
$ignore : string|null = null: A regular expression to filter

Return values

array<string|int, mixed> —

A list of class names found in the folder

GetLink()

Resolve optimized link


    public
            static        GetLink(string $path, Domain $dom) : null|Link

Calculate the optimized link expression for the given path including the language

Parameters

$path : string: The requested raw path
$dom : Domain: The target domain

Return values

null|Link —

The link object or null when not registered

GetLock()

Obtain lock try to obtain the lock indicated by lock file in var


    public
            static        GetLock() : Result

Return values

Result —

A default system result object

GetObjectLock()


    public
            static        GetObjectLock(BaseContent $content) : bool

Parameters

$content : BaseContent

Return values

bool —

GetSortKey()

Calculate the sort key Using the ICU collator to create a sort key representation of the given string.


    public
            static        GetSortKey(string $text[, string $collation = FAA_LOCALE ][, bool $encode = false ]) : Result

Parameters

$text : string: The text to convert to sort key
$collation : string = FAA_LOCALE: The collation to use for convert e.g. en_US or, de
$encode : bool = false: When set to true, convert the sort key to urlencoded representation

Return values

Result —

A default system result object

GzCompressFile()

GZIPs a file on disk (appending .gz to the name)


    public
            static        GzCompressFile(string $source[, int $level = 9 ][, bool $clean = true ][, scalar $suffix = null ]) : Result

From http://stackoverflow.com/questions/6073397/how-do-you-create-a-gz-file-using-php Based on function by Kioob at: http://www.php.net/manual/en/function.gzwrite.php#34955

Parameters

$source : string: Path to file that should be compressed
$level : int = 9: GZIP compression level (default: 9)
$clean : bool = true: Clean source file after compression (default: true)
$suffix : scalar = null: Additional suffix for the target

Return values

Result —

A default system result object

IsBase64()

Guess if string is base64 will try to guess if the given string is base64


    public
            static        IsBase64(string $string[, bool $simple = true ]) : bool

Parameters

$string : string: The string to check
$simple : bool = true: Use a simple method to check the given content with fallback to complex check

Return values

bool —

True on success otherwise false

IsEmptyDir()

Is empty folder


    public
            static        IsEmptyDir(string $dir) : bool|null

Parameters

$dir : string: Path to folder

Return values

bool|null —

KnownPlugins()

Get the known plugins


    public
            static        KnownPlugins() : array<string|int, Plugin>

Return values

array<string|int, Plugin> —

ListFiles()

list files Iterate over directory and list the found files


    public
            static        ListFiles(string $dir[, string $ext = '/^json$/' ][, bool $full = false ]) : array<string|int, mixed>

Parameters

$dir : string: The root folder path to search in
$ext : string = '/^json$/': Filter by extension (can be empty, a string or a regex)
$full : bool = false: Check the full name of the file or just the extension when false

Return values

array<string|int, mixed> —

A list containing the found files

ListFolders()

List folder names in certain root folder


    public
            static        ListFolders(string $path) : array<string|int, mixed>

Parameters

$path : string: The absolute path to the folder

Return values

array<string|int, mixed> —

The found folder names that are children of the given folder

ListIdFiles()

find file ids find a list of file ids inside a folder and its sub directories


    public
            static        ListIdFiles(string $dir[, string $ext = 'json' ][, bool $to_int = true ]) : array<string|int, mixed>

Parameters

$dir : string: The root folder path to search in
$ext : string = 'json': Filter by extension
$to_int : bool = true: Convert to integer when set to true

Return values

array<string|int, mixed> —

A list containing the found id's

Log()

log object writs a formatted log message including back trace to the global log file


    public
            static        Log(mixed $object[, string|null $msg = null ]) : void

Parameters

$object : mixed: The object to be logged
$msg : string|null = null: Additional message

Return values

void —

MemoryBytesReadable()

Memory readable Convert size of bytes in human-readable units


    public
            static        MemoryBytesReadable(int|float $size) : string

Parameters

$size : int|float: The size in bytes

Return values

string —

The calculated size

MimeType()

Get mime type of file


    public
            static        MimeType(string $file) : string|bool

Parameters

$file : string: The absolute file path

Return values

string|bool —

The mime type of the file or, false if not resolvable

MkFolder()

Create folder path


    public
            static        MkFolder(string $root, array<string|int, mixed> $components[, bool $make = true ]) : string|null

When the make argument set to true this function will try to create the folder Return the folder components without root part

Parameters

$root : string: The path to the base folder
$components : array<string|int, mixed>: The list of folder components
$make : bool = true: Try to create the folder

Return values

string|null —

The combined relative path as string, includes tailing /

OSName()


    public
            static        OSName() : string

Return values

string —

Plugin()

Get plugin


    public
            static        Plugin(string $name) : Plugin|null

Get one of the registered plugins. This function uses the cache

Parameters

$name : string: Get plugin instance

Return values

Plugin|null —

A plugin instance or null when not registered

ReadCsv()

Read a CSV file to local storage


    public
            static        ReadCsv(string $path[, string $delimiter = ';' ][, string $enclosure = "'" ][, int $length = 100000 ][, string $escape = "\" ][, bool $check_head = true ]) : Result

Fetch the file and add it to a local result object file is parsed with php function to get csv from file, arguments of this methods align with official one

Parameters

$path : string: The absolute path to file to open
$delimiter : string = ';': Have a look at http://php.net/manual/de/function.fgetcsv.php delimiter
$enclosure : string = "'": Have a look at http://php.net/manual/de/function.fgetcsv.php enclosure
$length : int = 100000: Have a look at http://php.net/manual/de/function.fgetcsv.php length
$escape : string = "\": Have a look at http://php.net/manual/de/function.fgetcsv.php escape
$check_head : bool = true: When set, check the first line as head and validate following line lengths

Return values

Result —

A system result object

ReadFile()

Read a single file


    public
            static        ReadFile(string $path) : Result

Parameters

$path : string: The absolute path to a certain storage file

Return values

Result —

A default system result object

ReadFixedColumnFile()

Read file with fixed column width


    public
            static        ReadFixedColumnFile(string $path[, int $length = 10000 ]) : Result

Automatic file parser based on the heads and assuming a " " space is used to make the cols equal

Parameters

$path : string: Absolute link to the file to open
$length : int = 10000: Limiter for line length

Return values

Result —

A system result object

ReadFolder()

Read folder


    public
            static        ReadFolder(string $dir) : array<string|int, File>

Will list all files and folders of a folder

Parameters

$dir : string: Path to root folder

Return values

array<string|int, File> —

An array of file objects

Redirect()

send redirect set a redirect header to the given location


    public
            static        Redirect(string $url[, bool $permanent = false ]) : void

Parameters

$url : string: The target url
$permanent : bool = false: Set as 301 when permanent

Return values

void —

RenameFolderOrFile()

Rename folder or file


    public
            static        RenameFolderOrFile(string $source, string $target[, bool $skip_existing = true ]) : Result

Parameters

$source : string: Absolute path to source
$target : string: Absolute path to target
$skip_existing : bool = true

Return values

Result —

A system result object

Request()

Base request handling


    public
            static        Request(Request $request) : Response

This is the main interface for all types of resources provided by andromeda

Parameters

$request : Request

Return values

Response —

RevokeLock()

release lock try to release the lock indicated by lock file in var


    public
            static        RevokeLock([string|null $lockfile = null ][, bool $in_memory = true ]) : Result

Parameters

$lockfile : string|null = null
$in_memory : bool = true

Return values

Result —

A default system result object

RevokeObjectLock()


    public
            static        RevokeObjectLock(BaseContent $content) : Result

Parameters

$content : BaseContent

Return values

Result —

SelfLockedOrOpen()


    public
            static        SelfLockedOrOpen( $pid[,  $path = null ]) : bool

Parameters

$pid :
$path : = null

Return values

bool —

SendResponse()

Sen the response to the browser.


    public
            static        SendResponse(Response $res, Request $request) : void

Supports all response types like html or download defined in the given response object.

Parameters

$res : Response: The response object
$request : Request: The original request

Return values

void —

SetCacheHeaders()

Set cache header for http browser caching


    public
            static        SetCacheHeaders(Request $request, Response $response[, int $lifetime = FAA_HTTP_CACHE_BROWSER_DURATION ]) : void

set a list of performance header to enable browser side caching When the lifetime is set to a negative value, the cache will be deactivated

Parameters

$request : Request: The original request
$response : Response: The response object
$lifetime : int = FAA_HTTP_CACHE_BROWSER_DURATION: Max lifetime of cache in seconds

Return values

void —

SetCorsHeader()

Set CORS header


    public
            static        SetCorsHeader(Request $request, Response $res) : void

Sets CORS header to enable cross domain access in special cases

Parameters

$request : Request: The original request
$res : Response: The response object

Return values

void —

SetJSONHeader()

Set the json response type header


    public
            static        SetJSONHeader() : void

Return values

void —

SetPerformanceHeaders()

set performance header set a list of performance header to give a simple impression of the system request performance


    public
            static        SetPerformanceHeaders(Request $request, Response $res) : void

Parameters

$request : Request: The original request
$res : Response: The response object

Return values

void —

setResponseCode()

set http response code header set a basic http response code, wrap function http_response_code() if it is not existing


    public
            static        setResponseCode(int $code) : void

Parameters

$code : int: The http response code

Return values

void —

SetSecurityHeaders()

Set security header


    public
            static        SetSecurityHeaders(Response $response, Request $request[, string|null $csp = null ]) : void

Set a list of security header to enable client side security features

Parameters

$response : Response: The response object
$request : Request: The original request
$csp : string|null = null: The Content-Security-Policy from config

Return values

void —

StoreEncodedJson()

Serialize a given input and store it


    public
            static        StoreEncodedJson(string $path, mixed $data[, int $mode = JSON_PRETTY_PRINT ][, bool|null $crypt = false ]) : Result

use the json parse function to create json representation and store it in a certain file this method does an encryption also on demand, the .key file must exist for this to happen

Parameters

$path : string: The target file path
$data : mixed: The payload to encode
$mode : int = JSON_PRETTY_PRINT: Serialize readable or not formatted
$crypt : bool|null = false: Encrypt the result after serialisation

Return values

Result —

A default system result object

StripQueryAndAnchor()

Extract file name


    public
            static        StripQueryAndAnchor(string $path) : string

Parameters

$path : string: A complete file path

Return values

string —

The file name without additional parts

SysLog()

Log message


    public
            static        SysLog(string $level, mixed $object[, string|null $prefix = null ][, bool $stack = true ]) : bool

Writs a formatted log message including back trace on severe levels to the global log file

Parameters

$level : string: Name of the log level
$object : mixed: The object to be logged
$prefix : string|null = null: Extra prefix
$stack : bool = true: Print with stack trace on demand

Return values

bool —

Status if write to log worked

SystemInformation()

Get system information


    public
            static        SystemInformation(Response $response) : void

Parameters

$response : Response

Return values

void —

TailLogfile()

tail a log file get set of lines inside a logfile


    public
            static        TailLogfile(string $path[, int $max = 200 ][, int $buffer = 4096 ]) : Result

Parameters

$path : string: The target log file path
$max : int = 200: Maximum buffer length of array
$buffer : int = 4096: Maximum buffer length of line characters

Return values

Result —

A default system result object

TryGetLock()

Obtain lock with retry


    public
            static        TryGetLock([string|null $path = null ][, string|int $pid = null ][, int $try_count = FAA_WRITE_RETRY ][, float $seconds = 0.25 ][, bool $in_memory = true ]) : bool

Try to obtain the lock indicated by lock file in var Additional lock level reliability with process id

Parameters

$path : string|null = null: Path to lock file to obtain lock at
$pid : string|int = null
$try_count : int = FAA_WRITE_RETRY: Number of retry runs
$seconds : float = 0.25: Seconds to wait per run
$in_memory : bool = true

Return values

bool —

True on successful lock otherwise false

TryUnLock()

Unlock try to disable the lock indicated by lock file in var


    public
            static        TryUnLock([string|null $path = null ]) : bool

Parameters

$path : string|null = null: Path to lock file to obtain lock at

Return values

bool —

A default system result object

Unzip()

Unzip a file


    public
            static        Unzip(string $file[, string|null $target = null ][, bool $chunks = false ]) : Result

Take the archive, unzip it and place the results in the defined folder or an automated one

Parameters

$file : string: Absolute path to file
$target : string|null = null: The output folder or, null for dynamic one
$chunks : bool = false

Return values

Result —

The unzip result

Version()


    public
            static        Version() : string

Return values

string —

VersionStringToNumber()

Convert version number Converts the given number to a unified string e.g. 'v1.234.33' will become 102340033


    public
            static        VersionStringToNumber(string $number[, string $regex = '/[^0-9\.]/i' ][, string $replace = '' ][, int $pads = 4 ]) : string

Parameters

$number : string: The version number to calculate
$regex : string = '/[^0-9\.]/i': Replacement expression to clear the number upfront
$replace : string = '': Replacement string for regex_replace
$pads : int = 4: Add this amount of zeros to the left

Return values

string —

The cleared version number

Warn()

warn level log object writs a formatted log message including back trace to the global log file


    public
            static        Warn(mixed $object[, bool $stack = true ]) : void

Parameters

$object : mixed: The object to be logged
$stack : bool = true

Return values

void —

WriteCsv()

Write a array of entries to csv file


    public
            static        WriteCsv(string|null $path, array<string|int, mixed> $list[, string $delimiter = ';' ][, string $enclosure = "'" ][, string $escape = "\" ]) : Result

Parameters

$path : string|null: The absolute path to file to open
$list : array<string|int, mixed>: The source to write
$delimiter : string = ';': Have a look at http://php.net/manual/de/function.fgetcsv.php delimiter
$enclosure : string = "'": Have a look at http://php.net/manual/de/function.fgetcsv.php enclosure
$escape : string = "\": Have a look at http://php.net/manual/de/function.fgetcsv.php escape

Return values

Result —

The result

WriteFile()

Write string to file


    public
            static        WriteFile(string $path, scalar $data, int $flags) : bool

This method writes the given data to the defined file, it will wait when the system is in git lock mode. This method returns valid result also for writing empty strings unlike file put contents default behavior

Parameters

$path : string: The target file path
$data : scalar: The payload to store in the target file
$flags : int: File put content flags (http://php.net/manual/de/function.file-put-contents.php)

Return values

bool —

True on success

Zip()

Create a zip archive from folder or file contents


    public
            static        Zip(string $source, string $target) : Result

Parameters

$source : string
$target : string

Return values

Result —

RegisterPlugins()

Register plugins


    protected
            static        RegisterPlugins() : mixed

Load the plugins from filesystem and register them for hook calling This function is cached.

Return values

mixed —

CalculateFolderSizeRecurse()

Helper function to calculate size Recursively calculate size of a specific folder


    private
            static        CalculateFolderSizeRecurse(string $folder, int &$file_count, int &$directory_count, int &$size) : bool

Parameters

$folder : string: The path to calculate the size of
$file_count : int: Pointer to file count
$directory_count : int: Pointer to folder count
$size : int: Pointer to file size

Return values

bool —

The iteration result status

decrypt()

Decrypt data


    private
            static        decrypt(string $encrypted[, string|array<string|int, mixed> $mc_key = FAA_CODE ]) : string

will try to decrypt the given data with the system encryption code or a customer defined one The function does a blowfish decryption and a base64 conversion on demand

Parameters

$encrypted : string: The string to decrypt (must be base64 encoded)
$mc_key : string|array<string|int, mixed> = FAA_CODE: The key or, an array with cipher, key and the iv

Return values

string —

The decrypted string

DropFolderRecurse()

Delete a folder completely this method is the recursion helper for DropFolder()


    private
            static        DropFolderRecurse(string $folder[, bool $full = false ]) : bool

Parameters

$folder : string: The path to delete
$full : bool = false: Also remove the root folder

Return values

bool —

The delete status

encrypt()

Encrypt data


    private
            static        encrypt(string $plain[, string|array<string|int, mixed> $mc_key = FAA_CODE ][, mixed &$tag = null ]) : string

Method will try to encrypt the given data with the system encryption code or a customer defined one The function does a blowfish encryption and a base64 conversion

Parameters

$plain : string: The string to encrypt
$mc_key : string|array<string|int, mixed> = FAA_CODE: The key or, an array with cipher, key and the iv
$tag : mixed = null

Return values

string —

The encrypted string base64 encoded

googleRegistration()

Handle fetch of google registration file


    private
            static        googleRegistration(Request $request, Response $res) : void

Parameters

$request : Request: The original request
$res : Response: The response object

Return values

void —

handleApiCall()

Handle api call Handle api call operations that are linked to a system widget


    private
            static        handleApiCall(Endpoint $endpoint, Request $request, Response $response) : void

Parameters

$endpoint : Endpoint: A system REST endpoint object
$request : Request: The original request
$response : Response: The response object

Return values

void —

handleDirectoryCall()

Handle virtual directory call The virtual directory call operations are connected to existing virtual directories


    private
            static        handleDirectoryCall(string $path, Request $request, Response $response) : void

Parameters

$path : string: The call path
$request : Request: The original request
$response : Response: The response object

Return values

void —

handleLockedSystem()

Handle the system is locked case


    private
            static        handleLockedSystem(Request $request, Response $res) : void

Sends a 503 response header including a retry after

Parameters

$request : Request
$res : Response

Return values

void —

handleRootCall()

Handle root call


    private
            static        handleRootCall(Request $request, Response $response) : void

Handle root call cases, these happen when the system is requested with / Will redirect to the corresponding real path for home folder

Parameters

$request : Request: The original request
$response : Response: The response object

Return values

void —

handleSystemCall()

Handle system call Handle system call operations like login, logout and basic session operations


    private
            static        handleSystemCall(string $call, Request $request, Response $res) : void

Parameters

$call : string: The call type
$request : Request: The original request
$res : Response: The response object

Return values

void —

heartBeat()

Store the heart beat info


    private
            static        heartBeat(Request $request, Response $res) : void

Parameters

$request : Request: The original request
$res : Response: The response object

Return values

void —

isSystemOperation()

Detect system request Detect if a specific request is a registered system operation


    private
            static        isSystemOperation(Request $request) : bool|string

Parameters

$request : Request

Return values

bool|string —

parseKeyFile()


    private
            static        parseKeyFile(string $path) : null|string|array<string|int, mixed>

Parameters

$path : string

Return values

null|string|array<string|int, mixed> —

publicAsset()

Handle potential public asset calls


    private
            static        publicAsset(Request $request, Response $res) : void

Actual url to file mapping needs to be done in the hook "RegisterPublicAssetBasePath"

Parameters

$request : Request: The original request
$res : Response: The response object

Return values

void —

siteMap()

Handle the site map default behavior


    private
            static        siteMap(Request $request, Response $res) : void

Parameters

$request : Request: The original request
$res : Response: The response object

Return values

void —

thirdPartyCookie()

Test the third party cookie support


    private
            static        thirdPartyCookie(Request $request, Response $res) : void

Parameters

$request : Request: The original request
$res : Response: The response object

Return values

void —

updateData()

Handle update call


    private
            static        updateData(Request $request, Response $res[, string $mode = 'data' ]) : void

This method can be used to update the system by github webhook call It is secured with the default signed payload approach The configuration will be used when defined otherwise only push to master will trigger this action

Parameters

$request : Request: The original request
$res : Response: The response object
$mode : string = 'data'

Return values

void —

Http extends System in package Core

Tags

Table of Contents

Properties

$affected

$classes

$collator

$context

$cors_domain_file

$db

$hooks

$log_template

$plugins

$size_unit

Methods

ArrayToObject()

Parameters

Return values

CalculateFolderSize()

Parameters

Return values

CallExecutable()

Parameters

Return values

CallHook()

Available system hooks are:

Parameters

Return values

Chmod()

Parameters

Return values

ClassExists()

Parameters

Return values

ClearCache()

Return values

CollatorExists()

Return values

ConfigGetPreset()

Parameters

Return values

Context()

Parameters

Return values

CopyFile()

Parameters

Return values

CopyFolder()

Parameters

Return values

CorsDomains()

Parameters

Return values

DataBase()

Parameters

Return values

Debug()

Parameters

Return values

DecodeJson()

Parameters

Return values

DecodeJsonFile()

Parameters

Return values

DeleteFile()

Parameters

Return values

DropFolder()

Parameters

Return values

EncodeJson()

Parameters

Return values

ExtractExtension()

Parameters

Return values

ExtractFileName()

Parameters

Return values

Http extends System
in package

Core