Source of file Deleted.php
Size: 5,814 Bytes - Last Modified: 2014-03-12T23:21:18+01:00
/home/theseer/Downloads/ZendFramework-2.3.0/library/Zend/Feed/Writer/Deleted.php
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238 | <?php /** * Zend Framework (http://framework.zend.com/) * * @link http://github.com/zendframework/zf2 for the canonical source repository * @copyright Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com) * @license http://framework.zend.com/license/new-bsd New BSD License */ namespace Zend\Feed\Writer; use DateTime; use Zend\Feed\Uri; /** */ class Deleted { /** * Internal array containing all data associated with this entry or item. * * @var array */ protected $data = array(); /** * Holds the value "atom" or "rss" depending on the feed type set when * when last exported. * * @var string */ protected $type = null; /** * Set the feed character encoding * * @param $encoding * @throws Exception\InvalidArgumentException * @return string|null * @return Deleted */ public function setEncoding($encoding) { if (empty($encoding) || !is_string($encoding)) { throw new Exception\InvalidArgumentException('Invalid parameter: parameter must be a non-empty string'); } $this->data['encoding'] = $encoding; return $this; } /** * Get the feed character encoding * * @return string|null */ public function getEncoding() { if (!array_key_exists('encoding', $this->data)) { return 'UTF-8'; } return $this->data['encoding']; } /** * Unset a specific data point * * @param string $name * @return Deleted */ public function remove($name) { if (isset($this->data[$name])) { unset($this->data[$name]); } return $this; } /** * Set the current feed type being exported to "rss" or "atom". This allows * other objects to gracefully choose whether to execute or not, depending * on their appropriateness for the current type, e.g. renderers. * * @param string $type * @return Deleted */ public function setType($type) { $this->type = $type; return $this; } /** * Retrieve the current or last feed type exported. * * @return string Value will be "rss" or "atom" */ public function getType() { return $this->type; } /** * Set reference * * @param $reference * @throws Exception\InvalidArgumentException * @return Deleted */ public function setReference($reference) { if (empty($reference) || !is_string($reference)) { throw new Exception\InvalidArgumentException('Invalid parameter: reference must be a non-empty string'); } $this->data['reference'] = $reference; return $this; } /** * @return string */ public function getReference() { if (!array_key_exists('reference', $this->data)) { return null; } return $this->data['reference']; } /** * Set when * * @param null|string|DateTime $date * @throws Exception\InvalidArgumentException * @return Deleted */ public function setWhen($date = null) { if ($date === null) { $date = new DateTime(); } elseif (is_int($date)) { $date = new DateTime('@' . $date); } elseif (!$date instanceof DateTime) { throw new Exception\InvalidArgumentException('Invalid DateTime object or UNIX Timestamp' . ' passed as parameter'); } $this->data['when'] = $date; return $this; } /** * @return DateTime */ public function getWhen() { if (!array_key_exists('when', $this->data)) { return null; } return $this->data['when']; } /** * Set by * * @param array $by * @throws Exception\InvalidArgumentException * @return Deleted */ public function setBy(array $by) { $author = array(); if (!array_key_exists('name', $by) || empty($by['name']) || !is_string($by['name']) ) { throw new Exception\InvalidArgumentException('Invalid parameter: author array must include a' . ' "name" key with a non-empty string value'); } $author['name'] = $by['name']; if (isset($by['email'])) { if (empty($by['email']) || !is_string($by['email'])) { throw new Exception\InvalidArgumentException('Invalid parameter: "email" array' . ' value must be a non-empty string'); } $author['email'] = $by['email']; } if (isset($by['uri'])) { if (empty($by['uri']) || !is_string($by['uri']) || !Uri::factory($by['uri'])->isValid() ) { throw new Exception\InvalidArgumentException('Invalid parameter: "uri" array value must' . ' be a non-empty string and valid URI/IRI'); } $author['uri'] = $by['uri']; } $this->data['by'] = $author; return $this; } /** * @return string */ public function getBy() { if (!array_key_exists('by', $this->data)) { return null; } return $this->data['by']; } /** * @param string $comment * @return Deleted */ public function setComment($comment) { $this->data['comment'] = $comment; return $this; } /** * @return string */ public function getComment() { if (!array_key_exists('comment', $this->data)) { return null; } return $this->data['comment']; } } |