Tree¶

Ajouter des données¶

Dans la section précédente, nous avons utilisé des données existantes et nous avons vérifié qu’elles semblaient hiérarchiques avec la méthode generateTreeList. Toutefois vous devez ajouter vos données de la même manière que vous le feriez pour n’importe quel model. Par exemple:

// pseudo controller code
$data['Category']['parent_id'] = 3;
$data['Category']['name'] = 'Skating';
$this->Category->save($data);

Lorsque vous utilisez le behavior en arbre il n’est pas nécessaire de faire plus que de définir l’id du parent (parent_id), le behavior tree prendra soin du reste. Si vous ne définissez pas l’id du parent (parent_id), Le behavior Tree additionnera vos nouveaux ajouts au sommet de l’arbre:

// pseudo code du controller
$data = array();
$data['Category']['name'] = 'Other People\'s Categories';
$this->Category->save($data);

Exécuter les extraits de code ci-dessus devrait modifier l’arbre comme suit:

• My Categories

  • Fun

    • Sport

      • Surfing

      • Extreme knitting

      • Skating New

    • Friends

      • Gerald

      • Gwendolyn

  • Work

    • Reports

      • Annual

      • Status

    • Trips

      • National

      • International

• Other People’s Categories New

Modification des données¶

La modification des données est aussi transparente que l’addition des données. Si vous modifiez quelque chose, mais ne changez pas le champ de l’id du parent (parent_id) - la structure de vos données restera inchangée. Par exemple:

// pseudo controller code
$this->Category->id = 5; // id of Extreme knitting
$this->Category->save(array('name' => 'Extreme fishing'));

Le code ci-dessus n’affecterait pas le champ de l’id du parent (parent_id) - même si l’id du parent (parent_id) est inclue dans les données passées à sauvegarder si les données ne changent pas, pas plus que la structure de données. Donc l’arbre de données devrait maintenant ressembler à:

• My Categories

  • Fun

    • Sport

      • Surfing

      • Extreme fishing Updated

      • Skating

    • Friends

      • Gerald

      • Gwendolyn

  • Work

    • Reports

      • Annual

      • Status

    • Trips

      • National

      • International

• Other People’s Categories

Déplacer les données autour de votre arbre est aussi une affaire simple. Supposons que Extreme fishing n’appartienne pas à Sport, mais devrait se trouver plutôt sous « D’autres catégories de gens ». Avec le code suivant:

// pseudo controller code
$this->Category->id = 5; // id of Extreme fishing
$newParentId = $this->Category->field(
  'id',
  array('name' => 'Other People\'s Categories')
);
$this->Category->save(array('parent_id' => $newParentId));

Comme on pouvait s’y attendre, la structure serait modifiée comme suit:

• My Categories

  • Fun

    • Sport

      • Surfing

      • Skating

    • Friends

      • Gerald

      • Gwendolyn

  • Work

    • Reports

      • Annual

      • Status

    • Trips

      • National

      • International

• Other People’s Categories

  • Extreme fishing Moved

Suppression des données¶

Le behavior Tree fournit un certain nombre de façons de gérer la suppression des données. Pour commencer par le plus simple exemple, disons que la catégorie des rapports n’est plus utile. Pour l’enlever * et tous les enfants qu’il peut avoir * il suffit d’appeler et supprimer comme vous le feriez pour n’importe quel model. Par exemple, avec le code suivant:

// pseudo code du controller
$this->Category->id = 10;
$this->Category->delete();

L’arbre des Catégories serait modifié comme suit:

• My Categories

  • Fun

    • Sport

      • Surfing

      • Skating

    • Friends

      • Gerald

      • Gwendolyn

  • Work

    • Trips

      • National

      • International

• Other People’s Categories

  • Extreme fishing

Interroger et utiliser vos données¶

Utiliser et manipuler des données hiérarchisées peut s’avérer assez difficile. C’est pourquoi le behavior tree met à votre disposition quelques méthodes de permutations en plus des méthodes find de bases.

class TreeBehavior

children($id = null, $direct = false, $fields = null, $order = null, $limit = null, $page = 1, $recursive = null)¶

Paramètres:

• $id – L’id de l’enregistrement à rechercher.

• $direct – Defini à true pour ne retourner que les descendants directs.

• $fields – Un simple champ texte ou un tableau de champs à inclure dans le retour.

• $order – Chaîne SQL des conditions ORDER BY.

• $limit – SQL LIMIT déclaration.

• $page – pour accéder aux resultats paginés.

• $recursive – Nombre du niveau de profondeur pour la récursivité des models associés.

