Property | Type | Description | |
---|---|---|---|
$author | |||
$commandDescription | |||
$commandHelp | |||
$commandName | |||
$description | |||
$dirctoryName | |||
$license | |||
$licenses | |||
$name | |||
$namespace | |||
$targetDir |
Method | Description | |
---|---|---|
__construct ( string $targetDir, string $name ) | Constructor. | |
generate ( ) : array | Generates a plugin. | |
getPluginDirName ( ) : string | Gets the plugin directory. | |
setAuthor ( string $name, string $email = '' ) | Sets the author of the plugin. | |
setCommandData ( string $name, string $description = '', $help = '' ) | Sets the command's data in case of command plugin. | |
setDescription ( string $value ) | Sets the description of the plugin. | |
setLicense ( $name ) | Sets the license of the plugin. MIT by default. | |
setNamespace ( string $value ) | Sets the namespace of the plugin. |
Method | Description | |
---|---|---|
getClassname ( string $name ) : string | Gets the classname. | |
getLicenseFile ( string $licenseName ) : string | Gets the license filename. | |
getNamespacePsr4 ( string $namespace ) : string | Gets the namepspace for PSR-4. | |
getPluginDir ( string $name ) : string | Gets the plugin directory. | |
getPluginFilename ( string $name ) : string | Gets the plugin filename. |
public __construct ( string $targetDir, string $name ) | ||
$targetDir | string | The target dir |
$name | string | The name of the plugin. Could you follow the pattern "vendor/class-name" |
protected getClassname ( string $name ) : string | ||
$name | string | |
return | string |
protected getLicenseFile ( string $licenseName ) : string | ||
$licenseName | string | |
return | string | Filename or empty-string if not exists |
protected getNamespacePsr4 ( string $namespace ) : string | ||
$namespace | string | |
return | string |
protected getPluginDir ( string $name ) : string | ||
$name | string | |
return | string |
public getPluginDirName ( ) : string | ||
return | string |
protected getPluginFilename ( string $name ) : string | ||
$name | string | |
return | string |
public setCommandData ( string $name, string $description = '', $help = '' ) | ||
$name | string | The name of the command |
$description | string | The description of the command |
public setDescription ( string $value ) | ||
$value | string |
public setLicense ( $name ) |
public setNamespace ( string $value ) | ||
$value | string |