Arbre transversal¶

Ajouter des données¶

Dans la section précédente, nous utilisions des données existantes et nous vérifiions qu’elles semblaient hiérarchiques via la méthode generatetreelist. Toutefois, vous aimeriez normalement ajouter vos données exactement de la même façon que vous le feriez pour tout modèle. Par exemple :

// pseudo code de contrôleur
$data['Category']['parent_id'] =  3;
$data['Category']['nom'] =  'Skate';
$this->Category->save($data);

En utilisant le comportement en arbre, il n’est pas nécessaire de faire autre chose que de définir le parent_id, et le comportement en arbre s’occupera du reste. Si vous ne définissez pas le parent_id, le comportement en arbre ajoutera l’enregistrement à la racine, faisant de votre nouvel ajout une nouvelle entrée de niveau supérieur :

// pseudo code de contrôleur
$data = array();
$data['Category']['nom'] =  'Autres catégories de Personnes';
$this->Category->save($data);

Exécuter les deux fragments de code ci-dessus modifiera votre arbre de cette façon :

• Mes Catégories

  • Fun

    • Sport

      • Surf

      • Tricot extrême

      • Skate Nouveau

    • Amis

      • Gérald

      • Gwendolyne

  • Travail

    • Rapports

      • Annuel

      • Statut

    • Voyages

      • National

      • International

• Catégories des autres Personnes Nouveau

Modifier les données¶

Modifier des données est aussi transparent que d’en ajouter des nouvelles. Si vous modifiez quelque chose, mais que vous ne changez pas le champ parent_id, la structure de vos données sera finalement inchangée. Par exemple :

// pseudo code de contrôleur
$this->Category->id = 5; // id de Tricot extrême
$this->Category->save(array('nom' =>'Pêche extrême'));

Le code ci-dessus n’affecte pas le champ parent_id, même si le parent_id est inclus dans les données qui sont passées au save lorsque sa valeur ne change pas, il n’affecte pas non plus la structure de données. Par conséquent, l’arbre de données devrait maintenant ressembler à :

• Mes Catégories

  • Fun

    • Sport

      • Surf

      • Pêche extrême Mis à jour

      • Skate

    • Amis

      • Gérald

      • Gwendolyne

  • Travail

    • Rapports

      • Annuel

      • Statut

    • Voyages

      • National

      • International

• Catégories des autres Personnes

Déplacer les données au sein de votre arbre est également une simple formalité. Disons que Pêche extrême ne va plus sous Sport, mais qu’elle devrait plutôt être placée sous Autres catégories de Personnes. Avec le code suivant :

// pseudo code de contrôleur
$this->Category->id = 5; // id de Pêche extrême
$nouveauParentId = $this->Category->field('id', array('nom' => 'Autres catégories de Personnes'));
$this->Category->save(array('parent_id' => $nouveauParentId));

Comme attendu, la structure est modifiée en :

• Mes Catégories

  • Fun

    • Sport

      • Surf

      • Skate

    • Amis

      • Gérald

      • Gwendolyne

  • Travail

    • Rapports

      • Annuel

      • Statut

    • Voyages

      • National

      • International

• Catégories des autres Personnes

  • Pêche extrême Déplacé

Supprimer des données¶

Le comportement en arbre fournit de nombreuses manières de gérer la suppression de données. Pour commencer avec l’exemple le plus simple, imaginons que la catégorie des rapports n’est plus utilisée. Pour la supprimer et tous les enfants qu’elle pourrait avoir appelez simplement delete comme vous le feriez pour tout modèle. Par exemple, avec le code suivant :

//  pseudo code de contrôleur
$this->Category->id = 10;
$this->Category->delete();

L’arbre de catégories sera modifié comme ainsi :

• Mes Catégories

  • Fun

    • Sport

      • Surf

      • Skate

    • Amis

      • Gérald

      • Gwendolyne

  • Travail

    • Voyages

      • National

      • International

• Catégories des autres Personnes

  • Pêche extrême

Interroger et utiliser vos données¶

Utiliser et manipuler des données hiérarchiques peut s’avérer une entreprise compliquée. En plus des méthodes find du cœur, avec le comportement en arbre il y a quelques permutations plus orientées arborescence à votre disposition.

La plupart des méthodes du comportement en arbre retournent et dépendent de données qui ont été triées par le champ lft. Si vous appelez find() et que vous ne faites pas un order by lft ou si vous appelez une méthode du comportement en arbre et que vous lui passez un ordre de tri, vous pourriez obtenir des résultats indésirables.

$tousEnfants = $this->Category->children(1); // un tableau simple avec 11 items
// -- ou --
$this->Category->id = 1;
$tousEnfants = $this->Category->children(); // un tableau simple avec 11 items

// Retourne uniquement les enfants directs
$enfantsDirects = $this->Category->children(1, true); // un tableau simple avec 2 items

$nbEnfants = $this->Category->childCount(1); // affichera11
// -- ou --
$this->Category->id = 1;
$directChildren = $this->Category->childCount(); // affichera 11

