Class AuxLib

Standalone class with miscellaneous utility functions

Located at x2engine/protected/components/util/AuxLib.php

Methods summary
`public static`	# `getFileUploadErrorMessage( integer $errCode )` Parameters `$errCode` `integer` $errCode php file upload error code
`public static boolean`	# `checkFileUploadError( mixed $name )` Returns `boolean` True if the file upload failed with errors, false otherwise
`public static`	# `registerTranslationsScript( string $namespace, array $messages, string $translationFile = 'app', string $scriptName = 'passMsgsToClientScript' )` Registers a script which instantiates a dictionary of translations. Registers a script which instantiates a dictionary of translations. Parameters `$namespace` `string` $scriptName The name of the script which will be registered and which will be a property of the global JS object x2. `$messages` `array` $messages An associateive array (<message label> => <untranslated message>) `$translationFile` `string` $translationFile The first parameter to Yii::t `$scriptName` `string` $namespace The name of the JS object which will contain the translations dictiory
`public static`	# `registerPassVarsToClientScriptScript( string $namespace, array $vars, string $scriptName = 'passVarsToClientScript' )` Parameters `$namespace` `string` $namespace The name of the JS object which will contain the translations dictionary. For nested namespaces, each namespace should be separated by a '.' character. `$vars` `array` $vars An associative array ( `=> )` `$scriptName` `string` $scriptName The name of the script which will be registered and which will be a property of the global JS object x2.
`public static`	# `printTestError( mixed $message )` Used by actions to return JSON encoded array containing error status and error message. Used for testing purposes only. Used by actions to return JSON encoded array containing error status and error message. Used for testing purposes only.
`public static`	# `printError( mixed $message )` Used by actions to return JSON encoded array containing error status and error message. Used by actions to return JSON encoded array containing error status and error message.
`public static`	# `printSuccess( mixed $message )` Used by actions to return JSON encoded array containing success status and success message. Used by actions to return JSON encoded array containing success status and success message.
`public static array`	# `ajaxReturn( boolean $success, string $successMessage, string $errorMessage )` Calls printError or printSuccess depending on the value of $success. Calls printError or printSuccess depending on the value of $success. Parameters `$success` `boolean` $success `$successMessage` `string` $successMessage `$errorMessage` `string` $errorMessage Returns `array` (<bool>, <string>)
`public static`	# `debugLog( mixed $message )` Used to log debug messages Used to log debug messages
`public static`	# `debugLogR( mixed $arr )`
`public static`	# `debugLogHd( mixed $data )` Render a hex dump to the debug log Adapted from: https://stackoverflow.com/a/4225813 Render a hex dump to the debug log Adapted from: https://stackoverflow.com/a/4225813
`public static`	# `logR( mixed $arr, mixed $route )` Generic version of debugLogR Generic version of debugLogR
`public static`	# `debugLogExport( mixed $arr )`
`public static`	# `isIE8( )`
`public static`	# `isIE( )`
`public static`	# `isAndroid( )`
`public static`	# `isIPad( )`
`public static`	# `getLayoutType( )`
`public static mixed`	# `getIEVer( )` Returns `mixed` The IE version if available, otherwise infinity
`public static`	# `setCookie( mixed $key, mixed $val, mixed $time )`
`public static`	# `clearCookie( mixed $key )`
`public static array`	# `bindArray( array $arr, string $prefix = 'X2' )` Generates parameter binding placeholders for each element in array Generates parameter binding placeholders for each element in array Parameters `$arr` `array` $arr parameter values to be bound in a SQL query `$prefix` `string` $prefix prefix to use for paramater names Returns `array` parameter values indexed by parameter name
`public static`	# `arrToStrList( mixed $arr )`
`public static`	# `trace( integer $limit = null )` Prints stack trace Prints stack trace Parameters `$limit` `integer` $limit If set, only the top $limit items on the call stack will get printed. debug_backtrace does have an optional limit argument, but it wasn't introduced until php 5.4.0.
`public static array`	# `dropdownForJson( array $options )` Reformats and translates dropdown arrays to preserve sorting in CJSON::encode() Reformats and translates dropdown arrays to preserve sorting in CJSON::encode() Parameters `$options` `array` an associative array of dropdown options ($value => $label) Returns `array` a 2-D array of values and labels
`public static`	# `println( mixed $message )`
`public static`	# `issetIsArray( mixed $param )`
`public static`	# `captureOutput( mixed $fn )`
`public static`	# `isMac( )`
`public static`	# `isAjax( )`
`public static`	# `getRequestUrl( )`

Packages

Classes

Interfaces

Exceptions

Functions

Class AuxLib

Parameters

Returns

Parameters

Parameters

Parameters

Returns

Returns

Parameters

Returns

Parameters

Parameters

Returns