Overview

Namespaces

  • GAubry
    • ErrorHandler
    • Helpers
    • Logger
    • Shell
  • Himedia
    • Padocc
      • DB
      • Minifier
      • Numbering
      • Properties
      • Task
        • Base
        • Extended
  • None
  • Psr
    • Log

Classes

  • AttributeProperties
  • Deployment
  • DeploymentStatus
  • DIContainer
  • Padocc
  • Task

Interfaces

  • DIContainerInterface
  • Overview
  • Namespace
  • Class
  • Tree
  • Deprecated
  • Todo

Class Task

Direct known subclasses

Himedia\Padocc\Task\Base\Backup, Himedia\Padocc\Task\Base\Composer, Himedia\Padocc\Task\Base\Sync, Himedia\Padocc\Task\Extended\BuildLanguage, Himedia\Padocc\Task\Extended\CVSExport, Himedia\Padocc\Task\Extended\GitExport, Himedia\Padocc\Task\Extended\Minifier, Himedia\Padocc\Task\Extended\TwengaServers, Himedia\Padocc\Task\WithProperties, Himedia\Padocc\Task\Base\Copy, Himedia\Padocc\Task\Base\ExternalProperty, Himedia\Padocc\Task\Base\FillTemplate, Himedia\Padocc\Task\Base\HTTP, Himedia\Padocc\Task\Base\Link, Himedia\Padocc\Task\Base\MkDir, Himedia\Padocc\Task\Base\Property, Himedia\Padocc\Task\Base\Rename

Indirect known subclasses

Himedia\Padocc\Task\Base\Call, Himedia\Padocc\Task\Base\Environment, Himedia\Padocc\Task\Base\Project, Himedia\Padocc\Task\Base\Target, Himedia\Padocc\Task\Extended\B2CSwitchSymlink, Himedia\Padocc\Task\Extended\SwitchSymlink
Abstract
Namespace: Himedia\Padocc
Author: Geoffroy AUBRY <gaubry@hi-media.com>
Located at Himedia/Padocc/Task.php
Methods summary
public static string
# getTagName( )

Retourne le nom du tag XML correspondant à cette tâche dans les config projet.

Retourne le nom du tag XML correspondant à cette tâche dans les config projet.

Returns

string
nom du tag XML correspondant à cette tâche dans les config projet.

Throws

RuntimeException
si appelée directement sur Task.
public static Himedia\Padocc\Task
# getNewInstance( array $aAttributes, Himedia\Padocc\Task\Base\Project $oProject, Himedia\Padocc\DIContainerInterface $oDIContainer )

Surcharge du constructeur, dont le premier paramètre est passé d'une instance de \SimpleXMLElement à un tableau associatif attribut => valeur. Ne peut être utilisé pour créer une instance de Project.

Surcharge du constructeur, dont le premier paramètre est passé d'une instance de \SimpleXMLElement à un tableau associatif attribut => valeur. Ne peut être utilisé pour créer une instance de Project.

Parameters

$aAttributes
array
$aAttributes Tableau associatif listant des attributs et leur valeur.
$oProject
Himedia\Padocc\Task\Base\Project
$oProject Super tâche projet.
$oDIContainer
Himedia\Padocc\DIContainerInterface
$oDIContainer Register de services prédéfinis (ShellInterface, ...).

Returns

Himedia\Padocc\Task

Throws

RuntimeException
si appelée directement sur Task.
public
# __construct( SimpleXMLElement $oXMLTask, Himedia\Padocc\Task\Base\Project $oProject, Himedia\Padocc\DIContainerInterface $oDIContainer )

Constructeur.

Constructeur.

Parameters

$oXMLTask
SimpleXMLElement
$oXMLTask Contenu XML de la tâche.
$oProject
Himedia\Padocc\Task\Base\Project
$oProject Super tâche projet.
$oDIContainer
Himedia\Padocc\DIContainerInterface
$oDIContainer Register de services prédéfinis (ShellInterface, ...).
protected
# init( )

Initializes task.

Initializes task.

public Psr\Log\LoggerInterface
# getLogger( )

Gets the logger.

Gets the logger.

Returns

Psr\Log\LoggerInterface
public
# setLogger( Psr\Log\LoggerInterface $logger )

Sets a logger.

Sets a logger.

Parameters

$logger
Psr\Log\LoggerInterface
$logger
public
# setShellAdapter( GAubry\Shell\ShellAdapter $adapter )

Sets the Shell adapter.

Sets the Shell adapter.

Parameters

