Overview

Namespaces

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

Classes

  • Backup
  • Call
  • Composer
  • Copy
  • Environment
  • ExternalProperty
  • FillTemplate
  • HTTP
  • Link
  • MkDir
  • Project
  • Property
  • Rename
  • Sync
  • Target
  • Overview
  • Namespace
  • Class
  • Tree
  • Deprecated
  • Todo

Class Project

Tâche mère d'un fichier XML. Contient des tags env ou target.

Attribut 'name' doit être identique au nom contenu dans la configuration XML.

Exemple : <project name="rts">...</project>

Himedia\Padocc\Task
Extended by Himedia\Padocc\Task\WithProperties
Extended by Himedia\Padocc\Task\Base\Project
Namespace: Himedia\Padocc\Task\Base
Author: Original Author Geoffroy AUBRY <gaubry@hi-media.com>
Author: Another Author Tony Caron <caron.tony@gmail.com>
Located at Himedia/Padocc/Task/Base/Project.php
Methods summary
public
# __construct( SimpleXMLElement|string $sXmlProject, string $sEnvName, Himedia\Padocc\DIContainerInterface $oDIContainer )

Constructor.

Constructor.

Parameters

$sXmlProject
SimpleXMLElement|string
$sXmlProject XML project path or XML data
$sEnvName
string
$sEnvName Selected environment.
$oDIContainer
Himedia\Padocc\DIContainerInterface
$oDIContainer Service container.

Throws

UnexpectedValueException
si fichier XML du projet non trouvé
UnexpectedValueException
si environnement non trouvé ou non unique

Overrides

Himedia\Padocc\Task::__construct()
protected
# init( )

Initializes task.

Initializes task.

Throws

UnexpectedValueException
si fichier XML du projet non trouvé
UnexpectedValueException
si environnement non trouvé ou non unique

Overrides

Himedia\Padocc\Task\WithProperties::init()
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.

CodeCoverageIgnore

Overrides

Himedia\Padocc\Task::getTagName()
public static SimpleXMLElement
# getSXEProject( string $sXmlProject )

Retourne une instance SimpleXMLElement du projet spécifié.

Retourne une instance SimpleXMLElement du projet spécifié.

Parameters

$sXmlProject
string
$sXmlProject XML project path or XML data

Returns

SimpleXMLElement
instance du projet spécifié

Throws

UnexpectedValueException
si XML du projet mal formaté
public
# 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

Overrides

Himedia\Padocc\Task::check()
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...

Overrides

Himedia\Padocc\Task\WithProperties::setUp()
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()

Overrides

Himedia\Padocc\Task\WithProperties::preExecute()
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()

Overrides

Himedia\Padocc\Task::centralExecute()
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()

Overrides

Himedia\Padocc\Task::postExecute()
public SimpleXMLElement
# getSXE( )

Retourne le contenu XML de la tâche.

Retourne le contenu XML de la tâche.

Returns

SimpleXMLElement
le contenu XML de la tâche.
Methods inherited from Himedia\Padocc\Task
execute(), expandPath(), fetchAttributes(), getLogger(), getNewInstance(), processPath(), processSimplePath(), registerPaths(), reroutePaths(), setAttributePropertiesAdapter(), setLogger(), setNumberingAdapter(), setPropertiesAdapter(), setShellAdapter()
Properties summary
private Himedia\Padocc\Task\Base\Environment $oBoundTask
#

Tâche appelée.

Tâche appelée.

public string $sEnvName
#

Selected environment.

Selected environment.

Properties inherited from Himedia\Padocc\Task
$aAttValues, $aAttrProperties, $aConfig, $aRegisteredPaths, $oAttrProperties, $oDIContainer, $oNumbering, $oProject, $oProperties, $oShell, $oXMLTask, $sCounter, $sName
Platform for Automatized Deployments with pOwerful Concise Configuration API documentation generated by ApiGen 2.8.0