PHP Класс Yosymfony\Spress\Scaffolding\PluginGenerator

Автор: Victor Puertas ([email protected])
Наследование: extends Generator
Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$author
$commandDescription
$commandHelp
$commandName
$description
$dirctoryName
$email
$license
$licenses
$name
$namespace
$targetDir

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

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

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

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

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

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

Constructor.
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"

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

Generates a plugin.
public generate ( ) : array
Результат array

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

Gets the classname.
protected getClassname ( string $name ) : string
$name string
Результат string

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

Gets the license filename.
protected getLicenseFile ( string $licenseName ) : string
$licenseName string
Результат string Filename or empty-string if not exists

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

Gets the namepspace for PSR-4.
protected getNamespacePsr4 ( string $namespace ) : string
$namespace string
Результат string

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

Gets the plugin directory.
protected getPluginDir ( string $name ) : string
$name string
Результат string

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

Gets the plugin directory.
public getPluginDirName ( ) : string
Результат string

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

Gets the plugin filename.
protected getPluginFilename ( string $name ) : string
$name string
Результат string

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

Sets the author of the plugin.
public setAuthor ( string $name, string $email = '' )
$name string The name of the author
$email string The Email of the author

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

Sets the command's data in case of command plugin.
public setCommandData ( string $name, string $description = '', $help = '' )
$name string The name of the command
$description string The description of the command

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

Sets the description of the plugin.
public setDescription ( string $value )
$value string

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

Sets the license of the plugin. MIT by default.
public setLicense ( $name )

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

Sets the namespace of the plugin.
public setNamespace ( string $value )
$value string

Описание свойств

$author защищенное свойство

protected $author

$commandDescription защищенное свойство

protected $commandDescription

$commandHelp защищенное свойство

protected $commandHelp

$commandName защищенное свойство

protected $commandName

$description защищенное свойство

protected $description

$dirctoryName защищенное свойство

protected $dirctoryName

$email защищенное свойство

protected $email

$license защищенное свойство

protected $license

$licenses защищенное свойство

protected $licenses

$name защищенное свойство

protected $name

$namespace защищенное свойство

protected $namespace

$targetDir защищенное свойство

protected $targetDir