Joomla CMS  4.2.2
Documentation des API du CMS Joomla en version 4.2.2
Référence de la classe ProcessHelper
+ Graphe d'héritage de ProcessHelper:

Fonctions membres publiques

 run (OutputInterface $output, $cmd, string $error=null, callable $callback=null, int $verbosity=OutputInterface::VERBOSITY_VERY_VERBOSE)
 
 mustRun (OutputInterface $output, $cmd, string $error=null, callable $callback=null)
 
 wrapCallback (OutputInterface $output, Process $process, callable $callback=null)
 
 getName ()
 
- Fonctions membres publiques hérités de Helper
 setHelperSet (HelperSet $helperSet=null)
 
 getHelperSet ()
 

Fonctions membres privées

 escapeString (string $str)
 

Membres hérités additionnels

- Fonctions membres publiques statiques hérités de Helper
static strlen (?string $string)
 
static width (?string $string)
 
static length (?string $string)
 
static substr (?string $string, int $from, int $length=null)
 
static formatTime ($secs)
 
static formatMemory (int $memory)
 
static strlenWithoutDecoration (OutputFormatterInterface $formatter, ?string $string)
 
static removeDecoration (OutputFormatterInterface $formatter, ?string $string)
 
- Attributs protégés hérités de Helper
 $helperSet = null
 

Description détaillée

The ProcessHelper class provides helpers to run external processes.

Auteur
Fabien Potencier fabie.nosp@m.n@sy.nosp@m.mfony.nosp@m..com

Documentation des fonctions membres

◆ escapeString()

escapeString ( string  $str)
private

◆ getName()

getName ( )

{Returns the canonical name of this helper.

Renvoie
string
}

Implémente HelperInterface.

◆ mustRun()

mustRun ( OutputInterface  $output,
  $cmd,
string  $error = null,
callable  $callback = null 
)

Runs the process.

This is identical to run() except that an exception is thrown if the process exits with a non-zero exit code.

Paramètres
array | Process$cmdAn instance of Process or a command to run
callable | null$callbackA PHP callback to run whenever there is some output available on STDOUT or STDERR
Exceptions
ProcessFailedException
Voir également
run()

Références ProcessHelper\run().

◆ run()

run ( OutputInterface  $output,
  $cmd,
string  $error = null,
callable  $callback = null,
int  $verbosity = OutputInterface::VERBOSITY_VERY_VERBOSE 
)

Runs an external process.

Paramètres
array | Process$cmdAn instance of Process or an array of the command and arguments
callable | null$callbackA PHP callback to run whenever there is some output available on STDOUT or STDERR

Références $message, $output, class, elseif, ProcessHelper\escapeString(), Helper\getHelperSet(), null, et ProcessHelper\wrapCallback().

Référencé par ProcessHelper\mustRun().

◆ wrapCallback()

wrapCallback ( OutputInterface  $output,
Process  $process,
callable  $callback = null 
)

Wraps a Process callback to add debugging output.

Références $buffer, $output, $type, ProcessHelper\escapeString(), Helper\getHelperSet(), et null.

Référencé par ProcessHelper\run().


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