Overview

Namespaces

  • MvcCore
    • Ext
      • Auth
        • Virtual
      • Debug
        • Tracy
      • Form
        • Core
        • Validators
      • Request
      • Router
        • Lang
      • View
        • Helpers
  • None

Classes

  • Assets
  • Css
  • Js
  • LineBreaks
  • Overview
  • Namespace
  • Class
  • Tree

Class Assets

Direct known subclasses

MvcCore\Ext\View\Helpers\Css, MvcCore\Ext\View\Helpers\Js
Namespace: MvcCore\Ext\View\Helpers
Located at ext-view-helper-assets/src/MvcCore/Ext/View/Helpers/Assets.php
Methods summary
public
# __construct( MvcCore\View $view )

Insert a \MvcCore\View in each helper constructing

Insert a \MvcCore\View in each helper constructing

Parameters

$view
public static
# SetGlobalOptions( array $options = array() )

Set global static options about minifying and joining together which can bee overwrited by single settings throw calling for example: append() method as another param.

Set global static options about minifying and joining together which can bee overwrited by single settings throw calling for example: append() method as another param.

Parameters

$options
whether or not to auto escape output

See

\MvcCore\Ext\View\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 adresses 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 adresses 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\View\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->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: '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\View\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 atomicly file content in full path by 1 MB to not overflow any memory limits

Save atomicly 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( Exception $e )

Render given exception

Render given exception

Parameters

$e
protected string
# getTmpFileFullPathByPartFilesInfo( array $filesGroupInfo = array(), 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
Constants summary
string VERSION

MvcCore Extension - View Helper - Assets - version: Comparation by PHP function version_compare();

MvcCore Extension - View Helper - Assets - version: Comparation by PHP function version_compare();

See

http://php.net/manual/en/function.version-compare.php
# '4.2.0'
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'
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 overwrited by single settings throw calling for eeample: 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 automaticly detected by application comple mode. In every compile mode except development mode and strict hdd mode is this switch configured internaly to true.

Global options about joining and minifying which can bee overwrited by single settings throw calling for eeample: 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 automaticly detected by application comple mode. In every compile mode except development mode and strict hdd mode is this switch configured internaly to true.
# array( '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
# ''
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.
# ''
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 boolean $logingAndExceptions

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
# ''
MvcCore API documentation generated by ApiGen