PHP 클래스 JonathanTorres\Construct\Construct

파일 보기 프로젝트 열기: jonathantorres/construct

보호된 프로퍼티들

프로퍼티 타입 설명
$developmentRequirements array The Composer development requirements/packages.
$exportIgnores array The files to ignore on exporting.
$file JonathanTorres\Construct\Helpers\Filesystem The filesystem helper.
$gitIgnores array The directories and files to ignore in Git repositories.
$projectLower string ex: construct
$projectUpper string ex: Construct
$settings Settings The construct command selections instance.
$srcPath string Folder to store source files.
$str JonathanTorres\Construct\Helpers\Str String helper.
$vendorLower string ex: jonathantorres
$vendorUpper string ex: JonathanTorres

공개 메소드들

메소드 설명
__construct ( Filesystem $file, Str $str ) : void Initialize.
generate ( Settings $settings, JonathanTorres\Construct\Helpers\Git $git, Script $script ) : void Generate project.
getprojectLower ( ) : string Get project root folder.

보호된 메소드들

메소드 설명
behat ( ) : void Add behat to development requirements.
changelog ( ) : void Generate CHANGELOG.md file.
codeOfConduct ( ) : void Generate Code of Conduct file.
codeception ( ) : void Add codeception to development requirements.
composer ( JonathanTorres\Construct\Helpers\Git $git ) : void Generate composer file.
composerInstall ( Script $script ) : void Do an initial composer install and require the set development packages in the constructed project.
contributing ( ) : void Generate CONTRIBUTING.md file.
createNamespace ( boolean $useDoubleSlashes = false ) : string Construct a correct project namespace name.
docs ( ) : void Generate documentation (README, CONTRIBUTING, CHANGELOG) files.
editorConfig ( ) : void Generate EditorConfig configuration file.
environmentFiles ( ) : void Generate .env environment files and add package to the development requirements.
gitInit ( JonathanTorres\Construct\Helpers\Git $git ) : void Initialize an empty git repo.
gitattributes ( ) : void Generate gitattributes file.
githubDocs ( ) : void Generate GitHub documentation files.
githubTemplates ( ) : void Generate GitHub template files.
gitignore ( ) : void Generate gitignore file.
gitmessage ( ) : void Copy .gitmessage stub file.
lgtmFiles ( ) : void Generate LGTM configuration files.
license ( JonathanTorres\Construct\Helpers\Git $git ) : void Generate LICENSE.md file.
phpcs ( ) : void Generate PHP CS Fixer configuration file and add package to the development requirements.
phpspec ( ) : void Generate phpspec config file, create a specs directory and add package to development requirements.
phpunit ( ) : void Generate phpunit test/file/settings and add package to the development requirements.
phpunitTest ( ) : void Generate phpunit test file.
projectClass ( ) : void Generate project class file.
readme ( ) : void Generate README.md file.
root ( ) : void Create project root folder.
saveNames ( ) : void Save versions of project names.
scripts ( Script $script ) : void Run any extra scripts.
src ( ) : void Create 'src' folder.
testing ( ) : void Generate files for the selected testing framework.
travis ( ) : void Generate .travis.yml file.
vagrant ( ) : void Generate Vagrant file.

메소드 상세

__construct() 공개 메소드

Initialize.
public __construct ( Filesystem $file, Str $str ) : void
$file JonathanTorres\Construct\Helpers\Filesystem
$str JonathanTorres\Construct\Helpers\Str
리턴 void

behat() 보호된 메소드

Add behat to development requirements.
protected behat ( ) : void
리턴 void

changelog() 보호된 메소드

Generate CHANGELOG.md file.
protected changelog ( ) : void
리턴 void

codeOfConduct() 보호된 메소드

Generate Code of Conduct file.
protected codeOfConduct ( ) : void
리턴 void

codeception() 보호된 메소드

Add codeception to development requirements.
protected codeception ( ) : void
리턴 void

composer() 보호된 메소드

Generate composer file.
protected composer ( JonathanTorres\Construct\Helpers\Git $git ) : void
$git JonathanTorres\Construct\Helpers\Git The git helper.
리턴 void

composerInstall() 보호된 메소드

Do an initial composer install and require the set development packages in the constructed project.
protected composerInstall ( Script $script ) : void
$script JonathanTorres\Construct\Helpers\Script
리턴 void

contributing() 보호된 메소드

Generate CONTRIBUTING.md file.
protected contributing ( ) : void
리턴 void

createNamespace() 보호된 메소드

Construct a correct project namespace name.
protected createNamespace ( boolean $useDoubleSlashes = false ) : string
$useDoubleSlashes boolean Whether or not to create the namespace with double slashes \\
리턴 string

docs() 보호된 메소드

Generate documentation (README, CONTRIBUTING, CHANGELOG) files.
protected docs ( ) : void
리턴 void

editorConfig() 보호된 메소드

