Documentation

Documentation

Packages

Application

Interfaces, Classes and Traits

ErrorController
The error controller handles all bad requests. Other controllers can redirect to this one.
IndexController
The index controller handles by default all requests without a specified controller
LoginController
The Login controller handles all login/logout stuff
SitemapController
The sitemap controller generates sitemaps and serves them to the client
ZController
The ZController contains actions for the admin dashboard / panel
z_fileModel
The file model handles dynamic files
z_generalModel
The general model does general stuff that is needed everywhere
z_loginModel
The login model holds logging in and out of users
z_statisticsModel
The statistics model handles log data
z_userModel
User Model
z_framework
First class that is instantiated during a request.
z_controller
Base class for all controllers. Controllers should inherit from this class.
z_db
Proxy for all database access. Also holds utility functions
passwordHandler
Password handling class
z_model
Base class for all models. Models should inherit from this.
Request
Base class for Response and Request
FormResult
Holds the result of a validation of a form
FormField
Represents an input field of a form on the server side
RequestResponseHandler
Base class for the response and request objects
Response
The Response class provides functions used by controllers to respond to requests
Rest
The rest class is used to provide raw JSON API data to the client
z_upload
Class that handles file uploads and checking types
User
The User class holds information about the user

Table of Contents

FILE_SIZE_100GB  = 104857600000
FILE_SIZE_100MB  = 104857600
FILE_SIZE_10GB  = 10485760000
FILE_SIZE_10MB  = 10485760
FILE_SIZE_1GB  = 1048576000
FILE_SIZE_1MB  = 1048576
FILE_SIZE_200MB  = 209715200
FILE_SIZE_20GB  = 20971520000
FILE_SIZE_20MB  = 20971520
FILE_SIZE_2GB  = 2097152000
FILE_SIZE_2MB  = 2097152
FILE_SIZE_500MB  = 524288000
FILE_SIZE_50GB  = 52428800000
FILE_SIZE_50MB  = 52428800
FILE_SIZE_5GB  = 5242880000
FILE_SIZE_5MB  = 5242880
TIMESPAN_DAY_1  = 86400
TIMESPAN_DAY_10  = 864000
TIMESPAN_DAY_14  = 1209600
TIMESPAN_DAY_180  = 15552000
TIMESPAN_DAY_182  = 15724800
TIMESPAN_DAY_2  = 172800
TIMESPAN_DAY_20  = 1728000
TIMESPAN_DAY_21  = 1814400
TIMESPAN_DAY_3  = 259200
TIMESPAN_DAY_30  = 2592000
TIMESPAN_DAY_365  = 31536000
TIMESPAN_DAY_60  = 5184000
TIMESPAN_DAY_7  = 604800
TIMESPAN_DAY_90  = 7776000
UPLOAD_ERROR_NO_FILE  = 4
UPLOAD_ERROR_NOT_MOVED  = 3
UPLOAD_ERROR_TOO_BIG  = 1
UPLOAD_ERROR_WRONG_TYPE  = 2
UPLOAD_SUCCESS  = 0
Value for a succeeded upload
getCaller()  : any
Helper function to get the caller of a function
e()  : string|null
makeSlug()  : mixed
uecho()  : mixed
var_swap()  : mixed
shortenStr()  : mixed
emptyToNull()  : mixed
de_strtolower()  : mixed
essentialsHead()  : mixed
Call this to paste the essential head part of a page into the layout
essentialsBody()  : mixed
Call this to paste the essential body part of a page into the layout

Constants

FILE_SIZE_100GB

public mixed FILE_SIZE_100GB = 104857600000

FILE_SIZE_100MB

public mixed FILE_SIZE_100MB = 104857600

FILE_SIZE_10GB

public mixed FILE_SIZE_10GB = 10485760000

FILE_SIZE_10MB

public mixed FILE_SIZE_10MB = 10485760

FILE_SIZE_1GB

