Documentation

Linter
in package

Class Linter.

Table of Contents

Properties

$cache  : array<string|int, mixed>
$excludes  : array<string|int, mixed>
$extensions  : array<string|int, mixed>
$files  : array<string|int, SplFileInfo>
$path  : array<string|int, mixed>
$processCallback  : callable
$processLimit  : int
$warning  : bool

Methods

__construct()  : mixed
Constructor.
getFiles()  : array<string|int, SplFileInfo>
Fetch files.
lint()  : array<string|int, mixed>
Check the files.
setCache()  : mixed
Cache setter.
setFiles()  : Linter
Set Files.
setProcessCallback()  : Linter
Set process callback.
setProcessLimit()  : Linter
Set process limit.
createLintProcess()  : mixed
getFilesFromDir()  : array<string|int, SplFileInfo>
Get files from directory.

Properties

$cache

private array<string|int, mixed> $cache = []

$excludes

private array<string|int, mixed> $excludes

$extensions

private array<string|int, mixed> $extensions

$path

private array<string|int, mixed> $path

$processCallback

private callable $processCallback

$processLimit

private int $processLimit = 5

Methods

__construct()

Constructor.

public __construct(string|array<string|int, mixed> $path[, array<string|int, mixed> $excludes = [] ][, array<string|int, mixed> $extensions = ['php'] ][, bool $warning = false ]) : mixed
Parameters
$path : string|array<string|int, mixed>
$excludes : array<string|int, mixed> = []
$extensions : array<string|int, mixed> = ['php']
$warning : bool = false

lint()

Check the files.

public lint([array<string|int, SplFileInfo> $files = [] ][, bool $cache = true ]) : array<string|int, mixed>
Parameters
$files : array<string|int, SplFileInfo> = []
$cache : bool = true
Return values
array<string|int, mixed>

setCache()

Cache setter.

public setCache([array<string|int, mixed> $cache = [] ]) : mixed
Parameters
$cache : array<string|int, mixed> = []

setFiles()

Set Files.

public setFiles(array<string|int, string> $files) : Linter
Parameters
$files : array<string|int, string>
Return values
Linter

setProcessCallback()

Set process callback.

public setProcessCallback(callable $processCallback) : Linter
Parameters
$processCallback : callable
Return values
Linter

setProcessLimit()

Set process limit.

public setProcessLimit(int $processLimit) : Linter
Parameters
$processLimit : int
Return values
Linter

createLintProcess()

protected createLintProcess(string $filename) : mixed
Parameters
$filename : string

getFilesFromDir()

Get files from directory.

protected getFilesFromDir(string $dir) : array<string|int, SplFileInfo>
Parameters
$dir : string
Return values
array<string|int, SplFileInfo> 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results