PHP Класс Craft\MinimeeService

Наследование: extends craft\BaseApplicationComponent
Показать файл Открыть проект

Защищенные свойства (Protected)

Свойство Тип Описание
$_assets the trigger we use for our own resources
$_cacheBase css or js
$_cacheTimestamp a concat of all asset filenames together
$_deprecatedSettingsMap static array of settings, a merge of DB and filesystem settings
$_pluginSettings instance of Minimee_SettingsModel
$_settings max timestamp of all assets
$_type array of Minimee_AssetModelInterface

Открытые методы

Метод Описание
deleteExpiredCache ( ) : void Based on the cache's hashed base, attempts to delete any older versions of same name.
init ( ) : void During startup, fetch settings from our plugin / config
makePathToStorageFolder ( ) : String
makeTagsByType ( String $type, Array $assets = [] ) : String Generate the HTML tag based on type
makeTwigMarkupFromHtml ( $html ) : Twig_Markup Wrapper for how we must return a twig option rather than raw HTML
run ( String $type, Array $assets, Array $settings = [] ) : Array | Bool Main service function that encapsulates an entire Minimee run

Защищенные методы

Метод Описание
abort ( String $e, String $level = LogLevel::Error ) : Bool Internal function used when aborting due to error
appendToCacheBase ( String $name ) : Void Append an asset's name to the cacheBase
cacheExists ( ) : Bool Checks if the cache exists.
checkHeaders ( ) : this Validate all assets prior to run.
createCache ( ) : boolean Creates cache of assets.
ensureCacheExists ( ) : MinimeeService Fetch or creates cache.
flightcheck ( ) : this Perform pre-flight checks to ensure we can run.
getAssets ( ) : Array
getCacheBase ( ) : string
getCacheTimestamp ( ) : String
getPluginSettings ( ) : Array get our plugin / config settings
getSettings ( ) : Minimee_SettingsModel
getType ( ) : String
initPluginSettings ( ) : Void Fetch settings from our plugin / config
isCombineEnabled ( ) : boolean | null Return whether we should combine our cache or not
isUrl ( $string ) : boolean Determine if string is valid URL
makeCacheFilename ( ) : String Returns a complete cache filename.
makeHashOfCacheBase ( ) : String
makePathToCacheFilename ( ) : String
makePathToHashOfCacheBase ( ) : String
makeReturn ( ) : String
makeUrlToCacheFilename ( ) : String
minifyAsset ( Minimee_BaseAssetModel $asset ) : String Given an asset, fetches and returns minified contents.
minifyCssAsset ( Minimee_BaseAssetModel $asset ) : String Method to (maybe) minify CSS asset
minifyJsAsset ( Minimee_BaseAssetModel $asset ) : String Method to (maybe) minify JS asset
onCreateCache ( $event ) : Void Raise our 'onCreateCache' event
reset ( ) : this Safely resets service to prepare for a clean run.
setAssets ( Array $assets ) : this
setCacheBase ( String $name ) : MinimeeService
setCacheTimestamp ( String $timestamp ) : MinimeeService
setMaxCacheTimestamp ( craft\DateTime $lastTimeModified ) : MinimeeService
setPluginSettings ( $settings = [] ) : Void set plugin / config settings
setRuntimeSettings ( Array $settingsOverrides ) : MinimeeService Configure our service based off the settings in plugin, allowing plugin settings to be overridden at runtime.
setSettings ( craft\Minimee_ISettingsModel $settings ) : MinimeeService Manually pass in an instance of Minimee_ISettingsModel.
setType ( String $type ) : this
supportLegacyNamesAtRuntime ( Array $runtimeSettings = [] ) : Array Handle backwards-compat for 'cssTagTemplate' and 'jsTagTemplate' setting names.
supportLegacyNamesFromConfig ( Array $settings = [] ) : Array Handle backwards-compat for 'cssTagTemplate' and 'jsTagTemplate' setting names.

Описание методов

abort() защищенный Метод

Internal function used when aborting due to error
protected abort ( String $e, String $level = LogLevel::Error ) : Bool
$e String
$level String
Результат Bool

appendToCacheBase() защищенный Метод

Append an asset's name to the cacheBase
protected appendToCacheBase ( String $name ) : Void
$name String
Результат Void

cacheExists() защищенный Метод

Checks if the cache exists.
protected cacheExists ( ) : Bool
Результат Bool

checkHeaders() защищенный Метод

Validate all assets prior to run.
protected checkHeaders ( ) : this
Результат this

createCache() защищенный Метод

Creates cache of assets.
protected createCache ( ) : boolean
Результат boolean

deleteExpiredCache() публичный Метод

Based on the cache's hashed base, attempts to delete any older versions of same name.
public deleteExpiredCache ( ) : void
Результат void

ensureCacheExists() защищенный Метод

Fetch or creates cache.
protected ensureCacheExists ( ) : MinimeeService
Результат MinimeeService

flightcheck() защищенный Метод

Perform pre-flight checks to ensure we can run.
protected flightcheck ( ) : this
Результат this

getAssets() защищенный Метод

protected getAssets ( ) : Array
Результат Array

getCacheBase() защищенный Метод

protected getCacheBase ( ) : string
Результат string

getCacheTimestamp() защищенный Метод

protected getCacheTimestamp ( ) : String
Результат String

getPluginSettings() защищенный Метод

get our plugin / config settings
protected getPluginSettings ( ) : Array
Результат Array

getSettings() защищенный Метод

protected getSettings ( ) : Minimee_SettingsModel
Результат Minimee_SettingsModel

