Open Journal Systems  3.3.0
ComposerLintTask Class Reference
Inheritance diagram for ComposerLintTask:

Public Member Functions

 init ()
 
 main ()
 
 setComposer ($str)
 
 setDir ($str)
 
 setFile ($str)
 
 setPassthru ($passthru)
 

Protected Member Functions

 findComposer ()
 
 findFiles ()
 

Protected Attributes

 $composer = null
 
 $dir = null
 
 $file = null
 
 $passthru = false
 

Detailed Description

Phing task for composer validation.

Definition at line 11 of file ComposerLintTask.php.

Member Function Documentation

◆ findComposer()

ComposerLintTask::findComposer ( )
protected

Find composer installation

Definition at line 134 of file ComposerLintTask.php.

Referenced by main().

◆ findFiles()

ComposerLintTask::findFiles ( )
protected

Find the composer.json files using Phing's directory scanner

Returns
array

Definition at line 121 of file ComposerLintTask.php.

Referenced by main().

◆ init()

ComposerLintTask::init ( )

The init method: do init steps

Definition at line 63 of file ComposerLintTask.php.

◆ main()

ComposerLintTask::main ( )

The main entry point

Definition at line 71 of file ComposerLintTask.php.

References $file, findComposer(), and findFiles().

◆ setComposer()

ComposerLintTask::setComposer (   $str)

Composer to execute. If unset, will attempt composer.phar in project basedir, and if that fails, will attempt global composer installation.

Parameters
string$strIndividual file to validate

Definition at line 55 of file ComposerLintTask.php.

◆ setDir()

ComposerLintTask::setDir (   $str)

The setter for the dir

Parameters
string$strDirectory to crawl recursively for composer files

Definition at line 23 of file ComposerLintTask.php.

◆ setFile()

ComposerLintTask::setFile (   $str)

The setter for the file

Parameters
string$strIndividual file to validate

Definition at line 33 of file ComposerLintTask.php.

◆ setPassthru()

ComposerLintTask::setPassthru (   $passthru)

Whether to use PHP's passthru() function instead of exec()

Parameters
boolean$passthruIf passthru shall be used

Definition at line 43 of file ComposerLintTask.php.

References $passthru.

Field Documentation

◆ $composer

ComposerLintTask::$composer = null
protected

Definition at line 16 of file ComposerLintTask.php.

◆ $dir

ComposerLintTask::$dir = null
protected

Definition at line 13 of file ComposerLintTask.php.

◆ $file

ComposerLintTask::$file = null
protected

Definition at line 14 of file ComposerLintTask.php.

Referenced by main().

◆ $passthru

ComposerLintTask::$passthru = false
protected

Definition at line 15 of file ComposerLintTask.php.

Referenced by setPassthru().


The documentation for this class was generated from the following file: