Version 1
[yaffs-website] / vendor / zendframework / zend-feed / src / Reader / Extension / AbstractEntry.php
diff --git a/vendor/zendframework/zend-feed/src/Reader/Extension/AbstractEntry.php b/vendor/zendframework/zend-feed/src/Reader/Extension/AbstractEntry.php
new file mode 100644 (file)
index 0000000..54df33e
--- /dev/null
@@ -0,0 +1,233 @@
+<?php
+/**
+ * Zend Framework (http://framework.zend.com/)
+ *
+ * @link      http://github.com/zendframework/zf2 for the canonical source repository
+ * @copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license   http://framework.zend.com/license/new-bsd New BSD License
+ */
+
+namespace Zend\Feed\Reader\Extension;
+
+use DOMDocument;
+use DOMElement;
+use DOMXPath;
+use Zend\Feed\Reader;
+
+abstract class AbstractEntry
+{
+    /**
+     * Feed entry data
+     *
+     * @var array
+     */
+    protected $data = [];
+
+    /**
+     * DOM document object
+     *
+     * @var DOMDocument
+     */
+    protected $domDocument = null;
+
+    /**
+     * Entry instance
+     *
+     * @var DOMElement
+     */
+    protected $entry = null;
+
+    /**
+     * Pointer to the current entry
+     *
+     * @var int
+     */
+    protected $entryKey = 0;
+
+    /**
+     * XPath object
+     *
+     * @var DOMXPath
+     */
+    protected $xpath = null;
+
+    /**
+     * XPath query
+     *
+     * @var string
+     */
+    protected $xpathPrefix = '';
+
+    /**
+     * Set the entry DOMElement
+     *
+     * Has side effect of setting the DOMDocument for the entry.
+     *
+     * @param  DOMElement $entry
+     * @return AbstractEntry
+     */
+    public function setEntryElement(DOMElement $entry)
+    {
+        $this->entry = $entry;
+        $this->domDocument = $entry->ownerDocument;
+        return $this;
+    }
+
+    /**
+     * Get the entry DOMElement
+     *
+     * @return DOMElement
+     */
+    public function getEntryElement()
+    {
+        return $this->entry;
+    }
+
+    /**
+     * Set the entry key
+     *
+     * @param  string $entryKey
+     * @return AbstractEntry
+     */
+    public function setEntryKey($entryKey)
+    {
+        $this->entryKey = $entryKey;
+        return $this;
+    }
+
+    /**
+     * Get the DOM
+     *
+     * @return DOMDocument
+     */
+    public function getDomDocument()
+    {
+        return $this->domDocument;
+    }
+
+    /**
+     * Get the Entry's encoding
+     *
+     * @return string
+     */
+    public function getEncoding()
+    {
+        $assumed = $this->getDomDocument()->encoding;
+        return $assumed;
+    }
+
+    /**
+     * Set the entry type
+     *
+     * Has side effect of setting xpath prefix
+     *
+     * @param  string $type
+     * @return AbstractEntry
+     */
+    public function setType($type)
+    {
+        if (null === $type) {
+            $this->data['type'] = null;
+            return $this;
+        }
+
+        $this->data['type'] = $type;
+        if ($type === Reader\Reader::TYPE_RSS_10
+            || $type === Reader\Reader::TYPE_RSS_090
+        ) {
+            $this->setXpathPrefix('//rss:item[' . ((int)$this->entryKey + 1) . ']');
+            return $this;
+        }
+
+        if ($type === Reader\Reader::TYPE_ATOM_10
+            || $type === Reader\Reader::TYPE_ATOM_03
+        ) {
+            $this->setXpathPrefix('//atom:entry[' . ((int)$this->entryKey + 1) . ']');
+            return $this;
+        }
+
+        $this->setXpathPrefix('//item[' . ((int)$this->entryKey + 1) . ']');
+        return $this;
+    }
+
+    /**
+     * Get the entry type
+     *
+     * @return string
+     */
+    public function getType()
+    {
+        $type = $this->data['type'];
+        if ($type === null) {
+            $type = Reader\Reader::detectType($this->getEntryElement(), true);
+            $this->setType($type);
+        }
+
+        return $type;
+    }
+
+    /**
+     * Set the XPath query
+     *
+     * @param  DOMXPath $xpath
+     * @return AbstractEntry
+     */
+    public function setXpath(DOMXPath $xpath)
+    {
+        $this->xpath = $xpath;
+        $this->registerNamespaces();
+        return $this;
+    }
+
+    /**
+     * Get the XPath query object
+     *
+     * @return DOMXPath
+     */
+    public function getXpath()
+    {
+        if (! $this->xpath) {
+            $this->setXpath(new DOMXPath($this->getDomDocument()));
+        }
+        return $this->xpath;
+    }
+
+    /**
+     * Serialize the entry to an array
+     *
+     * @return array
+     */
+    public function toArray()
+    {
+        return $this->data;
+    }
+
+    /**
+     * Get the XPath prefix
+     *
+     * @return string
+     */
+    public function getXpathPrefix()
+    {
+        return $this->xpathPrefix;
+    }
+
+    /**
+     * Set the XPath prefix
+     *
+     * @param  string $prefix
+     * @return AbstractEntry
+     */
+    public function setXpathPrefix($prefix)
+    {
+        $this->xpathPrefix = $prefix;
+        return $this;
+    }
+
+    /**
+     * Register XML namespaces
+     *
+     * @return void
+     */
+    abstract protected function registerNamespaces();
+}