Tree (Árvore)¶

Adicionar dados¶

Na sessão anterior, nos usamos uma data existente e verificamos como ficou a hirearquia usando o méotodo generatetreelist. No entando, geralmente é necessário você adicionar os dados da mesma maneira que qualquer outro modelo. Por exemplo:

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

Quando usamos o tree behavior isto não é necessário fazer nada a mais, apenas setar o parent_id e o tree behavior vai cudar do resto. Se você não setar o parent_id, o tree behavior vai adicionar na árvore uma nova entrada no nível do topo:

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

Rodando os dois códigos acima, você ira receber os seguintes resultados:

• Minhas Categorias

  • Divertidos

    • Esportes

      • Surf

      • Padel

      • Skating New

    • Amigos

      • Thiago

      • Geraldo

  • Trabalho

    • Relátorios

      • Anual

      • Status

    • Viagens

      • Nacionais

      • Internacionais

• Nova Categoria New

Modificando dados¶

Modificar dados é tão transparente quanto adicionar novos dados. Se você modificar alguma coisa, mas não quiser alterar o campo parent_id - a estrutura dos dados vai permanecer inalterada. Por exemplo:

// pseudo código de controller
$this->Category->id = 5; // id de Extreme knitting
$this->Category->save(array('name' =>'Extreme fishing'));

O código acima não afeta o campo parent_id - mesmo que o o parent_id seja incluído nos dados passados para o método save se o valor não mudar, a estrutura dos dados também não mudará. Portanto a árvore de dados deve esta assim:

• My Categories

  • Fun

    • Sport

      • Surfing

      • Extreme fishing Atualizado

      • Skating

    • Friends

      • Gerald

      • Gwendolyn

  • Work

    • Reports

      • Annual

      • Status

    • Trips

      • National

      • International

• Other People’s Categories

Mover dados na árvore também é uma tarefa simples. Vamos dizer que Extreme fishing não pertence mais a Sport, mas ao invés, deve ser alocada dentro de Other People’s Categories. Com o seguinte código:

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

Como o esperado a estrutura foi modificada para:

• My Categories

  • Fun

    • Sport

      • Surfing

      • Skating

    • Friends

      • Gerald

      • Gwendolyn

  • Work

    • Reports

      • Annual

      • Status

    • Trips

      • National

      • International

• Other People’s Categories

  • Extreme fishing Movida

Deletando dados¶

O tree behaviour provem maneiras de deletar dados. Para começar podemos fazer um simples exemplo para testar; vamos dizer que a categoria «relatórios», não é tão usada. Para remover isso e todas os filhos que este tem apenas chame o delete igual usamos para qualquer modelo. Para exemplificar segue o código:

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

A árvore de categoria deve ficar como em baixo:

• Minhas Categorias

  • Divertidos

    • Esportes

      • Surf

      • Padel

      • Skating

    • Amigos

      • Thiago

      • Geraldo

  • Trabalho

    • Viagens

      • Nacionais

      • Internacionais

• Nova Categoria

Requisitando e usando seus dados¶

Usar e manipular dados hierárquicos pode ser um negócio de artimanhas. Em adição aos métodos core find, com o tree behavior existe um pouco mais de permutações orientadas a árvore a sua disposição.

A maioria dos métodos do tree behavior retornam e dependem dos dados armazenados no campo lft. Se você chamar o método find() e não ordenar pelo campo lft, ou chamar um método do tree behavior e especificar um sort order, você poderá receber resultados indesejados.

$allChildren = $this->Category->children(1); // um array plano com 11 itens
// -- ou --
$this->Category->id = 1;
$allChildren = $this->Category->children(); // um array plano com 11 itens

// Somente retorna filhos diretos
$directChildren = $this->Category->children(1, true); // um array plano com 2 itens

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

// Só conta os descendentes diretos desta categoria
$numChildren = $this->Category->childCount(1, true); // resultara 2

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"
)

$parent = $this->Category->getparentnode(2); //<- id for fun
// $parent contains All categories

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

// contents of $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', ..)),
)

moveDown¶

Utilizado para mover um único nó para baixo da árvore. Você precisará fornecer a identificação do elemento a ser movido e um número positivo de quantas posições o nó deve ser movido para baixo. Todos nós filho para o nó especificado também será movido.

Aqui está um exemplo de uma ação do controlador (em um controlador chamado Categorias) que move um nó especificado pela árvore:

function movedown($name = null, $delta = null) {
        $cat = $this->Category->findByName($name);
        if (empty($cat)) {
            $this->Session->setFlash('Não existe uma categoria chamada ' . $name);
            $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('Por favor, forneça o número de posições do campo para ser  movido para baixo.');
        }

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

Por exemplo, se você deseja mover a categoria «Sport» uma posição abaixo, você terá que pedir: /categories/movedown/Sport/1.

moveUp¶

Utilizado para mover um único nó na árvore. Você precisará fornecer a identificação do elemento a ser movido e um número positivo de quantas posições o nó deve ser movida para cima. Todos nós filho também serão movidos.

Aqui está um exemplo de uma ação do controlador (em um controlador chamado Categorias) que move um nó na árvore:

function moveup($name = null, $delta = null){
        $cat = $this->Category->findByName($name);
        if (empty($cat)) {
            $this->Session->setFlash('Não existe uma categoria chamada ' . $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('Por favor, forneça um número de posições que a  categoria deve ser deslocado para cima.');
        }

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

    }

Por exemplo, se você gostaria de mover a categoria «Gwendolyn» até uma posição que você gostaria de pedir /categories/moveup/Gwendolyn/1. Agora, a ordem de Amigos sera Gwendolyn, Gerald.

removeFromTree¶

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

Use este método se quiser apagar ou mover um nó, mas manter a sua sub-árvore, que será reparentado um nível superior. Ele oferece mais controle do que `delete() </pt/view/690/delete>`_, que para um modelo com o comportamento árvore irá remover o nó especificado e todos os seus filhos.

Tendo a seguinte árvore como ponto de partida:

• My Categories

  • Fun

    • Sport

      • Surfing

      • Extreme knitting

      • Skating

Executando o código a seguir com o id “Sport”

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

O nó do Sport irá tornar-se um nó de nível superior:

• My Categories

  • Fun

    • Surfing

    • Extreme knitting

    • Skating

• Sport Movido

Isso demonstra o comportamento padrão do removeFromTree de mover o nó para não ter nenhum pai, e reparentear todos os filhos.

Se, contudo, o seguinte trecho de código foi utilizado com o id “Sport”

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

A árvore se tornaria

• My Categories

  • Fun

    • Surfing

    • Extreme knitting

    • Skating

Isso demonstra o uso alternativo para removeFromTree, os filhos foram reparentados e “Sport” foi excluido.

reorder¶

This method can be used to sort hierarchical data.