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 AttributeProperties

Collection des propriétés possibles pour un attribut de tâche. Ces propriétés sont manipulées au sein de champs de bits dans la classe Task.

Namespace: Himedia\Padocc
Author: Geoffroy AUBRY <gaubry@hi-media.com>
See: Task::$aAttrProperties()
Located at Himedia/Padocc/AttributeProperties.php
Methods summary
public
# __construct( GAubry\Shell\ShellAdapter $oShell )

Constructeur.

Constructeur.

Parameters

$oShell
GAubry\Shell\ShellAdapter
$oShell
private
# normalizeAttributeProperties( array & $aProperties )

Normalise les propriétés des attributs des tâches XML. Par exemple si c'est un AttributeProperties::FILEJOKER, alors c'est forcément aussi un AttributeProperties::FILE.

Normalise les propriétés des attributs des tâches XML. Par exemple si c'est un AttributeProperties::FILEJOKER, alors c'est forcément aussi un AttributeProperties::FILE.

Parameters

$aProperties
array
&$aProperties tableau associatif 'nom d'attribut' => propriétés de l'attribut

See

aAttributeProperties
private
# checkUnknownAttributes( array $aProperties, array $aValues )

Vérifie l'absence d'attribut non permis.

Vérifie l'absence d'attribut non permis.

Parameters

$aProperties
array
$aProperties tableau associatif (nom d'attribut => (int)champ de bits de propriétés d'attribut) Les propriétés sont une combinaisons de constantes de cette classe (ex. self::EMAIL).
$aValues
array
$aValues tableau associatif (nom d'attribut => (string)valeur)

Throws

DomainException
en cas d'attribut non permis
public
# checkAttributes( array & $aProperties, array & $aValues )

Vérifie au moyen de tests basiques que les valeurs des attributs sont conformes à leurs propriétés. Lance une exception si tel n'est pas le cas.

Vérifie au moyen de tests basiques que les valeurs des attributs sont conformes à leurs propriétés. Lance une exception si tel n'est pas le cas.

Parameters

$aProperties
array
&$aProperties tableau associatif (nom d'attribut => (int)champ de bits de propriétés d'attribut) Les propriétés sont une combinaisons de constantes de cette classe (ex. self::EMAIL). Passé par référence car potentiellement modifié par normalizeAttributeProperties().
$aValues
array
&$aValues tableau associatif (nom d'attribut => (string)valeur) Passé par référence car potentiellement modifié par formatAttribute().

Throws

UnexpectedValueException
en cas d'attribut ou fichier manquant
DomainException
en cas d'attribut non permis
private string
# formatAttribute( integer $iProperties, string $sValue )

Formate la valeur d'un attribut au regard de ses propriétés.

Formate la valeur d'un attribut au regard de ses propriétés.

Parameters

$iProperties
integer
$iProperties champ de bits de propriétés d'attribut, combinaisons de constantes de cette classe (ex. self::EMAIL).
$sValue
string
$sValue valeur de l'attribut

Returns

string
valeur potentiellement formatée de l'attribut au regard de ses propriétés.
private
# checkAttribute( string $sName, integer $iProperties, string $sValue )

Vérifie au moyen de tests basiques que la valeur de l'attribut spécifié est conforme à ses propriétés. Lance une exception si tel n'est pas le cas.

Vérifie au moyen de tests basiques que la valeur de l'attribut spécifié est conforme à ses propriétés. Lance une exception si tel n'est pas le cas.

Parameters

$sName
string
$sName nom d'attribut
$iProperties
integer
$iProperties champ de bits de propriétés d'attribut, combinaisons de constantes de cette classe (ex. self::EMAIL).
$sValue
string
$sValue valeur de l'attribut

Throws

UnexpectedValueException
en cas d'attribut ou fichier manquant
DomainException
en cas de valeur non permise
Constants summary
integer ALLOW_PARAMETER 1
#

Propriété d'attribut : autorise l'utilisation des '${parameter}'.

Propriété d'attribut : autorise l'utilisation des '${parameter}'.

integer DIR 2
#

Propriété d'attribut : l'attribut désigne un répertoire.

Propriété d'attribut : l'attribut désigne un répertoire.

integer DIRJOKER 4
#

Propriété d'attribut : autorise l'utilisation des jokers shell ? et * pour les répertoires (implique AttributeProperties::DIR).

Propriété d'attribut : autorise l'utilisation des jokers shell ? et * pour les répertoires (implique AttributeProperties::DIR).

integer FILE 8
#

Propriété d'attribut : l'attribut désigne un fichier.

Propriété d'attribut : l'attribut désigne un fichier.

integer FILEJOKER 16
#

Propriété d'attribut : autorise l'utilisation des jokers shell ? et * pour les fichiers (implique AttributeProperties::FILE).

Propriété d'attribut : autorise l'utilisation des jokers shell ? et * pour les fichiers (implique AttributeProperties::FILE).

integer REQUIRED 32
#

Propriété d'attribut : l'attribut est obligatoire.

Propriété d'attribut : l'attribut est obligatoire.

integer SRC_PATH 64
#

Propriété d'attribut : l'attribut est un fichier ou un répertoire source et doit donc exister (implique AttributeProperties::FILE et AttributeProperties::DIR).

Propriété d'attribut : l'attribut est un fichier ou un répertoire source et doit donc exister (implique AttributeProperties::FILE et AttributeProperties::DIR).

integer BOOLEAN 128
#

Propriété d'attribut : l'attribut est un booléen sous forme de chaîne de caractères, valant soit 'true' soit 'false'.

Propriété d'attribut : l'attribut est un booléen sous forme de chaîne de caractères, valant soit 'true' soit 'false'.

integer URL 256
#

Propriété d'attribut : l'attribut est une URL.

Propriété d'attribut : l'attribut est une URL.

integer EMAIL 512
#

Propriété d'attribut : l'attribut est un email.

Propriété d'attribut : l'attribut est un email.

integer MULTI_VALUED 1024
#

Propriété d'attribut : l'attribut peut être multi-valué.

Propriété d'attribut : l'attribut peut être multi-valué.

Properties summary
public static string $sMultiValuedSep '/\s*,\s*/'
#

Pattern regex pour scinder les différentes valeurs d'un attribut doté de la propriété MULTI_VALUED.

Pattern regex pour scinder les différentes valeurs d'un attribut doté de la propriété MULTI_VALUED.

See

Himedia\Padocc\AttributeProperties::checkAttributes()
public static string $sMultiValuedJoinGlue ', '
#

Glue pour concaténer les différentes valeurs d'un attribut doté de la propriété MULTI_VALUED.

Glue pour concaténer les différentes valeurs d'un attribut doté de la propriété MULTI_VALUED.

See

Himedia\Padocc\AttributeProperties::checkAttributes()
protected GAubry\Shell\ShellAdapter $oShell
#

Shell adapter.

Shell adapter.

Platform for Automatized Deployments with pOwerful Concise Configuration API documentation generated by ApiGen 2.8.0