Fortgeschrittene Anwendung der Tree Komponente

ralle — Wed, 04 Feb 2009 15:41:38 +0000

Das Tree Behaviour von CakePHP nutzt die Modified Preorder Tree Traversal (MPTT) Technik. Im Gegensatz zur hierarchischen Speichermethode für Bäume, werden hierbei Teilmengen gebildet und durch die Parameter “left” und “right” eingegrenzt. Dieser Artikel enthält eine Grafik die dass Prinzip sehr schön verdeutlicht. Um an eine Teilmenge in Form eines Astes oder “Nodes” zu gelangen, werden einfach die Parameter ‘left’ und ‘right’ genutzt.

Mit den eingebauten Methoden des Behaviours Tree stößt man relativ schnell an Grenzen, deswegen ist das Wissen um die einfache Handhabung der Daten sehr wichtig. Um zum Beispiel an alle Kind Elemente eines Baumes zu gelangen bietet Tree die Methode children() an. Was aber wenn nur die Children geholt werden sollen deren Name mit A beginnt, oder dem status active oder die Daten sollen in eine Pagination geschossen werden? Ganz klar, die Daten müssen mit der find() Methode des Models geholt werden. Hier ein wenig Sample Code für eine Tree Pagination:


class UsersController extends AppController {
 
	var $name = 'Users';
 
	function search(){
 
		// Wir holen den gewünschten Eintrag aus der DB
		// anhand des Primärschlüssels
		$user = $this->User->findById(1);
 
		// Wir nutzen dessen left und right Werte um ´
		// den Ast einzugrenzen
		$search_options = array(
			'User.lft > ' => $user['lft'],
			'User.rght < ' => $user['rght']
		);
 
		// Fügen hier noch die besondere Suchbedingung ein
		$search_options['User.lastname LIKE '] = ."a%";
 
		// Und übergeben den Rest dem Pagination Helper
		$this->set('users', $this->paginate('User', $search_options));		
	}
}

So einfach ist das…im Prinzip…

Ein weiterer guter Artikel der sich mit dem Thema beschäftigt findet sich hier. Es gibt auch eine sehr einfache Formel um die Anzahl der Kinder eines Knotens zu ermitteln, dazu ist kein SQL notwendig und deswegen hervorragend für die Verwendung innerhalb von Views geeignet.

Anzahl Nodes = (right – left – 1) / 2

Verwirrende Signatur von Tree generatetreelist()

ralle — Mon, 02 Feb 2009 10:40:27 +0000

Das Behaviour Tree von CakePHP ist schon recht nützlich, aber mitunter ist CakePHP nicht sooo gut dokumentiert. Die Doku sagt die Methode generatetreelist() hätte folgende Signatur:

$this->Category->generatetreelist (
    &$model,
    $conditions=null,
    $keyPath=null,
    $valuePath=null,
    $spacer= '_', 
    $recursive=null
);

Ruft man die Funktion aber so wie inder Doku beschrieben auf:

$this->Category->generatetreelist(
    null,
    null,
    null,
    '--'
);

erhält man nicht das gewünschte Ergebnis. Das Problem liegt im ersten Parameter. Diese ist für den Aufruf irrelevant und muss ignogiert werden. Die Methode muss so aufgerufen werden als hätte Sie diese Signatur:

$this->Category->generatetreelist (
    $conditions=null,
    $keyPath=null,
    $valuePath=null,
    $spacer= '_',
    $recursive=null
);

Wobei der erste Parameter also schon das Conditions Array ist.

Wenig intuitiv mutet auch die Auswahl der Felder für key und value an:

$this->Category->generatetreelist(
    null,
    '{n}.Category.email',
    '{n}.Category.title',
    '-'
);

Ja, richtig das Konstukt {n}. muss drin sein. Ein Blick in den Quelltext der Methode macht dass deutlich:

function generatetreelist(&$Model, $conditions = null, $keyPath = null, $valuePath = null, $spacer = '_', $recursive = null) {
 
	$overrideRecursive = $recursive;
	extract($this->settings[$Model->alias]);
	if (!is_null($overrideRecursive)) {
		$recursive = $overrideRecursive;
	}
 
	if ($keyPath == null && $valuePath == null && $Model->hasField($Model->displayField)) {
		$fields = array($Model->primaryKey, $Model->displayField, $left, $right);
	} else {
		$fields = null;
	}
 
	if ($keyPath == null) {
		$keyPath = '{n}.' . $Model->alias . '.' . $Model->primaryKey;
	}
 
	if ($valuePath == null) {
		$valuePath = array('{0}{1}', '{n}.tree_prefix', '{n}.' . $Model->alias . '.' . $Model->displayField);
	} elseif (is_string($valuePath)) {
		$valuePath = array('{0}{1}', '{n}.tree_prefix', $valuePath);
	} else {
		$valuePath[0] = '{' . (count($valuePath) - 1) . '}' . $valuePath[0];
		$valuePath[] = '{n}.tree_prefix';
	}
	$order = $Model->alias . '.' . $left . ' asc';
	$results = $Model->find('all', compact('conditions', 'fields', 'order', 'recursive'));
	$stack = array();
 
	foreach ($results as $i => $result) {
		while ($stack && ($stack[count($stack) - 1] < $result[$Model->alias][$right])) {
			array_pop($stack);
		}
		$results[$i]['tree_prefix'] = str_repeat($spacer,count($stack));
		$stack[] = $result[$Model->alias][$right];
	}
	if (empty($results)) {
		return array();
	}
	return Set::combine($results, $keyPath, $valuePath);
}

PHP Log » Tree

Fortgeschrittene Anwendung der Tree Komponente

Verwirrende Signatur von Tree generatetreelist()