public mixed FILE_SIZE_1GB = 1048576000

FILE_SIZE_200MB

public mixed FILE_SIZE_200MB = 209715200

FILE_SIZE_20GB

public mixed FILE_SIZE_20GB = 20971520000

FILE_SIZE_20MB

public mixed FILE_SIZE_20MB = 20971520

FILE_SIZE_2GB

public mixed FILE_SIZE_2GB = 2097152000

FILE_SIZE_500MB

public mixed FILE_SIZE_500MB = 524288000

FILE_SIZE_50GB

public mixed FILE_SIZE_50GB = 52428800000

FILE_SIZE_50MB

public mixed FILE_SIZE_50MB = 52428800

FILE_SIZE_5GB

public mixed FILE_SIZE_5GB = 5242880000

TIMESPAN_DAY_10

public mixed TIMESPAN_DAY_10 = 864000

TIMESPAN_DAY_14

public mixed TIMESPAN_DAY_14 = 1209600

TIMESPAN_DAY_180

public mixed TIMESPAN_DAY_180 = 15552000

TIMESPAN_DAY_182

public mixed TIMESPAN_DAY_182 = 15724800

TIMESPAN_DAY_20

public mixed TIMESPAN_DAY_20 = 1728000

TIMESPAN_DAY_21

public mixed TIMESPAN_DAY_21 = 1814400

TIMESPAN_DAY_30

public mixed TIMESPAN_DAY_30 = 2592000

TIMESPAN_DAY_365

public mixed TIMESPAN_DAY_365 = 31536000

TIMESPAN_DAY_60

public mixed TIMESPAN_DAY_60 = 5184000

TIMESPAN_DAY_90

public mixed TIMESPAN_DAY_90 = 7776000

UPLOAD_ERROR_NO_FILE

public mixed UPLOAD_ERROR_NO_FILE = 4

UPLOAD_ERROR_NOT_MOVED

public mixed UPLOAD_ERROR_NOT_MOVED = 3

UPLOAD_ERROR_TOO_BIG

public mixed UPLOAD_ERROR_TOO_BIG = 1

UPLOAD_ERROR_WRONG_TYPE

public mixed UPLOAD_ERROR_WRONG_TYPE = 2

UPLOAD_SUCCESS

Value for a succeeded upload

public mixed UPLOAD_SUCCESS = 0

Functions

getCaller()

Helper function to get the caller of a function

getCaller([int $depth = 1 ]) : any
Parameters
$depth : int = 1

Index of the callstack from back to front

Return values
any —

The caller

e()

e(string|null $value) : string|null
Parameters
$value : string|null
Return values
string|null —

makeSlug()

makeSlug(mixed $str) : mixed
Parameters
$str : mixed
Return values
mixed —

uecho()

uecho(mixed $value) : mixed
Parameters
$value : mixed
Return values
mixed —

var_swap()

var_swap(mixed &$x, mixed &$y) : mixed
Parameters
$x : mixed
$y : mixed
Return values
mixed —

shortenStr()

shortenStr(mixed $str[, mixed $maxlength = 10 ][, mixed $cutDescriptor = "..." ]) : mixed
Parameters
$str : mixed
$maxlength : mixed = 10
$cutDescriptor : mixed = "..."
Return values
mixed —

emptyToNull()

emptyToNull(mixed &$value) : mixed
Parameters
$value : mixed
Return values
mixed —

de_strtolower()

de_strtolower(mixed $string) : mixed
Parameters
$string : mixed
Return values
mixed —

essentialsHead()

Call this to paste the essential head part of a page into the layout

essentialsHead(object $opt, mixed $customBootstrap) : mixed
Parameters
$opt : object

Object holding options for rendering

$customBootstrap : mixed
Return values
mixed —

essentialsBody()

Call this to paste the essential body part of a page into the layout

essentialsBody(object $opt) : mixed
Parameters
$opt : object

Object holding options for rendering

Return values
mixed —

Search results