123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533 |
- <?php
- namespace PicoFeed\Parser;
- /**
- * Feed Item.
- *
- * @package PicoFeed\Parser
- * @author Frederic Guillot
- */
- class Item
- {
- /**
- * List of known RTL languages.
- *
- * @var string[]
- */
- public $rtl = array(
- 'ar', // Arabic (ar-**)
- 'fa', // Farsi (fa-**)
- 'ur', // Urdu (ur-**)
- 'ps', // Pashtu (ps-**)
- 'syr', // Syriac (syr-**)
- 'dv', // Divehi (dv-**)
- 'he', // Hebrew (he-**)
- 'yi', // Yiddish (yi-**)
- );
- /**
- * Item id.
- *
- * @var string
- */
- public $id = '';
- /**
- * Item title.
- *
- * @var string
- */
- public $title = '';
- /**
- * Item url.
- *
- * @var string
- */
- public $url = '';
- /**
- * Item author.
- *
- * @var string
- */
- public $author = '';
- /**
- * Item date.
- *
- * @var \DateTime
- */
- public $date = null;
- /**
- * Item published date.
- *
- * @var \DateTime
- */
- public $publishedDate = null;
- /**
- * Item updated date.
- *
- * @var \DateTime
- */
- public $updatedDate = null;
- /**
- * Item content.
- *
- * @var string
- */
- public $content = '';
- /**
- * Item enclosure url.
- *
- * @var string
- */
- public $enclosureUrl = '';
- /**
- * Item enclusure type.
- *
- * @var string
- */
- public $enclosureType = '';
- /**
- * Item language.
- *
- * @var string
- */
- public $language = '';
- /**
- * Item categories.
- *
- * @var array
- */
- public $categories = array();
- /**
- * Raw XML.
- *
- * @var \SimpleXMLElement
- */
- public $xml;
- /**
- * List of namespaces.
- *
- * @var array
- */
- public $namespaces = array();
- /**
- * Check if a XML namespace exists
- *
- * @access public
- * @param string $namespace
- * @return bool
- */
- public function hasNamespace($namespace)
- {
- return array_key_exists($namespace, $this->namespaces);
- }
- /**
- * Get specific XML tag or attribute value.
- *
- * @param string $tag Tag name (examples: guid, media:content)
- * @param string $attribute Tag attribute
- *
- * @return array|false Tag values or error
- */
- public function getTag($tag, $attribute = '')
- {
- if ($attribute !== '') {
- $attribute = '/@'.$attribute;
- }
- $query = './/'.$tag.$attribute;
- $elements = XmlParser::getXPathResult($this->xml, $query, $this->namespaces);
- if ($elements === false) { // xPath error
- return false;
- }
- return array_map(function ($element) { return (string) $element;}, $elements);
- }
- /**
- * Return item information.
- *
- * @return string
- */
- public function __toString()
- {
- $output = '';
- foreach (array('id', 'title', 'url', 'language', 'author', 'enclosureUrl', 'enclosureType') as $property) {
- $output .= 'Item::'.$property.' = '.$this->$property.PHP_EOL;
- }
- $publishedDate = $this->publishedDate != null ? $this->publishedDate->format(DATE_RFC822) : null;
- $updatedDate = $this->updatedDate != null ? $this->updatedDate->format(DATE_RFC822) : null;
- $categoryString = $this->categories != null ? implode(',', $this->categories) : null;
- $output .= 'Item::date = '.$this->date->format(DATE_RFC822).PHP_EOL;
- $output .= 'Item::publishedDate = '.$publishedDate.PHP_EOL;
- $output .= 'Item::updatedDate = '.$updatedDate.PHP_EOL;
- $output .= 'Item::isRTL() = '.($this->isRTL() ? 'true' : 'false').PHP_EOL;
- $output .= 'Item::categories = ['.$categoryString.']'.PHP_EOL;
- $output .= 'Item::content = '.strlen($this->content).' bytes'.PHP_EOL;
- return $output;
- }
- /**
- * Get title.
- *
- * @return string
- */
- public function getTitle()
- {
- return $this->title;
- }
- /**
- * Get URL
- *
- * @access public
- * @return string
- */
- public function getUrl()
- {
- return $this->url;
- }
- /**
- * Set URL
- *
- * @access public
- * @param string $url
- * @return Item
- */
- public function setUrl($url)
- {
- $this->url = $url;
- return $this;
- }
- /**
- * Get id.
- *
- * @return string
- */
- public function getId()
- {
- return $this->id;
- }
- /**
- * Get date.
- *
- * @return \DateTime
- */
- public function getDate()
- {
- return $this->date;
- }
- /**
- * Get published date.
- *
- * @return \DateTime
- */
- public function getPublishedDate()
- {
- return $this->publishedDate;
- }
- /**
- * Get updated date.
- *
- * @return \DateTime
- */
- public function getUpdatedDate()
- {
- return $this->updatedDate;
- }
- /**
- * Get content.
- *
- * @return string
- */
- public function getContent()
- {
- return $this->content;
- }
- /**
- * Set content
- *
- * @access public
- * @param string $value
- * @return Item
- */
- public function setContent($value)
- {
- $this->content = $value;
- return $this;
- }
- /**
- * Get enclosure url.
- *
- * @return string
- */
- public function getEnclosureUrl()
- {
- return $this->enclosureUrl;
- }
- /**
- * Get enclosure type.
- *
- * @return string
- */
- public function getEnclosureType()
- {
- return $this->enclosureType;
- }
- /**
- * Get language.
- *
- * @return string
- */
- public function getLanguage()
- {
- return $this->language;
- }
- /**
- * Get categories.
- *
- * @return array
- */
- public function getCategories()
- {
- return $this->categories;
- }
- /**
- * Get author.
- *
- * @return string
- */
- public function getAuthor()
- {
- return $this->author;
- }
- /**
- * Return true if the item is "Right to Left".
- *
- * @return bool
- */
- public function isRTL()
- {
- return Parser::isLanguageRTL($this->language);
- }
- /**
- * Set item id.
- *
- * @param string $id
- * @return Item
- */
- public function setId($id)
- {
- $this->id = $id;
- return $this;
- }
- /**
- * Set item title.
- *
- * @param string $title
- * @return Item
- */
- public function setTitle($title)
- {
- $this->title = $title;
- return $this;
- }
- /**
- * Set author.
- *
- * @param string $author
- * @return Item
- */
- public function setAuthor($author)
- {
- $this->author = $author;
- return $this;
- }
- /**
- * Set item date.
- *
- * @param \DateTime $date
- * @return Item
- */
- public function setDate($date)
- {
- $this->date = $date;
- return $this;
- }
- /**
- * Set item published date.
- *
- * @param \DateTime $publishedDate
- * @return Item
- */
- public function setPublishedDate($publishedDate)
- {
- $this->publishedDate = $publishedDate;
- return $this;
- }
- /**
- * Set item updated date.
- *
- * @param \DateTime $updatedDate
- * @return Item
- */
- public function setUpdatedDate($updatedDate)
- {
- $this->updatedDate = $updatedDate;
- return $this;
- }
- /**
- * Set enclosure url.
- *
- * @param string $enclosureUrl
- * @return Item
- */
- public function setEnclosureUrl($enclosureUrl)
- {
- $this->enclosureUrl = $enclosureUrl;
- return $this;
- }
- /**
- * Set enclosure type.
- *
- * @param string $enclosureType
- * @return Item
- */
- public function setEnclosureType($enclosureType)
- {
- $this->enclosureType = $enclosureType;
- return $this;
- }
- /**
- * Set item language.
- *
- * @param string $language
- * @return Item
- */
- public function setLanguage($language)
- {
- $this->language = $language;
- return $this;
- }
- /**
- * Set item categories.
- *
- * @param array $categories
- * @return Item
- */
- public function setCategories($categories)
- {
- $this->categories = $categories;
- return $this;
- }
- /**
- * Set item categories from xml.
- *
- * @param |SimpleXMLElement[] $categories
- * @return Item
- */
- public function setCategoriesFromXml($categories)
- {
- if ($categories !== false) {
- $this->setCategories(
- array_map(
- function ($element) {
- return trim((string) $element);
- },
- $categories
- )
- );
- }
-
- return $this;
- }
- /**
- * Set raw XML.
- *
- * @param \SimpleXMLElement $xml
- * @return Item
- */
- public function setXml($xml)
- {
- $this->xml = $xml;
- return $this;
- }
- /**
- * Get raw XML.
- *
- * @return \SimpleXMLElement
- */
- public function getXml()
- {
- return $this->xml;
- }
- /**
- * Set XML namespaces.
- *
- * @param array $namespaces
- * @return Item
- */
- public function setNamespaces($namespaces)
- {
- $this->namespaces = $namespaces;
- return $this;
- }
- /**
- * Get XML namespaces.
- *
- * @return array
- */
- public function getNamespaces()
- {
- return $this->namespaces;
- }
- }
|