$adapter
GAubry\Shell\ShellAdapter
$adapter
public
# setNumberingAdapter( Himedia\Padocc\Numbering\NumberingInterface $adapter )

Sets the numbering adapter.

Sets the numbering adapter.

Parameters

$adapter
Himedia\Padocc\Numbering\NumberingInterface
$adapter
public
# setPropertiesAdapter( Himedia\Padocc\Properties\PropertiesInterface $adapter )

Sets the properties adapter.

Sets the properties adapter.

Parameters

$adapter
Himedia\Padocc\Properties\PropertiesInterface
$adapter
public
# setAttributePropertiesAdapter( Himedia\Padocc\AttributeProperties $adapter )

Sets the attribute properties adapter.

Sets the attribute properties adapter.

Parameters

$adapter
Himedia\Padocc\AttributeProperties
$adapter
protected
# fetchAttributes( )

Récupère les attributs XML du nœud $this->oXMLTask et les enregistre dans $this->aAttValues.

Récupère les attributs XML du nœud $this->oXMLTask et les enregistre dans $this->aAttValues.

protected array
# processPath( string $sPath )

Appels combinés à expandPath() puis reroutePaths()

Appels combinés à expandPath() puis reroutePaths()

Parameters

$sPath
string
$sPath chemin pouvant contenir des paramètres

Returns

array
liste de tous les chemins générés en remplaçant les paramètres par leurs valeurs et en reroutant ceux tombant dans 'basedir'.

See

Himedia\Padocc\Task::expandPath()
Himedia\Padocc\Task::reroutePaths()
protected string
# processSimplePath( string $sPath )

Appel à processPath(), puis retourne le premier chemin récupéré en s'assurant qu'il n'y en a pas d'autres.

Appel à processPath(), puis retourne le premier chemin récupéré en s'assurant qu'il n'y en a pas d'autres.

Parameters

$sPath
string
$sPath chemin pouvant contenir des paramètres

Returns

string
l'unique chemin généré en remplaçant les paramètres par leurs valeurs et en reroutant le chemin s'il tombe dans 'basedir'.

Throws

RuntimeException
si plus d'un chemin a été généré

See

Himedia\Padocc\Task::processPath()
protected array
# expandPath( string $sPath )

Retourne la liste de tous les chemins générés en remplaçant les paramètres du chemin spécifié par leurs valeurs.

Retourne la liste de tous les chemins générés en remplaçant les paramètres du chemin spécifié par leurs valeurs.

Parameters

$sPath
string
$sPath chemin pouvant contenir des paramètres

Returns

array
liste de tous les chemins générés en remplaçant les paramètres par leurs valeurs,
protected array
# reroutePaths( array $aPaths )

Reroute de façon transparente tous les chemins système inclus ou égal à la valeur de la propriété 'basedir' dans le répertoire de releases nommé de la valeur de 'basedir' avec le suffixe $aConfig['symlink_releases_dir_suffix']. Les autres chemins, ceux hors 'basedir', restent inchangés.

Reroute de façon transparente tous les chemins système inclus ou égal à la valeur de la propriété 'basedir' dans le répertoire de releases nommé de la valeur de 'basedir' avec le suffixe $aConfig['symlink_releases_dir_suffix']. Les autres chemins, ceux hors 'basedir', restent inchangés.

Parameters

$aPaths
array
$aPaths liste de chemins sans paramètres (par exemple provenant de expandPath())

Returns

array
liste de ces mêmes chemins en reroutant ceux tombant dans 'basedir'.
protected
# registerPaths( )

Collecte les chemins système définis dans les attributs de la tâche, et les centralise au niveau de la classe pour analyse ultérieure.

Collecte les chemins système définis dans les attributs de la tâche, et les centralise au niveau de la classe pour analyse ultérieure.

public
# setUp( )

Prépare la tâche avant exécution : vérifications basiques, analyse des serveurs concernés...

Prépare la tâche avant exécution : vérifications basiques, analyse des serveurs concernés...

protected
# check( )

Vérifie au moyen de tests basiques que la tâche peut être exécutée. Lance une exception si tel n'est pas le cas.

Vérifie au moyen de tests basiques que la tâche peut être exécutée. Lance une exception si tel n'est pas le cas.

Comme toute les tâches sont vérifiées avant que la première ne soit exécutée, doit permettre de remonter au plus tôt tout dysfonctionnement. Appelé avant la méthode execute().

Throws

UnexpectedValueException
en cas d'attribut ou fichier manquant
DomainException
en cas d'attribut non permis

