Archives de la catégorie ‘architecture’

 

Standard PHP Library : ArrayAccess – 17. février, 2009

La “librairie standard de PHP” ou SPL sont un ensemble de classes et d’interfaces qui permettent d’optimiser les performances et les pratiques de programmation en PHP. Cet outil, qui est installé par défaut dans PHP, mérite fortement d’être connu et permet des acrobaties très intéressantes, comme nous allons le voir.

Ce tout premier tutoriel aborde une classe courante de la SPL : ArrayAccess. Nous allons nous amuser à mettre en place un lien fort entre un flux XML et un tableau. Ce système permet d’écrire et de lire dans un fichier XML de manière très simple, à travers un tableau !

Lier un flux XML à un tableau

ArrayAccess est une interface qui permet de donner à une classe des propriétés que seuls les tableaux avaient jusqu’à présent. Le principe : on peut contrôler les actions qui sont faites sur une variable qui s’apparente à un tableau, en particulier ajouter, modifier et retirer des éléments.

En d’autres termes, nous souhaitons lire et écrire dans ce flux xml…

<products>
  <product id='bpp'>Best practices PHP</product>
  <product id='zf'>Zend Framework</product>
  <product id='mp'>Memento PHP</product>
</products>

…à travers un tableau, comme ceci :

// Affichage d'un produit
echo $products['bpp'] . "\n";
 
// Ajout d'un produit
$products['xml'] = "Le XML facile";
echo $products['xml'] . "\n";
 
// Suppression d'un produit
unset($products['pa']);
echo $products['pa'] . "\n";

La classe ProductList

Commençons par écrire notre classe qui contient le mécanisme de liaison entre le flux et le tableau simulé :

class ProductList implements ArrayAccess
{
    private $products = null;
 
    public function __construct($feed)
    {
        $this->products = simplexml_load_string($feed);
    }
 
    public function offsetExists($offset)
    {
        $xpath = '/products/product[@id=\'' . $offset . '\']';
        $values = $this->products->xpath($xpath);
        return (boolean) count($values);
    }
 
    public function offsetGet($offset)
    {
        $xpath = '/products/product[@id=\'' . $offset . '\']';
        $values = $this->products->xpath($xpath);
        if (count($values)) {
            return (string) $values[0];
        }
        return null;
    }
 
    public function offsetSet($offset, $value)
    {
        $product = $this->products->addChild('product', $value);
        $product['id'] = $offset;
    }
 
    public function offsetUnset($offset)
    {
        $cpt = -1;
        $toDel = array();
        foreach ($this->products->product as $product) {
            $cpt++;
            if ($product['id'] == $offset) {
                $toDel[] = $cpt;
            }
        }
        foreach ($toDel as $id) {
            unset($this->products->product[$id]);
        }
    }
 
    public function getXml()
    {
        return $this->products->asXML();
    }
}

Cette classe, qui implémente l’interface ArrayAccess, charge un flux XML via son constructeur __construct(). Ce flux peut être récupéré grâce à la méthode getXml(). Les quatres méthodes intéressantes, qui sont imposées par l’interface ArrayAccess sont les suivantes :

  • offsetExists est automatiquement appelé lorsque PHP souhaite savoir si un élément $offset du tableau existe. Pour simuler cela, nous faisons une requête xpath sur le flux XML.
  • offsetGet récupère l’élément du tableau dont la clé est $offset.
  • offsetSet ajoute un élément au tableau. Faire cela avec simplexml est un jeu d’enfant.
  • offsetUnset retire un élément du tableau. L’algorithme proposé ici retire les éventuels doublons.

Ainsi, la création d’un nouveau objet ProductList peut s’utiliser comme un tableau, comme le monde la section suivante.

Utilisation de l’objet ArrayAccess

Voici un petit exemple d’utilisation de cet objet. Comme nous pouvons le voir, son maniement s’apparente à celui d’un tableau et pourtant, c’est un fichier XML qui est manipulé par dessous :

$feed = "
<products>
  <product id='bpp'>Best practices PHP</product>
  <product id='zf'>Zend Framework</product>
  <product id='mp'>Memento PHP</product>
</products>
";
 
// Création d'un tableau attaché au flux XML
$products = new ProductList($feed);
 
// Affichage d'un produit
echo $products['bpp'] . "\n";
 
// Ajout d'un produit
$products['xml'] = "Le XML facile";
echo $products['xml'] . "\n";
 
// Suppression d'un produit
unset($products['mp']);
echo $products['mp'] . "\n";
 
// Extraction du flux XML modifié
echo $products->getXml();

Le flux généré par ce petit exemple est le suivant :

<products>
  <product id="bpp">Best practices PHP</product>
  <product id="zf">Zend Framework</product>
  <product id="xml">Le XML facile</product>
</products>

Ce petit tutoriel s’arrête ici. Nous irons un peu plus loin dans le prochain avec d’autres interfaces telles qu’Iterator et Countable.

0 commentaire
Posté dans PHP, SPL, architecture

Pages

Archives

Blogs amis

PHP

Projets

Mots-clefs