PluginVariable

Type
Class
Namespace
Craft
Inherits
Craft\PluginVariable » Craft\BaseComponentTypeVariable
Since
1.0

Plugin template variable.

See also http://craftcms.com

View source

Protected Properties

Public Methods

MethodDescription
__construct()Constructor
__toString()Use the component's name as its string representation.
getClassHandle()Returns the component's class handle.
getDescription()Returns the plugin’s description.
getDeveloper()Returns the plugin developer's name.
getDeveloperUrl()Returns the plugin developer's URL.
getDocumentationUrl()Returns the plugin documentation's URL.
getName()Returns the plugin’s display name.
getSettingsHtml()Returns the component's settings HTML.
getSettingsUrl()Returns the URL to the plugin's settings in the CP.
getVersion()Returns the plugin's version.
isEnabled()Returns if the plugin is currently enabled or not.
isInstalled()Returns whether the plugin is installed.
isSelectable()Returns whether this component should be selectable when choosing a component of this type.
populateVariables()Mass-populates instances of this class with a given set of models.

getDescription()

Returns the plugin’s description.

View source

Returns

string

Signature

public string getDescription ( )

getDeveloper()

Returns the plugin developer's name.

View source

Returns

string

Signature

public string getDeveloper ( )

getDeveloperUrl()

Returns the plugin developer's URL.

View source

Returns

string

Signature

public string getDeveloperUrl ( )

getDocumentationUrl()

Returns the plugin documentation's URL.

View source

Returns

string

Signature

public string getDocumentationUrl ( )

getName()

Returns the plugin’s display name.

View source

Returns

string

Signature

public string getName ( )

getSettingsUrl()

Returns the URL to the plugin's settings in the CP.

View source

Returns

string, null

Signature

public string, null getSettingsUrl ( )

getVersion()

Returns the plugin's version.

View source

Returns

string

Signature

public string getVersion ( )

isEnabled()

Returns if the plugin is currently enabled or not.

View source

Returns

boolean

Signature

public boolean isEnabled ( )

isInstalled()

Returns whether the plugin is installed.

View source

Returns

boolean

Signature

public boolean isInstalled ( )