See

self::$aAttributeProperties
protected
# preExecute( )

Phase de pré-traitements de l'exécution de la tâche. Elle devrait systématiquement commencer par "parent::preExecute();". Appelé par execute().

Phase de pré-traitements de l'exécution de la tâche. Elle devrait systématiquement commencer par "parent::preExecute();". Appelé par execute().

See

Himedia\Padocc\Task::execute()
protected
# centralExecute( )

Phase de traitements centraux de l'exécution de la tâche. Elle devrait systématiquement commencer par "parent::centralExecute();". Appelé par execute().

Phase de traitements centraux de l'exécution de la tâche. Elle devrait systématiquement commencer par "parent::centralExecute();". Appelé par execute().

See

Himedia\Padocc\Task::execute()

CodeCoverageIgnore

protected
# postExecute( )

Phase de post-traitements de l'exécution de la tâche. Elle devrait systématiquement finir par "parent::postExecute();". Appelé par execute().

Phase de post-traitements de l'exécution de la tâche. Elle devrait systématiquement finir par "parent::postExecute();". Appelé par execute().

See

Himedia\Padocc\Task::execute()

CodeCoverageIgnore

public
# execute( )

Exécute la tâche en trois phases : pré-traitements, traitements centraux et post-traitements. Si l'on a la classe F fille de la tâche P, alors on peut s'attendre à :
P::preExecute()
F::preExecute()
P::centralExecute()
F::centralExecute()
F::postExecute()
P::postExecute()

Exécute la tâche en trois phases : pré-traitements, traitements centraux et post-traitements. Si l'on a la classe F fille de la tâche P, alors on peut s'attendre à : P::preExecute() F::preExecute() P::centralExecute() F::centralExecute() F::postExecute() P::postExecute()

See

Himedia\Padocc\Task::preExecute()
Himedia\Padocc\Task::centralExecute()
Himedia\Padocc\Task::postExecute()
Properties summary
protected Himedia\Padocc\Numbering\NumberingInterface $oNumbering
#

Compteur d'instances pour mieux s'y retrouver dans les logs des tâches.

Compteur d'instances pour mieux s'y retrouver dans les logs des tâches.

See

mixed
protected Himedia\Padocc\DIContainerInterface $oDIContainer
#

Collection de services.

Collection de services.

protected Himedia\Padocc\AttributeProperties $oAttrProperties
#

Instance de AttributeProperties.

Instance de AttributeProperties.

See

Himedia\Padocc\Task::check()
protected GAubry\Shell\ShellAdapter $oShell
#

Shell adapter

Shell adapter

private Psr\Log\LoggerInterface $oLogger
#

Logger adapter

Logger adapter

protected array $aConfig
#
protected Himedia\Padocc\Properties\PropertiesInterface $oProperties
#

Properties adapter

Properties adapter

protected SimpleXMLElement $oXMLTask
#

Contenu XML de la tâche.

Contenu XML de la tâche.

protected Himedia\Padocc\Task\Base\Project $oProject
#
protected string $sCounter
#

Chaîne numérotant la tâche.

Chaîne numérotant la tâche.

See

NumberingInterface::getNextCounterValue()
protected string $sName
#

Nom complet de la tâche, utilisé notamment dans le suivi d'exécution.

Nom complet de la tâche, utilisé notamment dans le suivi d'exécution.

protected array $aAttValues
#

Attributs XML de la tâche. Tableau ((string) clé, (string) valeur).

Attributs XML de la tâche. Tableau ((string) clé, (string) valeur).

protected array $aAttrProperties
#

Liste des propriétés des attributs déclarés de la tâche.

Liste des propriétés des attributs déclarés de la tâche.

Structure : array('attribute' => iValue, ...) Où iValue vaut 0 ou une combinaison de bits au sens |, à partir des constantes de la classe AttributeProperties.

See

Himedia\Padocc\Task::check()
Himedia\Padocc\AttributeProperties
protected static array $aRegisteredPaths array()
#

Centralisation de tous les chemins systèmes définis dans l'une ou l'autre des tâches. Dédoublonnés et triés par ordre alphabétique. Structure : array((string)path => true, ...)

Centralisation de tous les chemins systèmes définis dans l'une ou l'autre des tâches. Dédoublonnés et triés par ordre alphabétique. Structure : array((string)path => true, ...)

See

Himedia\Padocc\Task::registerPaths()
Platform for Automatized Deployments with pOwerful Concise Configuration API documentation generated by ApiGen 2.8.0