• Home
• Craft
• MinimeeService

PHP Class Craft\MinimeeService

Datei anzeigen Open project: johndwells/craft.minimee

Protected Properties

Property	Type	Description
$_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

Public Methods

Method	Description
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

Protected Methods

Method	Description
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.

Method Details

Property Details