La méthode children prend la clé primaire (l’id d’une ligne) et retourne les enfants (children), par défaut dans l’ordre d’apparition dans l’arbre. Le second paramètre optionnel definit si il faut ou non retourner seulement les enfants directs. En utilisant l’exemple des données de la section précédente:

$allChildren = $this->Category->children(1); // un tableau plat à 11 éléments
// -- ou --
$this->Category->id = 1;
$allChildren = $this->Category->children(); // un tableau plat à 11 éléments

// Ne retourne que les enfants directs
$directChildren = $this->Category->children(1, true); // un tableau plat avec 2 éléments

Note

Si vous voulez un tableau recursif utilisez find('threaded')

childCount($id = null, $direct = false)¶

Comme avec la méthode children, childCount prend la valeur de la clé primaire (l’id) d’une ligne et retourne combien d’enfant elle contient.

Le second paramètre optionnel definit si il faut ou non compter les enfants directs. En reprenant l’exemple ci dessus:

$totalChildren = $this->Category->childCount(1); // retournera 11
// -- ou --
$this->Category->id = 1;
$directChildren = $this->Category->childCount(); //retournera 11

// Seulement les comptes des descendants directs de cette category
$numChildren = $this->Category->childCount(1, true); // retournera 2

generateTreeList($conditions=null, $keyPath=null, $valuePath=null, $spacer= '_', $recursive=null)¶

Paramètres:

• $conditions – Utilise les mêmes conditions qu’un find().

• $keyPath – Chemin du champ à utiliser pour la clé, par exemple « {n}.Post.id.

• $valuePath – Chemin du champ à utiliser pour le label, par exemple « {n}.Post.title ».

• $spacer – La chaîne à utiliser devant chaque élément pour indiquer la profondeur.

• $recursive – Le nombre de niveaux de profondeur pour rechercher les enregistrements associés.

Cette méthode retourne des données similaires à :ref: model-find-list, avec un préfixe en retrait pour montrer la structure de vos données. Voici un exemple de ce à quoi vous attendre comme retour avec cette méthode:

$treelist = $this->Category->generateTreeList();

Sortie:

array(
    [1] =>  "My Categories",
    [2] =>  "_Fun",
    [3] =>  "__Sport",
    [4] =>  "___Surfing",
    [16] => "___Skating",
    [6] =>  "__Friends",
    [7] =>  "___Gerald",
    [8] =>  "___Gwendolyn",
    [9] =>  "_Work",
    [13] => "__Trips",
    [14] => "___National",
    [15] => "___International",
    [17] => "Other People's Categories",
    [5] =>  "_Extreme fishing"
)

formatTreeList($results, $options=array())¶

Nouveau dans la version 2.7.

Paramètres:

• $results – Résultats de l’appel de find(“all”).

• $options – Options à passer.

Cette méthode va retourner des données similaires à find(“list”) mais avec un préfix imbriqué qui est spécifié dans l’option spacer pour montrer la structure de vos données.

Les options supportées sont:

• keyPath: Un chemin vers la clé, par ex « {n}.Post.id ».

• valuePath: Un chemin vers la valeur, par ex « {n}.Post.title ».

• spacer: Le caractère ou les caractères qui seront répétés.

Un exemple serait:

$results = $this->Category->find('all');
$results = $this->Category->formatTreeList($results, array(
    'spacer' => '--'
));

getParentNode()¶

Cette fonction comme son nom l’indique, donne en retour le noeud parent d’un nœud, ou false si le noeud n’a pas de parent (c’est le nœud racine). Par exemple:

$parent = $this->Category->getParentNode(2); //<- id de fun
// $parent contient toutes les catégories

getPath($id = null, $fields = null, $recursive = null)¶

Le “path” (chemin) quand vous vous réferez à des données hiérarchiques, c’est le moyen retrouver où vous êtes depuis le sommet. Par exemple le path (chemin) de la catégorie « International » est:

• My Categories

  • …

  • Work

  • Trips

    • …

    • International

En utilisant l’id de « international », getPath retournera chacun des parents rencontrés (depuis le haut):

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

// contenu de $parents
array(
    [0] =>  array(
      'Category' => array('id' => 1, 'name' => 'My Categories', ..)
    ),
    [1] =>  array(
      'Category' => array('id' => 9, 'name' => 'Work', ..)
    ),
    [2] =>  array(
      'Category' => array('id' => 13, 'name' => 'Trips', ..)
    ),
    [3] =>  array(
      'Category' => array('id' => 15, 'name' => 'International', ..)
    ),
)