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 Target

Définit une section (factorisation) adressable via la tâche call. À inclure dans une tâche project.

Exemple : <call target="static_content" />...<target name="static_content">...</target>

Himedia\Padocc\Task
Extended by Himedia\Padocc\Task\WithProperties
Extended by Himedia\Padocc\Task\Base\Target

Direct known subclasses

Himedia\Padocc\Task\Base\Environment
Namespace: Himedia\Padocc\Task\Base
Author: Geoffroy AUBRY <gaubry@hi-media.com>
Located at Himedia/Padocc/Task/Base/Target.php
Methods summary
protected
# init( )

Initializes task.

Initializes task.

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()
private static array
# getSXEExternalProperties( SimpleXMLElement $oSXEProject, SimpleXMLElement $oNode )

Retourne la liste ordonnée des noeuds XML de type <externalproperty />, sous forme de SimpleXMLElement. Les débusque également dans les noeuds <target /> au travers des <call />.

Retourne la liste ordonnée des noeuds XML de type <externalproperty />, sous forme de SimpleXMLElement. Les débusque également dans les noeuds <target /> au travers des <call />.

Parameters

$oSXEProject
SimpleXMLElement
$oSXEProject instance du projet
$oNode
SimpleXMLElement
$oNode noeud à explorer à la recherche des propriétés externes

Returns

array
la liste ordonnée des noeuds XML de type <externalproperty />, sous forme de SimpleXMLElement.

Throws

UnexpectedValueException
si noeud <target /> non trouvé ou non unique mais référencé par un noeud <call />.
public static array
# getAvailableEnvsList( string $sXmlProject )

Retourne la liste des environnements et de leurs propriétés externes pour le projet spécifié.

Retourne la liste des environnements et de leurs propriétés externes pour le projet spécifié.

Exemple de retour : array( 'dev' => array(), 'qa' => array( 'ref' => "Branch or tag to deploy", ... ) )

Parameters

$sXmlProject
string
$sXmlProject XML project path or XML data

Returns

array
la liste des environnements et de leurs propriétés externes pour le projet spécifié.

Throws

UnexpectedValueException
si fichier XML du projet non trouvé
UnexpectedValueException
si fichier XML du projet mal formaté
UnexpectedValueException
si pas d'environnement trouvé
UnexpectedValueException
si noeud <externalproperty /> invalide
UnexpectedValueException
si noeud <target /> non trouvé ou non unique mais référencé par un noeud <call />.
private static array
# getAvailableTasks( )

Retourne un tableau associatif décrivant les tâches disponibles.

Retourne un tableau associatif décrivant les tâches disponibles.

Returns

array
tableau associatif des tâches disponibles : array('sTag' => 'sClassName', ...)

Throws

RuntimeException
si classe inexistante
LogicException
si collision de nom de tag XML
private array
# getTaskInstances( SimpleXMLElement $oTarget, Himedia\Padocc\Task\Base\Project $oProject )

Retourne la liste des instances de tâches correspondant à chacune des tâches XML devant être exécutée à l'intérieur du noeud XML spécifié.

Retourne la liste des instances de tâches correspondant à chacune des tâches XML devant être exécutée à l'intérieur du noeud XML spécifié.

Parameters

$oTarget
SimpleXMLElement
$oTarget
$oProject
Himedia\Padocc\Task\Base\Project
$oProject

Returns

array
liste d'instances de type Task

Throws

Exception
si tag XML inconnu.

See

Himedia\Padocc\Task
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 de valeur non permise

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()
Methods inherited from Himedia\Padocc\Task
__construct(), execute(), expandPath(), fetchAttributes(), getLogger(), getNewInstance(), postExecute(), processPath(), processSimplePath(), registerPaths(), reroutePaths(), setAttributePropertiesAdapter(), setLogger(), setNumberingAdapter(), setPropertiesAdapter(), setShellAdapter()
Properties summary
private static array $aAvailableTasks array()
#

See

Himedia\Padocc\Task\Base\Target::getAvailableTasks()
protected Himedia\Padocc\Task[] $aTasks
#

Liste d'instances de type Task ordonnées constituant la cible.

Liste d'instances de type Task ordonnées constituant la cible.

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