ACCESS_PATH
public
mixed
ACCESS_PATH
= __DIR__ . '/../public'
public
mixed
ACCESS_PATH
= __DIR__ . '/../public'
public
mixed
ADMIN_EMAIL
= 'ADMIN_EMAIL_IS_MISSING'
public
mixed
ADMIN_EMAIL
= 'admin@domain.com'
public
mixed
APPLICATION_PATH
= \ORPHEUS_PATH
public
mixed
AUTHOR_NAME
= 'AUTHOR_IS_MISSING'
public
mixed
AUTHOR_NAME
= 'Developer'
public
mixed
AUTHOR_WEBSITE
= 'https://developer.com/'
public
mixed
CACHE_PATH
= \STORE_PATH . '/cache'
public
mixed
CHECK_MODULE_ACCESS
= \true
public
mixed
COMPOSER_HOME
= \INSTANCE_PATH . '/.composer'
public
mixed
CONFIG_FOLDER
= '/config'
public
mixed
CRAC_CONTEXT_AGENCY
= 2
public
mixed
CRAC_CONTEXT_APPLICATION
= 1
public
mixed
CRAC_CONTEXT_RESOURCE
= 3
public
mixed
DATE_FORMAT_GNU
= 1
public
mixed
DATE_FORMAT_LOCALE
= 0
public
mixed
DEBUG_ENABLED
= \true
public
mixed
DEFAULT_HOST
= 'APP_DOMAIN_IS_MISSING'
public
mixed
DEFAULT_HOST
= 'domain.com'
public
mixed
DEFAULT_LOCALE
= 'en_US'
public
mixed
DEFAULT_LOCALE
= $envConfig['LOCALE']
public
mixed
DEFAULT_MEMBER_ROUTE
= \ROUTE_HOME
public
mixed
DEFAULT_MEMBER_ROUTE
= \DEFAULT_ROUTE
public
mixed
DEFAULT_PACKAGES
= ['@application']
public
mixed
DEFAULT_PATH
= '/'
public
mixed
DEFAULT_ROUTE
= \ROUTE_HOME
public
mixed
DEFAULT_ROUTE
= 'home'
public
mixed
DEV_EMAIL
= 'DEV_EMAIL_IS_MISSING'
public
mixed
DEV_EMAIL
= 'developer@domain.com'
public
mixed
DEV_VERSION
= \true
public
mixed
DOMAIN_APP
= 'application'
public
mixed
DOMAIN_CACHE
= 'cache'
public
mixed
DOMAIN_COMPOSER
= 'composer'
public
mixed
DOMAIN_LOGS
= 'logs'
public
mixed
DOMAIN_SETUP
= 'setup'
public
mixed
DOMAIN_SETUP
= 'setup'
public
mixed
DOMAIN_TEST
= 'test'
public
mixed
DOMAIN_TRANSLATIONS
= 'translations'
public
mixed
DOMAIN_TRANSLATIONS
= 'translations'
public
mixed
DOMAIN_USER
= 'user'
public
mixed
EMAIL_SENDER_NAME
= 'Application name'
public
mixed
ENTITY_CLASS_CHECK
= \true
public
mixed
ENTITY_DESCRIPTOR_CONFIG_FOLDER
= '/entities'
public
mixed
ERROR_DEBUG_LEVEL
= \E_ALL
public
mixed
ERROR_DISPLAY_RAW
= 1
public
mixed
ERROR_IGNORE
= 2
public
mixed
ERROR_PROD_LEVEL
= \E_CORE_ERROR
public
mixed
ERROR_THROW_EXCEPTION
= 0
public
mixed
FACEBOOK_APP_ID
= ''
public
mixed
FACEBOOK_APP_SECRET
= ''
public
mixed
FILE_SOURCE_TYPE_DATA_URI
= 'datauri'
public
mixed
FILE_SOURCE_TYPE_UPLOAD
= 'upload'
public
mixed
FILE_SOURCE_TYPE_UPLOAD_CONVERTED
= 'upload_converted'
public
mixed
FILE_SOURCE_TYPE_WKPDF
= 'wkpdf'
public
mixed
FILE_STORE_PATH
= \STORE_PATH . '/files'
public
mixed
FILE_USAGE_INVOICE
= 'invoice'
public
mixed
FILE_USAGE_USER_PICTURE
= 'user_picture'
public
mixed
HOST
= \SCHEME
public
mixed
HTTP_BAD_REQUEST
= 400
public
mixed
HTTP_FORBIDDEN
= 403
public
mixed
HTTP_FOUND
= 302
public
mixed
HTTP_INTERNAL_SERVER_ERROR
= 500
public
mixed
HTTP_METHOD_GET
= 'GET'
public
mixed
HTTP_MOVED_PERMANENTLY
= 301
public
mixed
HTTP_MOVED_TEMPORARILY
= \HTTP_FOUND
public
mixed
HTTP_NOT_FOUND
= 404
http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html
public
mixed
HTTP_OK
= 200
public
mixed
HTTP_UNAUTHORIZED
= 401
public
mixed
HTTPS
= \true
public
mixed
IMAGES_URL
= \STATIC_ASSETS_URL . '/images'
public
mixed
INSTANCE_ID
= 'orpheus.local'
public
mixed
INSTANCE_PATH
= \APPLICATION_PATH
public
mixed
IS_CONSOLE
= \PHP_SAPI === 'cli'
public
mixed
IS_WEB
= !\IS_CONSOLE
public
mixed
JS_URL
= \STATIC_ASSETS_URL . '/js'
public
mixed
LANG_FOLDER
= '/languages'
public
mixed
LOGFILE_DEBUG
= 'debug.log'
public
mixed
LOGFILE_HACK
= 'hack.log'
public
mixed
LOGFILE_NOT_FOUND
= 'not-found.log'
public
mixed
LOGFILE_SQL
= 'sql.log'
public
mixed
LOGFILE_SYSTEM
= 'system.log'
public
mixed
LOGS_PATH
= \STORE_PATH . '/logs'
public
mixed
OPT_ENTITY
= 4
public
mixed
OPT_KEY
= \OPT_VALUE_IS_KEY | \OPT_LABEL_IS_KEY
public
mixed
OPT_LABEL2VALUE
= \OPT_VALUE_IS_VALUE | \OPT_LABEL_IS_KEY
public
mixed
OPT_LABEL_IS_KEY
= 2
public
mixed
OPT_LABEL_IS_VALUE
= 0
public
mixed
OPT_VALUE
= \OPT_VALUE_IS_VALUE | \OPT_LABEL_IS_VALUE
public
mixed
OPT_VALUE2LABEL
= \OPT_VALUE_IS_KEY | \OPT_LABEL_IS_VALUE
public
mixed
OPT_VALUE_IS_KEY
= 1
public
mixed
OPT_VALUE_IS_VALUE
= 0
public
mixed
ORPHEUS_PATH
= '..'
public
mixed
PATH
= '/'
public
mixed
REPLY_EMAIL
= 'no-reply@domain.com'
public
mixed
ROUTE_ADM_HOME
= 'admin_home'
public
mixed
ROUTE_ADM_MY_SETTINGS
= 'adm_my_settings'
public
mixed
ROUTE_ADM_USER
= 'adm_user'
public
mixed
ROUTE_ADM_USER_LIST
= 'adm_user_list'
public
mixed
ROUTE_DEV_APP_TRANSLATE
= 'dev_translate'
public
mixed
ROUTE_DEV_COMPOSER
= 'dev_composer'
public
mixed
ROUTE_DEV_CONFIG
= 'dev_config'
public
mixed
ROUTE_DEV_ENTITIES
= 'dev_entities'
public
mixed
ROUTE_DEV_HOME
= 'dev_home'
public
mixed
ROUTE_DEV_LOG_VIEW
= 'dev_log_view'
public
mixed
ROUTE_DEV_LOGS
= 'dev_logs'
public
mixed
ROUTE_DEV_SYSTEM
= 'dev_system'
public
mixed
ROUTE_DOWNLOAD_LATEST
= 'download_latest'
public
mixed
ROUTE_DOWNLOAD_RELEASES
= 'download_releases'
public
mixed
ROUTE_FILE_DOWNLOAD
= 'file_download'
public
mixed
ROUTE_HOME
= 'home'
public
mixed
ROUTE_USER_LOGIN
= 'login'
public
mixed
ROUTE_USER_LOGOUT
= 'logout'
public
mixed
SCHEME
= 'https'
public
mixed
SESSION_COOKIE_LIFETIME
= 86400 * 7
public
mixed
SESSION_COOKIE_PATH
= '/'
public
mixed
SESSION_SHARE_ACROSS_SUBDOMAIN
= \false
public
mixed
SESSION_WITH_COOKIE
= 1 << 0
public
mixed
SESSION_WITH_HTTP_TOKEN
= 1 << 1
public
mixed
SRC_PATH
= \APPLICATION_PATH . '/src'
public
mixed
STATIC_ASSETS_URL
= \WEB_ROOT . '/static'
public
mixed
STORE_PATH
= \INSTANCE_PATH . '/store'
public
mixed
STYLE_URL
= \STATIC_ASSETS_URL . '/style'
public
mixed
SYSTEM_TIME_FORMAT
= 'H:M'
public
mixed
TEMP_PATH
= \STORE_PATH . '/temp'
public
mixed
THEMES_FOLDER
= '/themes'
public
mixed
THEMES_PATH
= \ACCESS_PATH . \THEMES_FOLDER
public
mixed
THEMES_PATH
= \ACCESS_PATH . \THEMES_FOLDER
public
mixed
TIME
= 1000000
public
mixed
TRANSLATIONS_PATH
= \STORE_PATH . '/translations'
public
mixed
VENDOR_PATH
= \INSTANCE_PATH . '/vendor'
public
mixed
VENDOR_URL
= \STATIC_ASSETS_URL . '/vendor'
public
mixed
WEB_ROOT
= \SCHEME . '://' . \HOST . (\PATH !== '/' ? \PATH : '')
displayByteRow(string $label, int $value) : void
displayRow(string $label, string $value) : void
rowStaticInput(string $id, string $label, string $value) : void
collapsiblePanelHTML(string $id, string $title, string $description, string $panelClass[, bool $open = false ]) : void
listFileUsages() : array<string|int, mixed>
listFileSourceTypes() : array<string|int, mixed>
run(string $command) : void
writeError(mixed $text) : void
writeText(mixed $text) : void
writeInfo(mixed $text) : void
writeSuccess(mixed $text) : void
parseYesNoValue(string|false $value[, string $default = 'y' ]) : bool
getComposerRevisions(string $path) : array<string|int, mixed>
sendAdminRegistrationEmail(User $user) : void
storeBackTrace() : void
Define an undefined constant.
defifn(string $name, string|int|bool $value) : true
The name of the constant.
The value of the constant.
if the constant was defined successfully, else False.
Get the nullable value of the constant
safeConstant(string $name) : mixed|null
The value of constant or null if undefined
Gets the directory path
getParentPath(string $path) : string
The path get parent directory
The secured path
Gets the path of a file/directory.
pathOf(string $relativePath[, bool $silent = false ]) : string|null
This function uses global variable $APP_SOURCE_PATHS to get the known paths. It allows developers to get a dynamic path to a file.
The common path
Do not throw exception if path does not exist
The first valid path or null if there is no valid one.
Checks if the path exists.
existsPathOf(string $commonPath[, string|null &$path = null ]) : bool
This function uses pathOf() to determine possible path of $commonPath and checks if there is any file with this path in file system.
The common path
The output parameter to get the first valid path
Add the path to the known paths
addSrcPath(string $path) : bool
The source path to add.
True if the path was added.
List all source paths
listSrcPath() : array<string|int, string>
Include a directory
includeFolder(string $folder[, array<string|int, mixed> $importants = [] ]) : int
The directory to include.
The files in that are importants to load first.
The number of files included.
Include all files with a name beginning by '_' in the directory $dir. It browses recursively through sub folders.
Escape the text $str from special characters
escapeText(string $str[, int $flags = ENT_NOQUOTES ]) : string
The string to escape
The flags of htmlentities()
The escaped string
http_response_code_text([int|null $code = null ]) : mixed
displayException(Throwable $Exception) : never
displayExceptionAsHTML(Throwable $Exception) : never
displayExceptionAsText(Throwable $Exception) : never
typeOf(mixed $var) : string
displayRawException(Throwable $Exception) : void
displayStackTraceAsHtml(array<string|int, mixed> $backtrace) : void
displayExceptionStackTrace(Throwable $Exception) : void
getClassName(object|string $var) : string
processException(Throwable $exception[, mixed $log = null ]) : void
getErrorException(array<string|int, mixed> $error) : ErrorException
convertExceptionAsHTMLPage(Throwable $exception, int $code) : string
convertExceptionAsText(Throwable $Exception, int $code) : string
formatSourceAsText(mixed $file, int $activeLineNumber, int $linesBefore, int $linesAfter) : string
getFileLines(mixed $file, int $from, int $to[, int &$count = 0 ][, bool $asArray = false ]) : array<string|int, mixed>|string
Limits the length of a string and append $end.
str_limit(string $string, int $max[, string $end = '...' ]) : string
This function do it cleanly, it tries to cut before a word.
The string to limit length.
The maximum length of the string.
A string to append to the shortened string.
The shortened string.
Do a binary test to check $value is matching $reference
matchBits(int $value, int $reference) : bool
The value to compare.
The reference for the comparison.
True if $value is binary included in $reference. Do a binary test, compare $value with $reference. This function is very useful to do binary comparison for rights and inclusion in a value.
Scans a directory cleanly.
scanFolder(string $dir[, bool $reverseOrder = false ]) : array<string|int, string>
The path to the directory to scan.
True to reverse results order. Default value is False.
An array of the files in this directory.
Stringify any variable
stringify(mixed $s) : string
the input data to stringify
Convert a variable to an HTML-readable string
toHtml(mixed $value) : string
the input data to stringify
Convert a variable a Text-readable string
toString(mixed $value) : string
the input data to stringify
Format the input Exception to a human-readable string
formatException(Throwable $e) : string
Get the debug trace filtered by $filterStartWith
getDebugTrace([string|null $filterStartWith = null ]) : array<string|int, mixed>
Exclude functions starting with this value
The filtered backtrace
Log a report in a file.
log_report(string|Exception $report, string $file[, string|null $action = null ]) : void
Data are serialized to JSON. Each line of the file is a JSON string of the reports. The log folder is the constant LOGS_PATH.
The report to log.
The log file path.
The action associated to the report. Default value is an empty string.
Log a debug
log_debug(string $report[, string|null $action = null ]) : void
Log a debug. The log file is the constant LOGFILE_DEBUG.
The debug report to log.
The action associated to the report. Default value is an empty string.
Log a hack attempt The log file is the constant LOGFILE_HACK or, if undefined, '.hack'.
log_hack(string $report[, string|null $action = null ]) : void
The report to log.
The action associated to the report. Default value is an empty string.
Log a system error The log file is the constant LOGFILE_SYSTEM or, if undefined, '.log_error'.
log_error(string|Throwable $report[, string|null $action = null ]) : void
The report to log.
The action associated to the report. Default value is an empty string.
Log a sql error The log file is the constant LOGFILE_SQL or, if undefined, '.pdo_error'.
sql_error(string|Exception $report[, string|null $action = null ]) : void
The report to log
The action associated to the report. Default value is an empty string
Convert Text to HTML
html(string $text) : string
The string to convert
Format a string to be a html attribute value
htmlAttribute(mixed $value) : string
The variable to format
The escaped string
Get value from an Array Path
array_path_get(array<string|int, mixed> $array, string $path[, mixed $default = null ][, bool $pathRequired = false ]) : mixed
Get value from an Array Path using / as separator. Return null if parameters are invalids, $default if the path is not found else the value. If $default is not null and returned value is null, you can infer your parameters are invalids.
The array to get the value from.
The path used to browse the array.
The default value returned if array is valid but key is not found.
True if the path is required. Default value is False.
The value from $path in $array.
Set value into array using an Array Path with / as separator.
array_path_set(array<string|int, mixed>|null &$array, string $path, mixed $value[, bool $overwrite = true ]) : void
$array The array to get the value from.
The path used to browse the array.
The value to set in array
True to overwrite existing value. Default value is True.
Starts a new report stream, all new reports will be added to this stream.
startReportStream(string $stream) : void
The new report stream name
Ends the current stream by setting current stream to the global one, so you can not end global stream.
endReportStream() : void
Transfers the stream reports to another
transferReportStream([string|null $from = null ][, string $to = 'global' ]) : bool
Transfers $from this stream. Default value is null (current stream).
Transfers $to this stream. Default value is global.
Add a report
addReport(mixed $report, string $type[, string|null $domain = null ][, string|null $code = null ][, int $severity = 0 ]) : bool
Add the report $message to the list of reports for this $type. The type of the message is commonly 'success' or 'error'.
The report (Commonly a string or an UserException).
The type of the message.
The domain to use to automatically translate the message. Default value is 'global'.
The key code to use for this report. Default is $report.
The severity of report. Default value is 0.
False if rejected
Report a success
reportSuccess(mixed $report[, string|null $domain = null ]) : bool
Adds the report $message to the list of reports for this type 'success'.
The message to report.
The domain fo the message. Not used for translation. Default value is global.
False if rejected
Reports an information to the user
reportInfo(mixed $report[, string|null $domain = null ]) : bool
Adds the report $message to the list of reports for this type 'info'.
The message to report.
The domain fo the message. Not used for translation. Default value is global.
False if rejected
Reports a warning
reportWarning(mixed $report[, string|null $domain = null ]) : bool
Adds the report $message to the list of reports for this type 'warning'. Warning come in some special cases, we meet it when we do automatic checks before loading contents and there is something to report to the user.
The message to report.
The domain fo the message. Not used for translation. Default value is the domain of Exception in case of UserException else 'global'.
False if rejected
Reports an error
reportError(mixed $report[, string|null $domain = null ][, int $severity = 1 ]) : bool
The report.
The domain fo the message. Default value is the domain of Exception in case of UserException else 'global'.
The severity of the error, commonly 1 for standard user error and 0 for warning. Default value is 1.
False if rejected
Check if there is error reports
hasErrorReports() : bool
True if there is any error report.
Get some/all reports
getReports([string $stream = 'global' ][, string|null $type = null ][, bool $delete = true ]) : array<string|int, mixed>
Get all reports from the list of $domain optionally filtered by type.
The stream to get the reports. Default value is "global".
Filter results by report type. Default value is null.
True to delete entries from the list. Default value is true.
Get some/all reports as flatten array
getFlatReports([string $stream = 'global' ][, string|null $type = null ][, bool $delete = true ]) : array<string|int, array<string|int, mixed>>
Get all reports from the list of $domain optionally filtered by type.
The stream to get the reports. Default value is "global".
Filter results by report type. Default value is null.
True to delete entries from the list. Default value is true.
Get some/all reports as HTML
formatReportListToHtml([string $stream = 'global' ][, array<string|int, mixed> $rejected = [] ][, bool $delete = true ]) : string
Get all reports from the list of $domain and generates the HTML source to display.
The stream to get the reports. Default value is 'global'.
An array of rejected messages. Default value is an empty array.
True to delete entries from the list. Default value is true.
The renderer HTML.
Get one report as HTML
formatReportToHtml(string $stream, string $report, string $domain, string $type) : string
The stream of the report.
The message to report.
The domain of the report.
The type of the report.
Displays all reports from the list of $domain and displays generated HTML source.
displayReportsHtml([string $stream = 'global' ][, array<string|int, string> $rejected = [] ][, bool $delete = true ]) : void
The stream to display. Default value is 'global'.
An array of rejected messages. Can be the first parameter.
True to delete entries from the list.
Generate the HTML source for options of a select tag For associative arrays, we commonly use the value=>label model (OPT_VALUE2LABEL) but sometimes for associative arrays we could prefer the label=>value model (OPT_LABEL2VALUE).
htmlOptions(string|null $fieldPath, array<string|int, mixed> $values[, null $default = null ][, int|null $matches = null ][, string $prefix = '' ][, string $domain = 'global' ]) : string
You can use your own combination with defined constants OPT_VALUE_IS_VALUE, OPT_VALUE_IS_KEY, OPT_LABEL_IS_VALUE and OPT_LABEL_IS_KEY. Common combinations are OPT_LABEL2VALUE, OPT_VALUE2LABEL and OPT_VALUE. The label is prefixed with $prefix and translated using t(). This function allows bi-dimensional arrays in $values, used as option group.
The name path to the field.
The values to build the dropdown menu.
The default selected value. Default value is null (no selection).
Define the associativity between array and option values. Default value is OPT_VALUE2LABEL (as null).
The prefix to use for the text name of values. Default value is an empty string.
The domain to apply the Key. Default value is 'global'.
An HTML source for the built SELECT tag.
Generate HTML option tag
htmlOption(string $elValue[, string|null $label = null ][, bool $selected = false ][, string $addAttr = '' ]) : string
Generate disabled HTML attribute
htmlDisabledAttr() : string
Generate HTML value attribute
valueField(string $value) : string
The value
Convert a path to an HTML name attribute E.g. user/password => user[password]
array_path_html(string $path) : string
Get post form data
getFormData() : array<string|int, mixed>
isSupportingInputController() : bool
Fill the given data from input form
fillFormData(array<string|int, mixed>|null &$data) : array<string|int, mixed>
The data to fill, as pointer.
The resulting $data.
Fill the given value from input form
fillInputValue(mixed &$value, string $fieldPath[, string|null $default = null ][, bool $pathRequired = false ]) : bool
The value to fill, as pointer.
The array_path to the input form value.
The default value if not found. Default value is null (array_path_get()'s default).
True if the path is required. Default value is False (array_path_get()'s default).
True if got value is not null (found).
Convert special characters to non-special ones Replace all special characters in $string by the non-special version of theses.
convertSpecialChars(string $string) : string
The string to convert
The string wih no special characters
Get the string of a boolean
b(bool $b) : string
The boolean
The boolean's string
Split a string by string in limited values
explodeList(string $delimiter, string $string, int $limit[, mixed $default = null ]) : array<string|int, mixed>
The boundary string
The input string
The limit of values exploded
The default value to use if missing
The exploded array with a defined limit of values.
Hash string with salt
hashString(string $value) : string
Hash input string with salt (constant USER_SALT) using SHA512
Get the date as string
sql2Time(string $datetime) : string
The datetime
The date using 'dateFormat' translation key
Date format is storing a date, not a specific moment, we don't care about timezone
Format the date as string Date format is storing a date, not a specific moment, we don't care about timezone
d([int|DateTime $time = TIME ][, bool $utc = false ]) : string
The UNIX timestamp
Is the time UTC
The date using 'dateFormat' translation key
Format the date time as string Datetime format is storing a specific moment, we care about timezone
dt([int|DateTime $time = TIME ][, bool $utc = false ]) : string
The UNIX timestamp
Is the time UTC
The date using 'datetimeFormat' translation key
Format the date time as string Datetime format is storing a specific moment, we care about timezone
df(string $format[, int|DateTime|null $time = TIME ][, string|false|null $timeZone = null ]) : string
The format to use
The UNIX timestamp
Timezone to use. False for UTC, Null for default or a string to specify the one to use
The date formatted using $format
timeZone(string|DateTimeZone|null $timeZone) : DateTimeZone|null
Convert date to time Allow any format of strtotime() to be converted to time, if time passed, it just returns it.
dateToTime(int|string|DateTime $date) : int
The date or UNIX timestamp
The UNIX timestamp
Create time format regex from date() format
timeFormatToRegex(string $format) : string
Parse time from string to time array
parseTime(string $time[, string $format = SYSTEM_TIME_FORMAT ]) : array<string|int, mixed>
Parsed time
Format to use
Get the date as string in SQL format Date format is storing a date, not a specific moment, we don't care about timezone
sqlDate([int|DateTime|string|null $time = TIME ]) : string
The UNIX timestamp.
The date using sql format
Get the date time as string in SQL format Datetime format is storing a specific moment, we care about timezone
sqlDatetime([int|DateTime|string|null $time = TIME ][, string $format = 'Y-m-d H:i:s' ]) : string
The UNIX timestamp.
The date using sql format
Get the client public IP
clientIp() : string
The ip of the client
Get the id of the current user
userId() : int|string
The user's id
Generate a random string
generateRandomString([int $length = 64 ][, string $keyspace = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ' ]) : string
The length of the output string
A string of all possible characters to select from
Calculate the day timestamp using the given integer Return the timestamp of the current day of $time according to the midnight hour.
dayTime([int|null $time = null ][, bool $gmt = true ]) : int
The time to get the day time. Default value is current timestamp.
Is the time GMT
Add zero to the input number
leadZero(int $number[, int $length = 2 ]) : string
The number
The length to add zero
Format duration to closest unit
formatDuration_Shortest(int $duration) : string
Duration in seconds
Count intersect key in given arrays
count_intersect_keys(array<string|int, mixed> $array1, array<string|int, mixed> $array2) : int
Get the mime type of the given file path
getMimeType(string $filePath) : string
Ensure path availability as folder
checkDir(string $filePath) : bool
Insert $value in $array at $position
array_insert(array<string|int, mixed> &$array, int $position, mixed $value) : void
Add values from an array to another
array_add(array<string|int, mixed> &$array, array<string|int, mixed> $other) : void
Filter $array entries by $keys
array_filter_by_keys(array<string|int, mixed> $array, array<string|int, mixed> $keys) : array<string|int, mixed>
Get the index of $key in $array
array_index(array<string|int, mixed> $array, string|int $key) : int
Get the last value of $array
array_last(array<string|int, mixed> $array) : mixed|false
Get value of $array at $index or $default if not found
array_get(array<string|int, mixed> $array, int $index[, mixed $default = null ]) : mixed
Apply a user supplied function to every member of an array
array_apply(array<string|int, mixed> $array, callable $callback[, mixed $userdata = null ][, string &$success = null ]) : array<string|int, mixed>
The input array.
Typically, callback takes on two parameters. The array parameter's value being the first, and the key/index second.
If the optional userdata parameter is supplied, it will be passed as the third parameter to the callback.
TRUE on success or FALSE on failure.
The resulting array
Concat key and value in an array with a glue
array_peer(array<string|int, string> $array[, string $peerGlue = ': ' ]) : array<string|int, mixed>
Make a string's first-only character uppercase
str_ucfirst(string $value) : string
Uppercase the first-only character of each word in a string
str_ucwords(string $value) : string
Get the first char of a string
str_first(string $value) : string
Get the last char of a string
str_last(string $value) : string
Reverse values
reverse_values(mixed &$val1, mixed &$val2) : void
Check value in between min and max
between(int $value, int $min, int $max) : bool
Delete a HTTP cookie
deleteCookie(string $name) : bool
The name of the cookie to delete
True if cookie was deleted, false if not found
Start a secured PHP Session and initialize Orpheus
startSession([int $type = SESSION_WITH_COOKIE ]) : void
The type flag of the session
Find whether the given variable is a closure
is_closure(mixed $value) : bool
True if $v is a closure
Test the given variable is an exception
is_exception(mixed $exception) : bool
True if $v is an Exception
Get microsecond as UNIX format
ms([int|null $precision = null ]) : string
Convert human size to byte unit Some programs, as of PHP, does not respect binary & decimals unit multiples 100kB = 1.000 bytes / 100KiB = 1.024 bytes In case of PHP ini file, 56MB is for PHP 56 * 1024 * 1024 bytes Source: https://en.wikipedia.org/wiki/Byte#Unit_symbol
parseHumanSize(string $size[, bool $forceBinaryStep = false ]) : int
The human size to parse
For to use binary step even if using decimal unit
The byte size
Convert human size to byte unit You can combine $step and decimal unit as you want Source: https://en.wikipedia.org/wiki/Byte#Unit_symbol
formatHumanSize(string $value[, int $step = 1000 ][, bool $useDecimalUnit = true ][, int $allowMax = 10000 ][, string $format = '%s%s' ]) : string
The byte size to format
The step between units
The unit to use (decimal or binary)
Max value allow in one unit. e.g. with 10.000, you keep a unit until 9.999
The format to use with sprintf(), first string is the value and the second one is the unit.
The formatted size
Check if the input is an email address.
is_email(string $email) : bool
The email address to check.
True if $email si a valid email address.
Check the $variable could be converted into a string
is_string_convertible(mixed $variable) : bool
Check if the input is an ID Number.
is_id(mixed $id) : bool
The number to check
True if $number si a valid integer
The ID number is an integer.
Check if the input is a date.
is_date(string $date[, bool $withTime = false ][, DateTime|null &$dateTime = null ][, int $format = DATE_FORMAT_LOCALE ]) : bool
The date to check.
True to use datetime format, optional. Default value is false.
The output timestamp of the data, optional.
The date format to check, see constants DATE_FORMAT_*
True if $date si a valid date.
The date have to be well formatted and valid. The FR date format is DD/MM/YYYY and time format is HH:MM:SS Allow 01/01/1970, 01/01/1970 12:10:30, 01/01/1970 12:10 Fill missing information with 0.
Check $time is a real time representation.
is_time(string $time[, array<string|int, mixed>|null &$matches = null ]) : bool
Could use global translation "timeFormat" to check this is a time e.g. Basically validate 12:50
Check if the input is an url.
is_url(string $url) : bool
The url to check.
True if $url si a valid url.
Check if the input is an ip address.
is_ip(string $ip[, int $flags = FILTER_DEFAULT ]) : bool
The url to check.
The flags for the check.
True if $ip si a valid ip address.
now() : DateTime
dateTime([mixed $time = null ]) : DateTime
Translate a key
t(string $key[, string|array<string|int, mixed>|null $domain = 'global' ][, array<string|int, mixed> $parameters = [] ]) : string
The Key to translate, prefer to use an internal language (English CamelCase).
The domain to apply the Key. Default value is 'global'.
The values array to replace in text. Could be used as second parameter.
The translated human text.
This function try to translate the given key, in case of failure, it just returns the Key. It tries to replace $values in text by key using #key# format using str_replace() but if $values is a list of values, it uses sprintf(). $values allows 3 formats:
Examples: t('untranslatedString', 'aDomain'), t('My already translated string'), t('untranslatedString', 'global', array('key1'=>'val1')), t('untranslatedString', 'global', 'val1', 60)
Translate a key allowing null value (if not found)
tn(string $key[, string|array<string|int, mixed>|null $domain = 'global' ][, array<string|int, mixed> $parameters = [] ]) : string|null
Display t()
_t(string $key[, string|array<string|int, mixed> $domain = 'global' ][, array<string|int, mixed> $parameters = [] ]) : void
The Key to translate, prefer to use an internal language (English CamelCase).
The domain to apply the Key. Default value is 'global'.
Convert a localized string number into a programming one
parseNumber(string $value) : float
sanitizeNumber(string $value) : float
Format money by currency and using a number formatter
formatCurrency(float $value, string $currency[, bool|int $decimals = true ]) : string
Decimals or true for 2, false for 0
Format a number using locale
formatNumber(int|float $value[, int $decimals = 0 ]) : string
Generate URL to a route
u(string $routeName[, array<string|int, mixed> $values = [] ]) : string
Display URL to a route
_u(string $routeName[, array<string|int, mixed> $values = [] ]) : void
Test if a route exists
exists_route(string $routeName) : bool
Get the link of the current request
get_current_link() : string
getallheaders() : array<string|int, mixed>
Get the id whatever we give to it
id(string|PermanentEntity &$id) : string