Class Assets

MvcCore\Ext\Views\Helpers\AbstractHelper implements MvcCore\Ext\Views\Helpers\IHelper

MvcCore\Ext\Views\Helpers\Assets

Direct known subclasses

MvcCore\Ext\Views\Helpers\CssHelper, MvcCore\Ext\Views\Helpers\JsHelper

Namespace: MvcCore\Ext\Views\Helpers
Located at ext-view-helper-assets/src/MvcCore/Ext/Views/Helpers/Assets.php

Methods summary
`public MvcCore\Ext\Views\Helpers\AbstractHelper`	# `SetView( MvcCore\IView $view )` Insert a \MvcCore\View in each helper constructing Insert a \MvcCore\View in each helper constructing Parameters `$view` Returns `MvcCore\Ext\Views\Helpers\AbstractHelper` Overrides `MvcCore\Ext\Views\Helpers\AbstractHelper::SetView()`
`public static`	# `SetGlobalOptions( array $options = [] )` Set global static options about minifying and joining together which can bee overwritten by single settings throw calling for example: append() method as another param. Set global static options about minifying and joining together which can bee overwritten by single settings throw calling for example: append() method as another param. Parameters `$options` whether or not to auto escape output See \MvcCore\Ext\Views\Helpers\Assets::$globalOptions
`public static`	# `SetAssetUrlCompletion( boolean $enable = TRUE )` Strictly enable/disable assets URL completing in form '?controller=controller&action=asset&path=...'. Use this method only for cases, when you want to pack your application and you want to have all URL addresses to css/js/fonts and images directly to hard drive. Strictly enable/disable assets URL completing in form '?controller=controller&action=asset&path=...'. Use this method only for cases, when you want to pack your application and you want to have all URL addresses to css/js/fonts and images directly to hard drive. Parameters `$enable`
`public static`	# `SetBasePath( string $basePath )` Set global static $basePath to load assets from any static CDN domain or any other place. Set global static $basePath to load assets from any static CDN domain or any other place. Parameters `$basePath`
`protected static string`	# `getFileImprint( string $fullPath )` Returns file modification imprint by global settings - by `md5_file()` or by `filemtime()` - always as a string Returns file modification imprint by global settings - by `md5_file()` or by `filemtime()` - always as a string Parameters `$fullPath` Returns string
`public string`	# `__toString( )` Render assets group. Render assets group. Returns string
`public string`	# `AssetUrl( string $path = '' )` Completes font or image file URL inside CSS/JS file content. Completes font or image file URL inside CSS/JS file content. If application compile mode is in development state or packed in strict HDD mode, there is generated standard URL with \MvcCore\Request::$BasePath (current app location) plus called $path param. Because those application compile modes presume by default, that those files are placed beside php code on hard drive. If application compile mode is in php preserve package, php preserve HDD, php strict package or in single file URL mode, there is generated URL by \MvcCore in form: '?controller=controller&action=asset&path=...'. Feel free to change this css/js file URL completion to any custom way. There could be typically only: "$result = self::$basePath . $path;", but if you want to complete URL for assets on hard drive or to any other CDN place, use \MvcCore\Ext\Views\Helpers\Assets::SetBasePath($cdnBasePath); Parameters `$path` relative path from application document root with slash in begin Returns string
`public string`	# `CssJsFileUrl( string $path = '' )` Completes CSS or JS file url. Completes CSS or JS file url. If application compile mode is in development state or packed in strict HDD mode, there is generated standard URL with \MvcCore\Request->GetBasePath() (current app location) plus called $path param. Because those application compile modes presume by default, that those files are placed beside php code on hard drive. If application compile mode is in php preserve package, php preserve HDD, php strict package or in single file URL mode, there is generated URL by \MvcCore in form: 'index.php?controller=controller&action=asset&path=...'. Feel free to change this css/js file URL completion to any custom way. There could be typically only: "$result = self::$basePath . $path;", but if you want to complete URL for assets on hard drive or to any other CDN place, use \MvcCore\Ext\Views\Helpers\Assets::SetBasePath($cdnBasePath); Parameters `$path` relative path from application document root with slash in begin Returns string
`protected string`	# `getCtrlActionKey( )` Get request params controller/action combination string Get request params controller/action combination string Returns string
`protected array[]`	# `filterItemsForNotPossibleMinifiedAndPossibleMinifiedItems( array $items )` Look for every item to render if there is any 'doNotMinify' record to render item separately Look for every item to render if there is any 'doNotMinify' record to render item separately Parameters `$items` Returns array[] $itemsToRenderMinimized $itemsToRenderSeparately
`protected string`	# `addFileModificationImprintToHrefUrl( string $url, string $path )` Add to href URL file modification param by original file Add to href URL file modification param by original file Parameters `$url` `$path` Returns string
`protected string`	# `getIndentString( string\|integer $indent = 0 )` Get indent string Get indent string Parameters `$indent` Returns string
`protected string`	# `getAppRoot( )` Return and store application document root from controller view request object Return and store application document root from controller view request object Returns string
`protected string`	# `getTmpDir( )` Return and store application document root from controller view request object Return and store application document root from controller view request object Returns string Throws Exception
`protected`	# `saveFileContent( string $fullPath = '', string & $fileContent = '' )` Save atomically file content in full path by 1 MB to not overflow any memory limits Save atomically file content in full path by 1 MB to not overflow any memory limits Parameters `$fullPath` `$fileContent`
`protected`	# `log( string $msg = '', string $logType = 'debug' )` Log any render messages with optional log file name Log any render messages with optional log file name Parameters `$msg` `$logType`
`protected`	# `exception( string $msg )` Throw exception with given message with actual helper class name before Throw exception with given message with actual helper class name before Parameters `$msg` Throws Exception text by given message
`protected`	# `warning( string $msg )` Throw exception with given message with actual helper class name before Throw exception with given message with actual helper class name before Parameters `$msg`
`protected`	# `exceptionHandler( Throwable $e )` Render given exception Render given exception Parameters `$e`
`protected string`	# `getTmpFileFullPathByPartFilesInfo( array $filesGroupInfo = [], boolean $minify = FALSE, $extension = '' )` Complete items group tmp directory file name by group source files info Complete items group tmp directory file name by group source files info Parameters `$filesGroupInfo` `$minify` `$extension` Returns string