getType() защищенный Метод

protected getType ( ) : String
Результат String

init() публичный Метод

During startup, fetch settings from our plugin / config
public init ( ) : void
Результат void

initPluginSettings() защищенный Метод

Fetch settings from our plugin / config
protected initPluginSettings ( ) : Void
Результат Void

isCombineEnabled() защищенный Метод

Return whether we should combine our cache or not
protected isCombineEnabled ( ) : boolean | null
Результат boolean | null

isUrl() защищенный Метод

Determine if string is valid URL
protected isUrl ( $string ) : boolean
Результат boolean TRUE if yes, FALSE if no

makeCacheFilename() защищенный Метод

If a "Resource" cache, format is: hashOfCacheBase.type e.g. asdf1234.css Otherwise, format is: hashOfCacheBase.timestamp.type e.g. asdf1234.12345678.css
protected makeCacheFilename ( ) : String
Результат String

makeHashOfCacheBase() защищенный Метод

protected makeHashOfCacheBase ( ) : String
Результат String

makePathToCacheFilename() защищенный Метод

protected makePathToCacheFilename ( ) : String
Результат String

makePathToHashOfCacheBase() защищенный Метод

protected makePathToHashOfCacheBase ( ) : String
Результат String

makePathToStorageFolder() публичный Метод

public makePathToStorageFolder ( ) : String
Результат String

makeReturn() защищенный Метод

protected makeReturn ( ) : String
Результат String

makeTagsByType() публичный Метод

Generate the HTML tag based on type
public makeTagsByType ( String $type, Array $assets = [] ) : String
$type String
$assets Array
Результат String

makeTwigMarkupFromHtml() публичный Метод

Wrapper for how we must return a twig option rather than raw HTML
public makeTwigMarkupFromHtml ( $html ) : Twig_Markup
Результат Twig_Markup

makeUrlToCacheFilename() защищенный Метод

protected makeUrlToCacheFilename ( ) : String
Результат String

minifyAsset() защищенный Метод

Given an asset, fetches and returns minified contents.
protected minifyAsset ( Minimee_BaseAssetModel $asset ) : String
$asset Minimee_BaseAssetModel
Результат String

minifyCssAsset() защищенный Метод

Method to (maybe) minify CSS asset
protected minifyCssAsset ( Minimee_BaseAssetModel $asset ) : String
$asset Minimee_BaseAssetModel
Результат String

minifyJsAsset() защищенный Метод

Method to (maybe) minify JS asset
protected minifyJsAsset ( Minimee_BaseAssetModel $asset ) : String
$asset Minimee_BaseAssetModel
Результат String

onCreateCache() защищенный Метод

Raise our 'onCreateCache' event
protected onCreateCache ( $event ) : Void
Результат Void

reset() защищенный Метод

Safely resets service to prepare for a clean run.
protected reset ( ) : this
Результат this

run() публичный Метод

Main service function that encapsulates an entire Minimee run
public run ( String $type, Array $assets, Array $settings = [] ) : Array | Bool
$type String
$assets Array
$settings Array
Результат Array | Bool

setAssets() защищенный Метод

protected setAssets ( Array $assets ) : this
$assets Array
Результат this

setCacheBase() защищенный Метод

protected setCacheBase ( String $name ) : MinimeeService
$name String
Результат MinimeeService

setCacheTimestamp() защищенный Метод

protected setCacheTimestamp ( String $timestamp ) : MinimeeService
$timestamp String
Результат MinimeeService

setMaxCacheTimestamp() защищенный Метод

protected setMaxCacheTimestamp ( craft\DateTime $lastTimeModified ) : MinimeeService
$lastTimeModified craft\DateTime
Результат MinimeeService

setPluginSettings() защищенный Метод

set plugin / config settings
protected setPluginSettings ( $settings = [] ) : Void
Результат Void

setRuntimeSettings() защищенный Метод

Configure our service based off the settings in plugin, allowing plugin settings to be overridden at runtime.
protected setRuntimeSettings ( Array $settingsOverrides ) : MinimeeService
$settingsOverrides Array
Результат MinimeeService

setSettings() защищенный Метод

Manually pass in an instance of Minimee_ISettingsModel.
protected setSettings ( craft\Minimee_ISettingsModel $settings ) : MinimeeService
$settings craft\Minimee_ISettingsModel
Результат MinimeeService

setType() защищенный Метод

protected setType ( String $type ) : this
$type String
Результат this

supportLegacyNamesAtRuntime() защищенный Метод

Remove in 1.x release!
protected supportLegacyNamesAtRuntime ( Array $runtimeSettings = [] ) : Array
$runtimeSettings Array
Результат Array

supportLegacyNamesFromConfig() защищенный Метод

Remove in 1.x release!
protected supportLegacyNamesFromConfig ( Array $settings = [] ) : Array
$settings Array
Результат Array

Описание свойств

$_assets защищенное свойство

the trigger we use for our own resources
protected $_assets

$_cacheBase защищенное свойство

css or js
protected $_cacheBase

$_cacheTimestamp защищенное свойство

a concat of all asset filenames together
protected $_cacheTimestamp

$_deprecatedSettingsMap защищенное свойство

static array of settings, a merge of DB and filesystem settings
protected $_deprecatedSettingsMap

$_pluginSettings защищенное статическое свойство

instance of Minimee_SettingsModel
protected static $_pluginSettings

$_settings защищенное свойство

max timestamp of all assets
protected $_settings

$_type защищенное свойство

array of Minimee_AssetModelInterface
protected $_type