Generate EditorConfig configuration file.
protected editorConfig ( ) : void
리턴 void

environmentFiles() 보호된 메소드

Generate .env environment files and add package to the development requirements.
protected environmentFiles ( ) : void
리턴 void

generate() 공개 메소드

Generate project.
public generate ( Settings $settings, JonathanTorres\Construct\Helpers\Git $git, Script $script ) : void
$settings Settings The command settings made by the user.
$git JonathanTorres\Construct\Helpers\Git The git helper.
$script JonathanTorres\Construct\Helpers\Script The script helper.
리턴 void

getprojectLower() 공개 메소드

Get project root folder.
public getprojectLower ( ) : string
리턴 string

gitInit() 보호된 메소드

Initialize an empty git repo.
protected gitInit ( JonathanTorres\Construct\Helpers\Git $git ) : void
$git JonathanTorres\Construct\Helpers\Git
리턴 void

gitattributes() 보호된 메소드

Generate gitattributes file.
protected gitattributes ( ) : void
리턴 void

githubDocs() 보호된 메소드

Generate GitHub documentation files.
protected githubDocs ( ) : void
리턴 void

githubTemplates() 보호된 메소드

Generate GitHub template files.
protected githubTemplates ( ) : void
리턴 void

gitignore() 보호된 메소드

Generate gitignore file.
protected gitignore ( ) : void
리턴 void

gitmessage() 보호된 메소드

Copy .gitmessage stub file.
protected gitmessage ( ) : void
리턴 void

lgtmFiles() 보호된 메소드

Generate LGTM configuration files.
protected lgtmFiles ( ) : void
리턴 void

license() 보호된 메소드

Generate LICENSE.md file.
protected license ( JonathanTorres\Construct\Helpers\Git $git ) : void
$git JonathanTorres\Construct\Helpers\Git The git helper.
리턴 void

phpcs() 보호된 메소드

Generate PHP CS Fixer configuration file and add package to the development requirements.
protected phpcs ( ) : void
리턴 void

phpspec() 보호된 메소드

Generate phpspec config file, create a specs directory and add package to development requirements.
protected phpspec ( ) : void
리턴 void

phpunit() 보호된 메소드

Generate phpunit test/file/settings and add package to the development requirements.
protected phpunit ( ) : void
리턴 void

phpunitTest() 보호된 메소드

Generate phpunit test file.
protected phpunitTest ( ) : void
리턴 void

projectClass() 보호된 메소드

Generate project class file.
protected projectClass ( ) : void
리턴 void

readme() 보호된 메소드

Generate README.md file.
protected readme ( ) : void
리턴 void

root() 보호된 메소드

Create project root folder.
protected root ( ) : void
리턴 void

saveNames() 보호된 메소드

Save versions of project names.
protected saveNames ( ) : void
리턴 void

scripts() 보호된 메소드

Run any extra scripts.
protected scripts ( Script $script ) : void
$script JonathanTorres\Construct\Helpers\Script
리턴 void

src() 보호된 메소드

Create 'src' folder.
protected src ( ) : void
리턴 void

testing() 보호된 메소드

Generate files for the selected testing framework.
protected testing ( ) : void
리턴 void

travis() 보호된 메소드

Generate .travis.yml file.
protected travis ( ) : void
리턴 void

vagrant() 보호된 메소드

Generate Vagrant file.
protected vagrant ( ) : void
리턴 void

프로퍼티 상세

$developmentRequirements 보호되어 있는 프로퍼티

The Composer development requirements/packages.
protected array $developmentRequirements
리턴 array

$exportIgnores 보호되어 있는 프로퍼티

The files to ignore on exporting.
protected array $exportIgnores
리턴 array

$file 보호되어 있는 프로퍼티

The filesystem helper.
protected Filesystem,JonathanTorres\Construct\Helpers $file
리턴 JonathanTorres\Construct\Helpers\Filesystem

$gitIgnores 보호되어 있는 프로퍼티

The directories and files to ignore in Git repositories.
protected array $gitIgnores
리턴 array

$projectLower 보호되어 있는 프로퍼티

ex: construct
protected string $projectLower
리턴 string

$projectUpper 보호되어 있는 프로퍼티

ex: Construct
protected string $projectUpper
리턴 string

$settings 보호되어 있는 프로퍼티

The construct command selections instance.
protected Settings,JonathanTorres\Construct $settings
리턴 Settings

$srcPath 보호되어 있는 프로퍼티

Folder to store source files.
protected string $srcPath
리턴 string

$str 보호되어 있는 프로퍼티

String helper.
protected Str,JonathanTorres\Construct\Helpers $str
리턴 JonathanTorres\Construct\Helpers\Str

$vendorLower 보호되어 있는 프로퍼티

ex: jonathantorres
protected string $vendorLower
리턴 string

$vendorUpper 보호되어 있는 프로퍼티

ex: JonathanTorres
protected string $vendorUpper
리턴 string