Methods inherited from MvcCore\Ext\Views\Helpers\AbstractHelper
`GetInstance()`

Magic methods summary
`public MvcCore\Ext\Views\Helpers\Assets`	# `GetInstance( )` Returns `MvcCore\Ext\Views\Helpers\Assets` Overrides `MvcCore\Ext\Views\Helpers\AbstractHelper::GetInstance()`

Constants summary
`string`	`GROUP_NAME_DEFAULT` Default link group name Default link group name Const string	# `'default'`
`string`	`FILE_MODIFICATION_DATE_FORMAT` Date format for ?_fmd param timestamp in admin development mode Date format for ?_fmd param timestamp in admin development mode Const string	# `'Y-m-d_H-i-s'`

Constants inherited from MvcCore\Ext\Views\Helpers\AbstractHelper
`VERSION`

Properties summary
`protected MvcCore\View`	`$view` Simple app view object Simple app view object	#
`protected string`	`$actualGroupName` Called $_linksGroupContainer index throw helper function Css() or Js() Called $_linksGroupContainer index throw helper function Css() or Js()	# `''`
`protected string`	`$streamWrapper` Stream wrapper for actual file save operations (http://php.net/stream_wrapper_register) Stream wrapper for actual file save operations (http://php.net/stream_wrapper_register)	# `''`
`protected static array`	`$globalOptions` Global options about joining and minifying which can bee overwritten by single settings throw calling for example: append() method as another param. All possible options and meanings: - jsJoin - boolean - join JS files in JS group together into single file in tmp dir - jsMinify - boolean - minify JS file in any group by default (it's possible to override for each file) - cssJoin - boolean - join CSS files in CSS group together into single file in tmp dir - cssMinify - boolean - minify CSS file in any group by default (it's possible to override for each file) - tmpDir - string - relative path to temporary dir from application document root, by default: '/Var/Tmp' - fileChecking - string - php function names: md5_file \| filemtime (filemtime is not working for PHAR packages, for PHAR packages use slower 'md5_file' value) - assetsUrl - boolean - strictly enable or disable special packge assets URL completion in form: '?controller=controller&action=asset&path=...', by default, this switch is automatically detected by application compile mode. In every compile mode except development mode and strict HDD mode is this switch configured internally to true. Global options about joining and minifying which can bee overwritten by single settings throw calling for example: append() method as another param. All possible options and meanings: - jsJoin - boolean - join JS files in JS group together into single file in tmp dir - jsMinify - boolean - minify JS file in any group by default (it's possible to override for each file) - cssJoin - boolean - join CSS files in CSS group together into single file in tmp dir - cssMinify - boolean - minify CSS file in any group by default (it's possible to override for each file) - tmpDir - string - relative path to temporary dir from application document root, by default: '/Var/Tmp' - fileChecking - string - php function names: md5_file \| filemtime (filemtime is not working for PHAR packages, for PHAR packages use slower 'md5_file' value) - assetsUrl - boolean - strictly enable or disable special packge assets URL completion in form: '?controller=controller&action=asset&path=...', by default, this switch is automatically detected by application compile mode. In every compile mode except development mode and strict HDD mode is this switch configured internally to true.	# `[ 'jsJoin' => 0, 'jsMinify' => 0, 'cssJoin' => 0, 'cssMinify' => 0, 'tmpDir' => '/Var/Tmp', 'fileChecking' => 'filemtime', 'assetsUrl' => NULL, ]`
`protected static string`	`$appRoot` Application root directory from request object Application root directory from request object	# `NULL`
`protected static string`	`$tmpDir` Relative path to store joined and minified files from application root directory. Relative path to store joined and minified files from application root directory.	# `NULL`
`protected static string`	`$basePath` Base not compiled URL path from localhost if necessary Base not compiled URL path from localhost if necessary	# `NULL`
`protected static string`	`$scriptName` Request script name. Request script name.	# `NULL`
`protected static boolean`	`$loggingAndExceptions` If true, all messages are logged on hard drive, all exceptions are thrown. If true, all messages are logged on hard drive, all exceptions are thrown.	# `TRUE`
`protected static boolean`	`$fileChecking` If true, all assets sources existences are checked If true, all assets sources existences are checked	# `FALSE`
`protected static boolean`	`$fileRendering` If true, all temporary files are rendered If true, all temporary files are rendered	# `FALSE`
`protected static boolean`	`$assetsUrlCompletion` If true, method AssetUrl in all css files returns to: 'index.php?controller=controller&action=asset&path=...'. If true, method AssetUrl in all css files returns to: 'index.php?controller=controller&action=asset&path=...'.	# `NULL`
`protected static string`	`$systemConfigHash` Hash completed as md5(json_encode()) from self::$globalOptions Hash completed as md5(json_encode()) from self::$globalOptions	# `''`
`protected static string`	`$ctrlActionKey`	# `''`

Properties inherited from MvcCore\Ext\Views\Helpers\AbstractHelper
`$controller, $instance, $request, $response`

Classes

Interfaces

Traits

Exceptions

Functions

Class Assets

Direct known subclasses

Parameters

Returns

Overrides

Parameters

See

Parameters

Parameters

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Throws

Parameters

Parameters

Parameters

Throws

Parameters

Parameters

Parameters

Returns

Returns

Overrides

Const

Const