PHP Class JonathanTorres\Construct\Settings

Datei anzeigen Open project: jonathantorres/construct Class Usage Examples

Public Methods

Method Description
__construct ( string $projectName, string $testingFramework, string $license, string $namespace, boolean $gitInit, boolean $phpcsConfiguration, string $composerKeywords, boolean $vagrantfile, boolean $editorConfig, boolean $phpVersion, boolean $environmentFiles, boolean $lgtmConfiguration, boolean $githubTemplates = false, boolean $codeOfConduct = false, boolean $githubDocs = false ) : void Initialize.
getComposerKeywords ( ) : string Get the entered Composer keywords.
getLicense ( ) : string Get the entered license.
getNamespace ( ) : string Get the entered namespace.
getPhpVersion ( ) : string Get the entered project php version.
getProjectName ( ) : string Get the entered project name.
getTestingFramework ( ) : string Get the entered testing framework.
withCodeOfConduct ( ) : boolean Whether or not to create a Code of Conduct file.
withEditorConfig ( ) : boolean Whether or not to create an EditorConfig file.
withEnvironmentFiles ( ) : boolean Whether or not to create .env environment files.
withGitInit ( ) : boolean Whether or not to initialize a git repo on the project.
withGithubDocs ( ) : boolean Whether or not to create GitHub documentation files.
withGithubTemplates ( ) : boolean Whether or not to create GitHub template files.
withLgtmConfiguration ( ) : boolean Whether or not to create LGTM configuration files.
withPhpcsConfiguration ( ) : boolean Whether or not to use phpcs on the project.
withVagrantfile ( ) : boolean Whether or not to create a Vagrantfile.

Method Details

__construct() public method

Initialize.
public __construct ( string $projectName, string $testingFramework, string $license, string $namespace, boolean $gitInit, boolean $phpcsConfiguration, string $composerKeywords, boolean $vagrantfile, boolean $editorConfig, boolean $phpVersion, boolean $environmentFiles, boolean $lgtmConfiguration, boolean $githubTemplates = false, boolean $codeOfConduct = false, boolean $githubDocs = false ) : void
$projectName string The entered project name.
$testingFramework string The entered testing framework.
$license string The entered project license.
$namespace string The entered namespace.
$gitInit boolean Initialize a git repo?
$phpcsConfiguration boolean Generate a PHP Coding Standards Fixer configuration?
$composerKeywords string The entered list of Composer keywords.
$vagrantfile boolean Generate a Vagrantfile?
$editorConfig boolean Generate an EditorConfig file?
$phpVersion boolean The entered php version
$environmentFiles boolean Generate .env environment files?
$lgtmConfiguration boolean Generate LGTM configuration files?
$githubTemplates boolean Generate GitHub templates?
$codeOfConduct boolean Generate Code of Conduct file?
$githubDocs boolean Generate GitHub docs?
return void

getComposerKeywords() public method

Get the entered Composer keywords.
public getComposerKeywords ( ) : string
return string

getLicense() public method

Get the entered license.
public getLicense ( ) : string
return string

getNamespace() public method

Get the entered namespace.
public getNamespace ( ) : string
return string

getPhpVersion() public method

Get the entered project php version.
public getPhpVersion ( ) : string
return string

getProjectName() public method

Get the entered project name.
public getProjectName ( ) : string
return string

getTestingFramework() public method

Get the entered testing framework.
public getTestingFramework ( ) : string
return string

withCodeOfConduct() public method

Whether or not to create a Code of Conduct file.
public withCodeOfConduct ( ) : boolean
return boolean

withEditorConfig() public method

Whether or not to create an EditorConfig file.
public withEditorConfig ( ) : boolean
return boolean

withEnvironmentFiles() public method

Whether or not to create .env environment files.
public withEnvironmentFiles ( ) : boolean
return boolean

withGitInit() public method

Whether or not to initialize a git repo on the project.
public withGitInit ( ) : boolean
return boolean

withGithubDocs() public method

Whether or not to create GitHub documentation files.
public withGithubDocs ( ) : boolean
return boolean

withGithubTemplates() public method

Whether or not to create GitHub template files.
public withGithubTemplates ( ) : boolean
return boolean

withLgtmConfiguration() public method

Whether or not to create LGTM configuration files.
public withLgtmConfiguration ( ) : boolean
return boolean

withPhpcsConfiguration() public method

Whether or not to use phpcs on the project.
public withPhpcsConfiguration ( ) : boolean
return boolean

withVagrantfile() public method

Whether or not to create a Vagrantfile.
public withVagrantfile ( ) : boolean
return boolean