// Compte uniquement les descendants directs de cette catégorie
$nbEnfants = $this->Category->childCount(1, true); // affichera 2

array(
    [1] =>  "Mes Catégories",
    [2] =>  "_Fun",
    [3] =>  "__Sport",
    [4] =>  "___Surf",
    [16] => "___Skate",
    [6] =>  "__Amis",
    [7] =>  "___Gérald",
    [8] =>  "___Gwendolyne",
    [9] =>  "_Travail",
    [13] => "__Voyages",
    [14] => "___National",
    [15] => "___International",
    [17] => "Catégories des autres personnes",
    [5] =>  "_Pêche extrême"
)

$parent = $this->Category->getparentnode(2); //<- id pour fun
// $parent contient Mes Catégories

$parents = $this->Category->getpath(15);

// contenus de $parents
array(
    [0] =>  array('Category' => array('id' => 1, 'name' => 'Mes Catégories', ..)),
    [1] =>  array('Category' => array('id' => 9, 'name' => 'Travail', ..)),
    [2] =>  array('Category' => array('id' => 13, 'name' => 'Voyages', ..)),
    [3] =>  array('Category' => array('id' => 15, 'name' => 'International', ..)),
)

moveDown¶

Utilisé pour descendre un noeud dans l’arbre hiérarchique. Vous devez spécifier l’id de l’élément à descendre et un entier positif spécifiant de combien de positions le noeud devrait être descendu. Tous les sous-noeuds seront également déplacés dans l’arbre.

Ci-dessus un exemple d’une action d’un contrôleur (dans un contrôleur nommé Categories) qui déplace un noeud spécifique dans l’arbre hiérarchique:

function movedown($title = null, $delta = null) {
        $cat = $this->Category->findByTitle($title);
        if (empty($cat)) {
            $this->Session->setFlash('Aucune catégorie ne porte le nom ' . $title);
            $this->redirect(array('action' => 'index'), null, true);
        }

        $this->Category->id = $cat['Category']['id'];

        if ($delta > 0) {
            $this->Category->moveDown($this->Category->id, abs($delta));
        } else {
            $this->Session->setFlash('Merci de préciser de combien de crans le noeud doit être déplacé');
        }

        $this->redirect(array('action' => 'show'), null, true);
    }

Par exemple, si vous vouliez déplacer la catégories « Cookies » d’un cran vers la bas, votre requête serait : /categories/movedown/Cookies/1.

moveUp¶

Utilisé pour déplacer vers le haut un seul nœud dans l’arbre hiérarchique. Vous devez spécifier l’id de l’élément à déplacer et un entier positif spécifiant de combien de positions le nœud devra être déplacé. Tous les nœuds enfants seront également déplacés.

Ci-dessous un exemple d’une action de contrôleur (dans un contrôleur nommé Categories) qui déplace un nœud spécifique dans l’arbre :

function moveup($name = null, $delta = null){
        $cat = $this->Category->findByName($name);
        if (empty($cat)) {
            $this->Session->setFlash('Il n\'y a pas de catégorie nommée ' . $name);
            $this->redirect(array('action' => 'index'), null, true);
        }

        $this->Category->id = $cat['Category']['id'];

        if ($delta > 0) {
            $this->Category->moveup($this->Category->id, abs($delta));
        } else {
            $this->Session->setFlash('Merci de préciser de combien de positions la catégorie doit être montée.');
        }

        $this->redirect(array('action' => 'index'), null, true);

    }

Par exemple, si vous voulez déplacer la catégorie « Gwendolyn » d’un cran vers le haut, votre requête sera : /categories/moveup/Gwendolyn/1. Maintenant l’ordre de Friends sera Gwendolyn, Gerald.

removeFromTree¶

removeFromTree($id=null, $delete=false)

Utiliser cette méthode supprimera ou déplacera un nœud, mais conservera son sous-arbre, lequel sera ré-apparenté un niveau plus haut. Cela offre plus de contrôle que `delete() </fr/view/690/delete>`_ qui, pour un modèle utilisant le comportement en arbre, effacera le nœud spécifié et tous ses enfants.

Prenons l’arbre suivant comme point de départ :

• Mes Catégories

  • Fun

    • Sport

      • Surf

      • Tricot extrême

      • Skate

Lançons le code suivant avec l’id de “Sport”

$this->Category->removeFromTree($id);

Le nœud Sport va devenir un nœud de niveau principal :

• Mes Catégories

  • Fun

    • Surf

    • Tricot extrême

    • Skate

• Sport Déplacé

Ceci démontre le comportement par défaut de removeFromTree : déplacer le nœud pour qu’il n’ait pas de parent, puis réapparenter tous les enfants.

Si par contre, le fragment de code suivant était utilisé avec l’id de “Sport”

$this->Category->removeFromTree($id,true);

L’arbre deviendrait

• Mes Catégories

  • Fun

    • Surf

    • Tricot extrême

    • Skate

Ceci démontre l’usage alternatif de removeFromTree : les enfants ont été ré-apparenté et “Sport” a été supprimé.

reorder¶

Cette méthode peut être utilisée pour trier hiérarchiquement les données.