PHP 클래스 RoboFile, Robo

또한 보기: http://robo.li/

상속: extends Robo\Tasks, use trait joomla_projects\robo\loadTasks

공개 메소드들

메소드	설명
changed ( string $addition )	Update changelog.
docs ( )	Generate the Robo documentation files.
generateTask ( $className, $wrapperClassName = "" )	Generate a new Robo task that wraps an existing utility class.
pharBuild ( )	Build the Robo phar executable.
pharInstall ( )	Install Robo phar.
pharPublish ( )	Publish Robo phar.
publish ( )	Publish Robo.
release ( $opts = ['beta' => false] )	Release Robo.
sniff ( string $file = 'src/', $options = ['autofix' => false, 'strict' => false] )	Code sniffer.
test ( array $args, $options = ['coverage-html' => false, 'coverage' => false] )	Run the Robo unit tests.
versionBump ( string $version = '', $options = ['stage' => ''] )	Update the version of Robo.

보호된 메소드들

메소드	설명
devDependenciesToRemoveFromPhar ( ) : array	The phar:build command removes the project requirements from the 'require-dev' section that are not in the 'suggest' section.
incrementVersion ( string $version, string $stage = '' ) : string	Advance to the next SemVer version.
writeVersion ( string $version )	Write the specified version string back into the Robo.php file.

메소드 상세

changed() 공개 메소드

Add an entry to the Robo CHANGELOG.md file.

public changed ( string $addition )
$addition	string	The text to add to the change log.

devDependenciesToRemoveFromPhar() 보호된 메소드

The phar:build command removes the project requirements from the 'require-dev' section that are not in the 'suggest' section.

protected devDependenciesToRemoveFromPhar ( ) : array
리턴	array

docs() 공개 메소드

Generate the Robo documentation files.

public docs ( )

generateTask() 공개 메소드

Generate a new Robo task that wraps an existing utility class.

public generateTask ( $className, $wrapperClassName = "" )
$className		The name of the existing utility class to wrap.
$wrapperClassName		The name of the wrapper class to create. Optional.

incrementVersion() 보호된 메소드

The behavior depends on the parameter $stage. - If $stage is empty, then the patch or minor version of $version is incremented - If $stage matches the current stage in the current version, then add one to the stage (e.g. alpha3 -> alpha4) - If $stage does not match the current stage in the current version, then reset to '1' (e.g. alpha4 -> beta1)

protected incrementVersion ( string $version, string $stage = '' ) : string
$version	string	A SemVer version
$stage	string	dev, alpha, beta, rc or an empty string for stable.
리턴	string

pharBuild() 공개 메소드

Build the Robo phar executable.

public pharBuild ( )

pharInstall() 공개 메소드

Installs the Robo phar executable in /usr/bin. Uses 'sudo'.

public pharInstall ( )

pharPublish() 공개 메소드

Commits the phar executable to Robo's GitHub pages site.

public pharPublish ( )

publish() 공개 메소드

Builds a site in gh-pages branch. Uses mkdocs

public publish ( )

release() 공개 메소드

Release Robo.

public release ( $opts = ['beta' => false] )

sniff() 공개 메소드

Run the PHP Codesniffer on a file or directory.

public sniff ( string $file = 'src/', $options = ['autofix' => false, 'strict' => false] )
$file	string	A file or directory to analyze.

test() 공개 메소드

Run the Robo unit tests.

public test ( array $args, $options = ['coverage-html' => false, 'coverage' => false] )
$args	array

versionBump() 공개 메소드

Update the version of Robo.

public versionBump ( string $version = '', $options = ['stage' => ''] )
$version	string	The new verison for Robo. Defaults to the next minor (bugfix) version after the current relelase.

writeVersion() 보호된 메소드

Write the specified version string back into the Robo.php file.

protected writeVersion ( string $version )
$version	string