\OpenEstate\PhpExportUtils

createAbsoluteUrl()

createAbsoluteUrl(  $relativePart,   $baseUrl) : string

Construct an absolute URL from a base URL and a relative part.

Parameters

Returns

absolute URL

createTranslator()

createTranslator(\OpenEstate\PhpExport\Environment  $env, string|null  $languageCode = null) : \OpenEstate\PhpExport\Translator

Create a translator for a certain language.

Parameters

Returns

translator instance

encode()

encode(string  $input, string  $targetCharset) : string

Convert a string into another charset.

Parameters

Returns

encoded output string

getAbbreviatedString()

getAbbreviatedString(string  $value, integer  $length, boolean  $singleLine = false) : string

Get an abbreviated string.

Parameters

Returns

abbreviated string

getAbsoluteUrl()

getAbsoluteUrl(  $url) : string

Convert a relative URL to an absolute URL.

Parameters

Returns

absolute URL

getAttributeValue()

getAttributeValue(string  $group, string  $attribute, array  $value, string  $lang) : string

Get the value for an attribute.

Parameters

Returns

readable output of the attribute value

getCaptchaHash()

getCaptchaHash(string  $captchaCode, integer  $stamp = null) : string

Generates a secure captcha has value.

Parameters

Returns

captcha hash value

getDefaultFilterObjects()

getDefaultFilterObjects(string  $basePath) : array

Get list of default filter objects.

Parameters

Returns

list of filter objects

getDefaultOrderObjects()

getDefaultOrderObjects(string  $basePath) : array

Get list of default order objects.

Parameters

Returns

list of order objects

getFileStamp()

getFileStamp(string  $file) : integer|null

Returns the timestamp, when a certain file was last modified.

Parameters

Returns

timestamp of last modification or null, if the file is not available

getJson()

getJson(mixed  $obj, boolean  $json = true) : string

Convert a variable to JSON.

Parameters

Returns

JSON string

getMinimizedHtml()

getMinimizedHtml(string  $html) : string

Returns minimized HTML code.

Parameters

Returns

minimized HTML code

getNumberOfPages()

getNumberOfPages(integer  $numberOfObjects, integer  $objectsPerPage) : integer

Returns the number of pages required to show a certain list of objects.

Parameters

Returns

number of pages

getRgbFromHex()

getRgbFromHex(string  $hex) : array

Converts a hexadecimal color code to an RGB array.

Parameters

Returns

associative array with separate RGB integer values or null, if the provided hexadecimal code is invalid

getUrlParameters()

getUrlParameters(array  $parameters) : string

Converts an array of parameters into a URL query string.

Parameters

Returns

URL query string

getUserLanguages()

getUserLanguages() : array

Returns a list of preferred languages by the user's browser.

Returns

list of language codes

isBlankString()

isBlankString(string  $string) : boolean

Tests, if a string value is blank.

Parameters

Returns

true, if the provided value is not a string or it is an empty string or it contains only non-whitespaces

isEmptyArray()

isEmptyArray(array|null  $array) : boolean

Tests, if an array is empty.

Parameters

Returns

true, if the provided value is not an array or it is doesn't contain any elements

isEmptyString()

isEmptyString(string  $string) : boolean

Tests, if a string value is empty.

Parameters

Returns

true, if the provided value is not a string or it is an empty string

isFileOlderThen()

isFileOlderThen(string  $file, integer  $maxLifetime) : boolean

Tests, if a file is older then a certain lifetime.

Parameters

Returns

true, if the file is older then the specified lifetime.

isFileYoungerThen()

isFileYoungerThen(string  $file, integer  $maxLifetime) : boolean

Tests, if a file is younger then a certain lifetime.

Parameters

Returns

true, if the file is younger then the specified lifetime.

isGdExtensionAvailable()

isGdExtensionAvailable() : boolean

Tests, if the GD extension is available in the PHP environment.

Returns

true, if the GD extension is available

isNotBlankString()

isNotBlankString(string  $string) : boolean

Tests, if a string value is not blank.

Parameters

Returns

true, if the provided value is a string and contains at least one non-whitespace character

isNotEmptyArray()

isNotEmptyArray(array|null  $array) : boolean

Tests, if an array is not empty.

Parameters

Returns

true, if the provided value is an array and contains at least one element

isNotEmptyString()

isNotEmptyString(string  $string) : boolean

Tests, if a string value is not empty.

Parameters

Returns

true, if the provided value is a string and contains at least one character

isNotValidCaptcha()

isNotValidCaptcha(string  $captchaCode, string  $captchaHash, integer  $maxAge = 3600) : boolean

Tests, if a captcha code does not match against a captcha hash.

Parameters

Returns

true, if the captcha code matches the hash

isNotValidEmail()

isNotValidEmail(string  $email) : boolean

Tests, if an email address is not valid.

Parameters

Returns

true, if the provided email address is valid

isValidCaptcha()

isValidCaptcha(string  $captchaCode, string  $captchaHash, integer  $maxAge = 1800) : boolean

Tests, if a captcha code matches against a captcha hash.

Parameters

Returns

true, if the captcha code matches the hash

isValidEmail()

isValidEmail(string  $email) : boolean

Tests, if an email address is valid.

Parameters

Returns

true, if the provided email address is valid

joinPath()

joinPath(string  $path, array|null  $children) : string

Join a path with a file or subfolder name.

Parameters

Returns

joined path

listDirectory()

listDirectory(string  $directory) : array

List names of files and sub-folders in a directory.

Parameters

Returns

names of files and sub-folders in the directory

logDeprecated()

logDeprecated(string  $msg) 

Log a deprecation notice.

Parameters

logError()

logError(string  $msg) 

Log an error.

Parameters

logNotice()

logNotice(string  $msg) 

Log a notice.

Parameters

logWarning()

logWarning(string  $msg) 

Log a warning.

Parameters

printErrorException()

printErrorException(\Exception  $exception) 

Print an error exception.

Parameters

printErrorMessage()

printErrorMessage(string  $message) 

Print an error message.

Parameters

readFile()

readFile(string  $file) : string|null

Returns the contents of a file as string.

Parameters

Returns

file contents or null, if the file is not loadable

replaceLinks()

replaceLinks(string  $text) : string

Replace URL's in a text with HTML links.

Parameters

Returns

HTML code of the text with replaced links

writeBytes()

writeBytes(integer  $bytes) : string

Write number of bytes in readable form.

Parameters

Returns

readable number of bytes

writeObjectField()

writeObjectField(array  $object, string  $field, array  $i18n, string  $lang, boolean  $valueOnly = false) : null|string

Write a certain object attribute.

Parameters

Returns

HTML encoded output for the requested field

writeStatistics()

writeStatistics(integer  $buildTime) : string

Write statistics.

Parameters

Returns

HTML code with statistics

log()

log(string|\Throwable  $msg, integer  $type) 

Send a PHP log message.

Parameters