PHP Class Craft\EmbeddedAssetsPlugin

Thank you for using Craft Embedded Assets!
See also: https://github.com/benjamminf/craft-embedded-assets
Inheritance: extends craft\BasePlugin
Afficher le fichier Open project: benjamminf/craft-embedded-assets

Méthodes publiques

Méthode Description
defineAdditionalAssetTableAttributes ( ) : array Hook for adding additional table attributes to the Assets manager.
getAssetTableAttributeHtml ( $element, $attribute ) : null | string Hook for formatting the HTML for embedded asset attributes in the Assets manager.
getCacheKey ( ) : string
getCraftMinimumVersion ( )
getDescription ( )
getDeveloper ( )
getDeveloperUrl ( )
getDocumentationUrl ( )
getFileNamePrefix ( ) : mixed Shorthand for getting the file name prefix setting.
getName ( )
getPHPMinimumVersion ( )
getParameters ( ) : mixed Shorthand for getting the parameters setting.
getReleaseFeedUrl ( )
getSchemaVersion ( )
getSettingsHtml ( ) : mixed Renders the plugin's settings page.
getVersion ( )
getWhitelist ( ) : mixed Shorthand for getting the whitelist setting.
init ( ) Initialise the plugin by loading dependencies and resources.
isCompatible ( ) : boolean Returns if the plugin is compatible with the current system stack.
isCraftRequiredVersion ( ) : boolean Defines the earliest version of Craft that this plugin is compatible with.
isPHPRequiredVersion ( ) : boolean Defines the earliest version of PHP that this plugin is compatible with.
loadDependencies ( ) Loads all dependencies for this plugin.
onBeforeInstall ( ) : boolean Checks if the plugin is compatible before installation.
prepSettings ( array $postSettings ) : array Formats values from the CP settings form to be saved into the DB.

Méthodes protégées

Méthode Description
defineSettings ( ) : array The default settings for the plugin.
includeResources ( ) Loads all CSS and JS resources for the plugin.

Private Methods

Méthode Description
_getThumbnails ( ) : array Returns an array of all embedded assets thumbnails, indexed by the asset file models ID.

Method Details

defineAdditionalAssetTableAttributes() public méthode

Adds a provider attribute for embedded assets to display their providers.
public defineAdditionalAssetTableAttributes ( ) : array
Résultat array

defineSettings() protected méthode

The default settings for the plugin.
protected defineSettings ( ) : array
Résultat array

getAssetTableAttributeHtml() public méthode

Hook for formatting the HTML for embedded asset attributes in the Assets manager.
public getAssetTableAttributeHtml ( $element, $attribute ) : null | string
$element
$attribute
Résultat null | string

getCacheKey() public static méthode

public static getCacheKey ( ) : string
Résultat string

getCraftMinimumVersion() public méthode

public getCraftMinimumVersion ( )

getDescription() public méthode

public getDescription ( )

getDeveloper() public méthode

public getDeveloper ( )

getDeveloperUrl() public méthode

public getDeveloperUrl ( )

getDocumentationUrl() public méthode

public getDocumentationUrl ( )

getFileNamePrefix() public static méthode

Shorthand for getting the file name prefix setting.
public static getFileNamePrefix ( ) : mixed
Résultat mixed

getName() public méthode

public getName ( )

getPHPMinimumVersion() public méthode

public getPHPMinimumVersion ( )

getParameters() public static méthode

Shorthand for getting the parameters setting.
public static getParameters ( ) : mixed
Résultat mixed

getReleaseFeedUrl() public méthode

public getReleaseFeedUrl ( )

getSchemaVersion() public méthode

public getSchemaVersion ( )

getSettingsHtml() public méthode

Renders the plugin's settings page.
public getSettingsHtml ( ) : mixed
Résultat mixed

getVersion() public méthode

public getVersion ( )

getWhitelist() public static méthode

Shorthand for getting the whitelist setting.
public static getWhitelist ( ) : mixed
Résultat mixed

includeResources() protected méthode

Loads all CSS and JS resources for the plugin.
protected includeResources ( )

init() public méthode

Initialise the plugin by loading dependencies and resources.
public init ( )

isCompatible() public méthode

Returns if the plugin is compatible with the current system stack.
public isCompatible ( ) : boolean
Résultat boolean

isCraftRequiredVersion() public méthode

Defines the earliest version of Craft that this plugin is compatible with.
public isCraftRequiredVersion ( ) : boolean
Résultat boolean - Whether the current installed version of Craft is compatible

isPHPRequiredVersion() public méthode

Defines the earliest version of PHP that this plugin is compatible with.
public isPHPRequiredVersion ( ) : boolean
Résultat boolean - Whether the current version of PHP is compatible

loadDependencies() public static méthode

The plugin currently depends on the Essence library.
See also: https://github.com/essence/essence
public static loadDependencies ( )

onBeforeInstall() public méthode

Checks if the plugin is compatible before installation.
public onBeforeInstall ( ) : boolean
Résultat boolean

prepSettings() public méthode

Formats values from the CP settings form to be saved into the DB.
public prepSettings ( array $postSettings ) : array
$postSettings array
Résultat array