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 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 <?php
/**
*
*
*
* Generated by <a href="http://enunciate.codehaus.org">Enunciate</a>.
*
*/
namespace Gedcomx\Links;
use Gedcomx\Common\ExtensibleData;
/**
* An data type that supports hypermedia controls (i.e. links).
*/
class HypermediaEnabledData extends ExtensibleData implements SupportsLinks
{
/**
* The list of hypermedia links. Links are not specified by GEDCOM X core, but as extension elements by GEDCOM X RS.
*
* @var Link[]
*/
private $links;
/**
* Constructs a HypermediaEnabledData from a (parsed) JSON hash
*
* @param mixed $o Either an array (JSON) or an XMLReader.
*
* @throws \Exception
*/
public function __construct($o = null)
{
if (is_array($o)) {
$this->initFromArray($o);
}
else if ($o instanceof \XMLReader) {
$success = true;
while ($success && $o->nodeType != \XMLReader::ELEMENT) {
$success = $o->read();
}
if ($o->nodeType != \XMLReader::ELEMENT) {
throw new \Exception("Unable to read XML: no start element found.");
}
$this->initFromReader($o);
}
}
/**
* The list of hypermedia links. Links are not specified by GEDCOM X core, but as extension elements by GEDCOM X RS.
*
* @return Link[]
*/
public function getLinks()
{
return $this->links;
}
/**
* The list of hypermedia links. Links are not specified by GEDCOM X core, but as extension elements by GEDCOM X RS.
*
* @param Link[] $links
*/
public function setLinks(array $links)
{
$this->links = $links;
}
/**
* Returns the associative array for this HypermediaEnabledData
*
* @return array
*/
public function toArray()
{
$a = parent::toArray();
if ($this->links) {
$ab = array();
foreach ($this->links as $i => $x) {
$ab[$i] = $x->toArray();
}
$a['links'] = $ab;
}
return $a;
}
/**
* Initializes this HypermediaEnabledData from an associative array
*
* @param array $o
*/
public function initFromArray(array $o)
{
$this->links = array();
if (isset($o['links'])) {
foreach ($o['links'] as $i => $x) {
if( ! array_key_exists("rel", $x) ){
$x["rel"] = $i;
}
$this->links[$i] = new Link($x);
}
unset($o['links']);
}
parent::initFromArray($o);
}
/**
* Sets a known child element of HypermediaEnabledData from an XML reader.
*
* @param \XMLReader $xml The reader.
* @return bool Whether a child element was set.
*/
protected function setKnownChildElement(\XMLReader $xml) {
$happened = parent::setKnownChildElement($xml);
if ($happened) {
return true;
}
else if (($xml->localName == 'link') && ($xml->namespaceURI == 'http://gedcomx.org/v1/')) {
$child = new Link($xml);
if (!isset($this->links)) {
$this->links = array();
}
array_push($this->links, $child);
$happened = true;
}
return $happened;
}
/**
* Sets a known attribute of HypermediaEnabledData from an XML reader.
*
* @param \XMLReader $xml The reader.
* @return bool Whether an attribute was set.
*/
protected function setKnownAttribute(\XMLReader $xml) {
if (parent::setKnownAttribute($xml)) {
return true;
}
return false;
}
/**
* Writes the contents of this HypermediaEnabledData to an XML writer. The startElement is expected to be already provided.
*
* @param \XMLWriter $writer The XML writer.
*/
public function writeXmlContents(\XMLWriter $writer)
{
parent::writeXmlContents($writer);
if ($this->links) {
foreach ($this->links as $i => $x) {
$writer->startElementNs('gx', 'link', null);
$x->writeXmlContents($writer);
$writer->endElement();
}
}
}
/**
* @param \Gedcomx\Links\Link $link
*/
public function addLink(Link $link)
{
$this->links[] = $link;
}
/**
* Add a hypermedia link relationship
*
* @param string $rel see Gedcom\Rs\Client\Rel
* @param string $href The target URI.
*/
public function addLinkRelation($rel, $href)
{
$this->links[] = new Link( array(
"rel" => $rel,
"href" => $href
));
}
/**
* Add a templated link.
*
* @param string $rel see Gedcom\Rs\Client\Rel
* @param string $template The link template.
*/
public function addTemplatedLink($rel, $template)
{
$this->links[] = new Link( array(
"rel" => $rel,
"template" => $template
));
}
/**
* Get a link by its rel.
*
* @param string $rel see Gedcom\Rs\Client\Rel
*
* @return Link
*/
public function getLink($rel)
{
if( $this->links != null ){
foreach ( $this->links as $idx => $link ) {
if ( $link->getRel() == $rel ) {
return $link;
}
}
}
return null;
}
/**
* Get a list of links by rel.
*
* @param string $rel see Gedcom\Rs\Client\Rel
*
* @return Link[]
*/
public function getLinksByRel($rel)
{
$links = array();
foreach ( $this->links as $link ) {
if ($link->getRel() == $rel) {
$links[] = $rel;
}
}
return $links;
}
}