1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139

<?php

/*
 * (c) Copyright 2008 Hewlett-Packard Development Company, L.P.
 * 
 * Permission is hereby granted, free of charge, to any person
 * obtaining a copy of this software and associated documentation
 * files (the "Software"), to deal in the Software without
 * restriction, including without limitation the rights to use,
 * copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following
 * conditions:
 * 
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
 * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
 * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 * OTHER DEALINGS IN THE SOFTWARE.
 * 
 * http://code.google.com/p/gagawa/
 * 
 * AUTHORS:
 *   Mark Kolich
 *   Chris Friedrich
 * 
 */

class FertileNode extends Node {

	private $children_;

	/**
	 * Create a new FertileNode with the given tag.  The
	 * tag cannot be NULL.
	 */
	public function __construct ( $tag = NULL ) {

		if(empty($tag)){
			throw new Exception( "FertileNode's must have a tag " .
						"type!" );
		}

		parent::__construct( $tag );
		$this->children_ = array();

	}

	/**
	 * Add's a child to this FertileNode.  The child to
	 * add cannot be null.
	 */	
	public function appendChild ( $childNode = NULL ) {

		if(empty($childNode)){
			throw new Exception( "You cannot append an empty " .
						"child node!" );
		}

		$childNode->setParent( $this );
		$this->children_[] = $childNode;
		return $this;
		
	}

	/**
	 * Removes the first instance of child from this
	 * FertileNode.  Once the first instance of the child
	 * is removed, this function will return.  It returns
	 * true if a child was removed and false if no child
	 * was removed.
	 */
	public function removeChild ( $childNode = NULL ) {

		if(empty($childNode)){
			throw new Exception( "You cannot remove an empty " .
						"child node!" );
		}

		for ( $i = 0; $i < count($this->children_); $i++ ) {
			$child = $this->children_[$i];
			if($child===$childNode){
				unset( $this->children_[$i] );
				return true;
			}
		}

		return false;

	}

	/**
	 * Removes all children attached to this FertileNode.
	 */
	public function removeChildren ( ) {
		unset( $this->children_ );
		$this->children_ = array();
	}

	/**
	 * Returns an array of all children attached to
	 * this FertileNode.
	 */
	public function getChildren ( ) {
		return $this->children_;
	}

	/**
	 * Gets a child of this FertileNode at given
	 * index.  If no index is passed in, getChild()
	 * will return the child at index zero (0).
	 */
	public function getChild ( $index = 0 ) {
		return $this->children_[$index];
	}

	/* @Override */
	public function write ( ) {
		
		$buffer = $this->writeOpen();		
		foreach ( $this->children_ as $child ) {
			$buffer .= $child->write();
		
		}		
		$buffer .= $this->writeClose();
		
		return $buffer;
	
	}

} /* FertileNode */

?>