Référence de la classe LintCommand

Graphe d'héritage de LintCommand:

Fonctions membres publiques
	__construct (string $name=null, callable $directoryIteratorProvider=null, callable $isReadableProvider=null)
	complete (CompletionInput $input, CompletionSuggestions $suggestions)
Fonctions membres publiques hérités de Command
	__construct (string $name=null)
	ignoreValidationErrors ()
	setApplication (Application $application=null)
	setHelperSet (HelperSet $helperSet)
	getHelperSet ()
	getApplication ()
	isEnabled ()
	run (InputInterface $input, OutputInterface $output)
	complete (CompletionInput $input, CompletionSuggestions $suggestions)
	setCode (callable $code)
	mergeApplicationDefinition (bool $mergeArgs=true)
	setDefinition ($definition)
	getDefinition ()
	getNativeDefinition ()
	addArgument (string $name, int $mode=null, string $description='', $default=null)
	addOption (string $name, $shortcut=null, int $mode=null, string $description='', $default=null)
	setName (string $name)
	setProcessTitle (string $title)
	getName ()
	setHidden (bool $hidden)
	isHidden ()
	setDescription (string $description)
	getDescription ()
	setHelp (string $help)
	getHelp ()
	getProcessedHelp ()
	setAliases (iterable $aliases)
	getAliases ()
	getSynopsis (bool $short=false)
	addUsage (string $usage)
	getUsages ()
	getHelper (string $name)

Fonctions membres protégées
	configure ()
	execute (InputInterface $input, OutputInterface $output)
Fonctions membres protégées hérités de Command
	configure ()
	execute (InputInterface $input, OutputInterface $output)
	interact (InputInterface $input, OutputInterface $output)
	initialize (InputInterface $input, OutputInterface $output)

Attributs protégés statiques
static	$defaultName = 'lint:yaml'
static	$defaultDescription = 'Lint a YAML file and outputs encountered errors'
Attributs protégés statiques hérités de Command
static	$defaultName
static	$defaultDescription

Fonctions membres privées
	validate (string $content, int $flags, string $file=null)
	display (SymfonyStyle $io, array $files)
	displayTxt (SymfonyStyle $io, array $filesInfo, bool $errorAsGithubAnnotations=false)
	displayJson (SymfonyStyle $io, array $filesInfo)
	getFiles (string $fileOrDirectory)
	getParser ()
	getDirectoryIterator (string $directory)
	isReadable (string $fileOrDirectory)

Attributs privés
	$parser
	$format
	$displayCorrectFiles
	$directoryIteratorProvider
	$isReadableProvider

Membres hérités additionnels
Fonctions membres publiques statiques hérités de Command
static	getDefaultName ()
static	getDefaultDescription ()
Champs de données hérités de Command
const	SUCCESS = 0
const	FAILURE = 1
const	INVALID = 2

Description détaillée

Validates YAML files syntax and outputs encountered errors.

Auteur

Grégoire Pineau lyrix.nosp@m.x@ly.nosp@m.rixx..nosp@m.info

Robin Chalas robin.nosp@m..cha.nosp@m.las@g.nosp@m.mail.nosp@m..com

Documentation des constructeurs et destructeur

__construct()

__construct	(	string	$name = null,
		callable	$directoryIteratorProvider = null,
		callable	$isReadableProvider = null
	)

Références LintCommand\$directoryIteratorProvider, LintCommand\$isReadableProvider, Command\$name, et Symfony\Contracts\Service\__construct().

Documentation des fonctions membres

complete()

complete	(	CompletionInput	$input,
		CompletionSuggestions	$suggestions
	)

Références $input, et CompletionSuggestions\suggestValues().

configure()

configure ( )

protected

{}

Références $this, InputArgument\IS_ARRAY, null, LintCommand\validate(), InputOption\VALUE_IS_ARRAY, InputOption\VALUE_NEGATABLE, et InputOption\VALUE_REQUIRED.

display()

display ( SymfonyStyle  $io, array  $files  )

private

Références LintCommand\displayJson(), et LintCommand\displayTxt().

Référencé par LintCommand\execute().

displayJson()

displayJson ( SymfonyStyle  $io, array  $filesInfo  )

private

Références SymfonyStyle\writeln().

Référencé par LintCommand\display().

displayTxt()

displayTxt ( SymfonyStyle  $io, array  $filesInfo, bool  $errorAsGithubAnnotations = false  )

private

Références $info, SymfonyStyle\comment(), elseif, SymfonyStyle\success(), SymfonyStyle\text(), et SymfonyStyle\warning().

Référencé par LintCommand\display().

execute()

execute ( InputInterface  $input, OutputInterface  $output  )

protected

Références $input, $output, class, LintCommand\display(), LintCommand\getFiles(), GithubActionReporter\isGithubActionEnvironment(), LintCommand\isReadable(), null, Yaml\PARSE_CUSTOM_TAGS, et LintCommand\validate().

getDirectoryIterator()

getDirectoryIterator ( string  $directory )

private

Références $default, et null.

Référencé par LintCommand\getFiles().

getFiles()

getFiles ( string  $fileOrDirectory )

private

Références LintCommand\getDirectoryIterator().

Référencé par LintCommand\execute().

getParser()

getParser ( )

private

Références LintCommand\$parser.

Référencé par LintCommand\validate().

isReadable()

isReadable ( string  $fileOrDirectory )

private

Références $default, et null.

Référencé par LintCommand\execute().

validate()

validate ( string  $content, int  $flags, string  $file = null  )

private

Références $message, ParseException\getParsedLine(), LintCommand\getParser(), et Yaml\PARSE_CONSTANT.

Référencé par LintCommand\configure(), et LintCommand\execute().

Documentation des champs

$defaultDescription

$defaultDescription = 'Lint a YAML file and outputs encountered errors'

staticprotected

$defaultName

$defaultName = 'lint:yaml'

staticprotected

$directoryIteratorProvider

$directoryIteratorProvider

private

Référencé par LintCommand\__construct().

$displayCorrectFiles

$displayCorrectFiles

private

$format

$format

private

$isReadableProvider

$isReadableProvider

private

Référencé par LintCommand\__construct().

$parser

$parser

private

Référencé par LintCommand\getParser().

---

La documentation de cette classe a été générée à partir du fichier suivant :

• LintCommand.php