PHP Класс Craft\EmbeddedAssetsPlugin

Thank you for using Craft Embedded Assets!
См. также: https://github.com/benjamminf/craft-embedded-assets
Наследование: extends craft\BasePlugin
Показать файл Открыть проект

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

Метод Описание
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.

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

Метод Описание
defineSettings ( ) : array The default settings for the plugin.
includeResources ( ) Loads all CSS and JS resources for the plugin.

Приватные методы

Метод Описание
_getThumbnails ( ) : array Returns an array of all embedded assets thumbnails, indexed by the asset file models ID.

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

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

Adds a provider attribute for embedded assets to display their providers.
public defineAdditionalAssetTableAttributes ( ) : array
Результат array

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

The default settings for the plugin.
protected defineSettings ( ) : array
Результат array

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

Hook for formatting the HTML for embedded asset attributes in the Assets manager.
public getAssetTableAttributeHtml ( $element, $attribute ) : null | string
$element
$attribute
Результат null | string

getCacheKey() публичный статический Метод

public static getCacheKey ( ) : string
Результат string

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

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

public getDescription ( )

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

public getDeveloper ( )

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

public getDeveloperUrl ( )

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

public getDocumentationUrl ( )

getFileNamePrefix() публичный статический Метод

Shorthand for getting the file name prefix setting.
public static getFileNamePrefix ( ) : mixed
Результат mixed

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

public getName ( )

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

getParameters() публичный статический Метод

Shorthand for getting the parameters setting.
public static getParameters ( ) : mixed
Результат mixed

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

public getReleaseFeedUrl ( )

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

public getSchemaVersion ( )

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

Renders the plugin's settings page.
public getSettingsHtml ( ) : mixed
Результат mixed

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

public getVersion ( )

getWhitelist() публичный статический Метод

Shorthand for getting the whitelist setting.
public static getWhitelist ( ) : mixed
Результат mixed

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

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

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

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

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

Returns if the plugin is compatible with the current system stack.
public isCompatible ( ) : boolean
Результат boolean

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

Defines the earliest version of Craft that this plugin is compatible with.
public isCraftRequiredVersion ( ) : boolean
Результат boolean - Whether the current installed version of Craft is compatible

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

Defines the earliest version of PHP that this plugin is compatible with.
public isPHPRequiredVersion ( ) : boolean
Результат boolean - Whether the current version of PHP is compatible

loadDependencies() публичный статический Метод

The plugin currently depends on the Essence library.
См. также: https://github.com/essence/essence
public static loadDependencies ( )

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

Checks if the plugin is compatible before installation.
public onBeforeInstall ( ) : boolean
Результат boolean

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

Formats values from the CP settings form to be saved into the DB.
public prepSettings ( array $postSettings ) : array
$postSettings array
Результат array