Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
3 contributors

Users who have contributed to this file

@brandonkelly @andris-sevcenko @angrybrad
132 lines (112 sloc) 3.7 KB
<?php
/**
* @link https://craftcms.com/
* @copyright Copyright (c) Pixel & Tonic, Inc.
* @license https://craftcms.github.io/license/
*/
namespace craft\base;
/**
* PluginTrait implements the common methods and properties for plugin classes.
*
* @author Pixel & Tonic, Inc. <support@pixelandtonic.com>
* @since 3.0
*/
trait PluginTrait
{
// Properties
// =========================================================================
/**
* @var string|null The plugin’s package name
*/
public $packageName;
/**
* @var string|null The plugin’s display name
*/
public $name;
/**
* @var string|null The plugin’s schema version number
*/
public $schemaVersion = '1.0.0';
/**
* @var string|null The plugin’s description
*/
public $description;
/**
* @var string|null The plugin developer’s name
*/
public $developer;
/**
* @var string|null The plugin developer’s website URL
*/
public $developerUrl;
/**
* @var string|null The plugin developer’s support email
*/
public $developerEmail;
/**
* @var string|null The plugin’s documentation URL
*/
public $documentationUrl;
/**
* The plugin’s changelog URL.
*
* The URL should begin with `https://` and point to a plain text Markdown-formatted changelog.
* Version headers must follow the general format:
*
* ```
* ## X.Y.Z - YYYY-MM-DD
* ```
*
* with the following possible deviations:
*
* - other text can come before the version number, like the plugin’s name
* - a 4th version number is allowed (e.g. `1.2.3.4`)
* - pre-release versions are allowed (e.g. `1.0.0-alpha.1`)
* - the version can start with `v` (e.g. `v1.2.3`)
* - the version can be hyperlinked (e.g. `[1.2.3]`)
* - dates can use dots as separators, rather than hyphens (e.g. `YYYY.MM.DD`)
* - a `[CRITICAL]` flag can be appended after the date to indicate a critical release
*
* More notes:
*
* - Releases should be listed in descending order (newest on top). Craft will stop parsing the changelog as soon as it hits a version that is older than or equal to the installed version.
* - Any content that does not follow a version header line will be ignored.
* - For consistency and clarity, release notes should follow [keepachangelog.com](http://keepachangelog.com/), but it’s not enforced.
* - Release notes can contain notes using the format `> {note} Some note`. `{warning}` and `{tip}` are also supported.
*
* @var string|null The plugin’s changelog URL
*/
public $changelogUrl;
/**
* @var string|null The plugin’s download URL
*/
public $downloadUrl;
/**
* @var string|null The translation category that this plugin’s translation messages should use. Defaults to the lowercased plugin handle.
*/
public $t9nCategory;
/**
* @var string The language that the plugin’s messages were written in
*/
public $sourceLanguage = 'en-US';
/**
* @var bool Whether the plugin has a settings page in the CP
*/
public $hasCpSettings = false;
/**
* @var bool Whether the plugin has its own section in the CP
*/
public $hasCpSection = false;
/**
* @var bool Whether the plugin is currently installed. (Will only be false when a plugin is currently being installed.)
*/
public $isInstalled = false;
/**
* @var string The minimum required version the plugin has to be so it can be updated.
*/
public $minVersionRequired;
/**
* @var string The active edition.
*/
public $edition = 'standard';
}
You can’t perform that action at this time.