annotate vendor/zendframework/zend-feed/src/Writer/AbstractFeed.php @ 19:fa3358dc1485 tip

Add ndrum files
author Chris Cannam
date Wed, 28 Aug 2019 13:14:47 +0100
parents 129ea1e6d783
children
rev   line source
Chris@0 1 <?php
Chris@0 2 /**
Chris@0 3 * Zend Framework (http://framework.zend.com/)
Chris@0 4 *
Chris@0 5 * @link http://github.com/zendframework/zf2 for the canonical source repository
Chris@0 6 * @copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
Chris@0 7 * @license http://framework.zend.com/license/new-bsd New BSD License
Chris@0 8 */
Chris@0 9
Chris@0 10 namespace Zend\Feed\Writer;
Chris@0 11
Chris@0 12 use DateTime;
Chris@17 13 use DateTimeInterface;
Chris@0 14 use Zend\Feed\Uri;
Chris@0 15 use Zend\Validator;
Chris@0 16
Chris@0 17 class AbstractFeed
Chris@0 18 {
Chris@0 19 /**
Chris@0 20 * Contains all Feed level date to append in feed output
Chris@0 21 *
Chris@0 22 * @var array
Chris@0 23 */
Chris@0 24 protected $data = [];
Chris@0 25
Chris@0 26 /**
Chris@0 27 * Holds the value "atom" or "rss" depending on the feed type set when
Chris@0 28 * when last exported.
Chris@0 29 *
Chris@0 30 * @var string
Chris@0 31 */
Chris@0 32 protected $type = null;
Chris@0 33
Chris@0 34 /**
Chris@0 35 * @var $extensions
Chris@0 36 */
Chris@0 37 protected $extensions;
Chris@0 38
Chris@0 39 /**
Chris@0 40 * Constructor: Primarily triggers the registration of core extensions and
Chris@0 41 * loads those appropriate to this data container.
Chris@0 42 *
Chris@0 43 */
Chris@0 44 public function __construct()
Chris@0 45 {
Chris@0 46 Writer::registerCoreExtensions();
Chris@0 47 $this->_loadExtensions();
Chris@0 48 }
Chris@0 49
Chris@0 50 /**
Chris@0 51 * Set a single author
Chris@0 52 *
Chris@0 53 * The following option keys are supported:
Chris@0 54 * 'name' => (string) The name
Chris@0 55 * 'email' => (string) An optional email
Chris@0 56 * 'uri' => (string) An optional and valid URI
Chris@0 57 *
Chris@0 58 * @param array $author
Chris@0 59 * @throws Exception\InvalidArgumentException If any value of $author not follow the format.
Chris@0 60 * @return AbstractFeed
Chris@0 61 */
Chris@0 62 public function addAuthor(array $author)
Chris@0 63 {
Chris@0 64 // Check array values
Chris@12 65 if (! array_key_exists('name', $author)
Chris@0 66 || empty($author['name'])
Chris@12 67 || ! is_string($author['name'])
Chris@0 68 ) {
Chris@0 69 throw new Exception\InvalidArgumentException(
Chris@12 70 'Invalid parameter: author array must include a "name" key with a non-empty string value'
Chris@12 71 );
Chris@0 72 }
Chris@0 73
Chris@0 74 if (isset($author['email'])) {
Chris@12 75 if (empty($author['email']) || ! is_string($author['email'])) {
Chris@0 76 throw new Exception\InvalidArgumentException(
Chris@12 77 'Invalid parameter: "email" array value must be a non-empty string'
Chris@12 78 );
Chris@0 79 }
Chris@0 80 }
Chris@0 81 if (isset($author['uri'])) {
Chris@12 82 if (empty($author['uri']) || ! is_string($author['uri']) ||
Chris@12 83 ! Uri::factory($author['uri'])->isValid()
Chris@0 84 ) {
Chris@0 85 throw new Exception\InvalidArgumentException(
Chris@12 86 'Invalid parameter: "uri" array value must be a non-empty string and valid URI/IRI'
Chris@12 87 );
Chris@0 88 }
Chris@0 89 }
Chris@0 90
Chris@0 91 $this->data['authors'][] = $author;
Chris@0 92
Chris@0 93 return $this;
Chris@0 94 }
Chris@0 95
Chris@0 96 /**
Chris@0 97 * Set an array with feed authors
Chris@0 98 *
Chris@0 99 * @see addAuthor
Chris@0 100 * @param array $authors
Chris@0 101 * @return AbstractFeed
Chris@0 102 */
Chris@0 103 public function addAuthors(array $authors)
Chris@0 104 {
Chris@0 105 foreach ($authors as $author) {
Chris@0 106 $this->addAuthor($author);
Chris@0 107 }
Chris@0 108
Chris@0 109 return $this;
Chris@0 110 }
Chris@0 111
Chris@0 112 /**
Chris@0 113 * Set the copyright entry
Chris@0 114 *
Chris@0 115 * @param string $copyright
Chris@0 116 * @throws Exception\InvalidArgumentException
Chris@0 117 * @return AbstractFeed
Chris@0 118 */
Chris@0 119 public function setCopyright($copyright)
Chris@0 120 {
Chris@12 121 if (empty($copyright) || ! is_string($copyright)) {
Chris@0 122 throw new Exception\InvalidArgumentException('Invalid parameter: parameter must be a non-empty string');
Chris@0 123 }
Chris@0 124 $this->data['copyright'] = $copyright;
Chris@0 125
Chris@0 126 return $this;
Chris@0 127 }
Chris@0 128
Chris@0 129 /**
Chris@0 130 * Set the feed creation date
Chris@0 131 *
Chris@17 132 * @param null|int|DateTimeInterface
Chris@0 133 * @throws Exception\InvalidArgumentException
Chris@0 134 * @return AbstractFeed
Chris@0 135 */
Chris@0 136 public function setDateCreated($date = null)
Chris@0 137 {
Chris@0 138 if ($date === null) {
Chris@0 139 $date = new DateTime();
Chris@17 140 }
Chris@17 141 if (is_int($date)) {
Chris@0 142 $date = new DateTime('@' . $date);
Chris@17 143 }
Chris@17 144 if (! $date instanceof DateTimeInterface) {
Chris@0 145 throw new Exception\InvalidArgumentException('Invalid DateTime object or UNIX Timestamp'
Chris@0 146 . ' passed as parameter');
Chris@0 147 }
Chris@0 148 $this->data['dateCreated'] = $date;
Chris@0 149
Chris@0 150 return $this;
Chris@0 151 }
Chris@0 152
Chris@0 153 /**
Chris@0 154 * Set the feed modification date
Chris@0 155 *
Chris@17 156 * @param null|int|DateTimeInterface
Chris@0 157 * @throws Exception\InvalidArgumentException
Chris@0 158 * @return AbstractFeed
Chris@0 159 */
Chris@0 160 public function setDateModified($date = null)
Chris@0 161 {
Chris@0 162 if ($date === null) {
Chris@0 163 $date = new DateTime();
Chris@17 164 }
Chris@17 165 if (is_int($date)) {
Chris@0 166 $date = new DateTime('@' . $date);
Chris@17 167 }
Chris@17 168 if (! $date instanceof DateTimeInterface) {
Chris@0 169 throw new Exception\InvalidArgumentException('Invalid DateTime object or UNIX Timestamp'
Chris@0 170 . ' passed as parameter');
Chris@0 171 }
Chris@0 172 $this->data['dateModified'] = $date;
Chris@0 173
Chris@0 174 return $this;
Chris@0 175 }
Chris@0 176
Chris@0 177 /**
Chris@0 178 * Set the feed last-build date. Ignored for Atom 1.0.
Chris@0 179 *
Chris@17 180 * @param null|int|DateTimeInterface
Chris@0 181 * @throws Exception\InvalidArgumentException
Chris@0 182 * @return AbstractFeed
Chris@0 183 */
Chris@0 184 public function setLastBuildDate($date = null)
Chris@0 185 {
Chris@0 186 if ($date === null) {
Chris@0 187 $date = new DateTime();
Chris@17 188 }
Chris@17 189 if (is_int($date)) {
Chris@0 190 $date = new DateTime('@' . $date);
Chris@17 191 }
Chris@17 192 if (! $date instanceof DateTimeInterface) {
Chris@0 193 throw new Exception\InvalidArgumentException('Invalid DateTime object or UNIX Timestamp'
Chris@0 194 . ' passed as parameter');
Chris@0 195 }
Chris@0 196 $this->data['lastBuildDate'] = $date;
Chris@0 197
Chris@0 198 return $this;
Chris@0 199 }
Chris@0 200
Chris@0 201 /**
Chris@0 202 * Set the feed description
Chris@0 203 *
Chris@0 204 * @param string $description
Chris@0 205 * @throws Exception\InvalidArgumentException
Chris@0 206 * @return AbstractFeed
Chris@0 207 */
Chris@0 208 public function setDescription($description)
Chris@0 209 {
Chris@12 210 if (empty($description) || ! is_string($description)) {
Chris@0 211 throw new Exception\InvalidArgumentException('Invalid parameter: parameter must be a non-empty string');
Chris@0 212 }
Chris@0 213 $this->data['description'] = $description;
Chris@0 214
Chris@0 215 return $this;
Chris@0 216 }
Chris@0 217
Chris@0 218 /**
Chris@0 219 * Set the feed generator entry
Chris@0 220 *
Chris@0 221 * @param array|string $name
Chris@0 222 * @param null|string $version
Chris@0 223 * @param null|string $uri
Chris@0 224 * @throws Exception\InvalidArgumentException
Chris@0 225 * @return AbstractFeed
Chris@0 226 */
Chris@0 227 public function setGenerator($name, $version = null, $uri = null)
Chris@0 228 {
Chris@0 229 if (is_array($name)) {
Chris@0 230 $data = $name;
Chris@12 231 if (empty($data['name']) || ! is_string($data['name'])) {
Chris@0 232 throw new Exception\InvalidArgumentException('Invalid parameter: "name" must be a non-empty string');
Chris@0 233 }
Chris@0 234 $generator = ['name' => $data['name']];
Chris@0 235 if (isset($data['version'])) {
Chris@12 236 if (empty($data['version']) || ! is_string($data['version'])) {
Chris@12 237 throw new Exception\InvalidArgumentException(
Chris@12 238 'Invalid parameter: "version" must be a non-empty string'
Chris@12 239 );
Chris@0 240 }
Chris@0 241 $generator['version'] = $data['version'];
Chris@0 242 }
Chris@0 243 if (isset($data['uri'])) {
Chris@12 244 if (empty($data['uri']) || ! is_string($data['uri']) || ! Uri::factory($data['uri'])->isValid()) {
Chris@12 245 throw new Exception\InvalidArgumentException(
Chris@12 246 'Invalid parameter: "uri" must be a non-empty string and a valid URI/IRI'
Chris@12 247 );
Chris@0 248 }
Chris@0 249 $generator['uri'] = $data['uri'];
Chris@0 250 }
Chris@0 251 } else {
Chris@12 252 if (empty($name) || ! is_string($name)) {
Chris@0 253 throw new Exception\InvalidArgumentException('Invalid parameter: "name" must be a non-empty string');
Chris@0 254 }
Chris@0 255 $generator = ['name' => $name];
Chris@0 256 if (isset($version)) {
Chris@12 257 if (empty($version) || ! is_string($version)) {
Chris@12 258 throw new Exception\InvalidArgumentException(
Chris@12 259 'Invalid parameter: "version" must be a non-empty string'
Chris@12 260 );
Chris@0 261 }
Chris@0 262 $generator['version'] = $version;
Chris@0 263 }
Chris@0 264 if (isset($uri)) {
Chris@12 265 if (empty($uri) || ! is_string($uri) || ! Uri::factory($uri)->isValid()) {
Chris@12 266 throw new Exception\InvalidArgumentException(
Chris@12 267 'Invalid parameter: "uri" must be a non-empty string and a valid URI/IRI'
Chris@12 268 );
Chris@0 269 }
Chris@0 270 $generator['uri'] = $uri;
Chris@0 271 }
Chris@0 272 }
Chris@0 273 $this->data['generator'] = $generator;
Chris@0 274
Chris@0 275 return $this;
Chris@0 276 }
Chris@0 277
Chris@0 278 /**
Chris@0 279 * Set the feed ID - URI or URN (via PCRE pattern) supported
Chris@0 280 *
Chris@0 281 * @param string $id
Chris@0 282 * @throws Exception\InvalidArgumentException
Chris@0 283 * @return AbstractFeed
Chris@0 284 */
Chris@0 285 public function setId($id)
Chris@0 286 {
Chris@12 287 // @codingStandardsIgnoreStart
Chris@12 288 if ((empty($id) || ! is_string($id) || ! Uri::factory($id)->isValid())
Chris@12 289 && ! preg_match("#^urn:[a-zA-Z0-9][a-zA-Z0-9\-]{1,31}:([a-zA-Z0-9\(\)\+\,\.\:\=\@\;\$\_\!\*\-]|%[0-9a-fA-F]{2})*#", $id)
Chris@12 290 && ! $this->_validateTagUri($id)
Chris@0 291 ) {
Chris@12 292 // @codingStandardsIgnoreEnd
Chris@12 293 throw new Exception\InvalidArgumentException(
Chris@12 294 'Invalid parameter: parameter must be a non-empty string and valid URI/IRI'
Chris@12 295 );
Chris@0 296 }
Chris@0 297 $this->data['id'] = $id;
Chris@0 298
Chris@0 299 return $this;
Chris@0 300 }
Chris@0 301
Chris@0 302 /**
Chris@0 303 * Validate a URI using the tag scheme (RFC 4151)
Chris@0 304 *
Chris@0 305 * @param string $id
Chris@0 306 * @return bool
Chris@0 307 */
Chris@12 308 // @codingStandardsIgnoreStart
Chris@0 309 protected function _validateTagUri($id)
Chris@0 310 {
Chris@12 311 // @codingStandardsIgnoreEnd
Chris@12 312 if (preg_match(
Chris@12 313 '/^tag:(?P<name>.*),(?P<date>\d{4}-?\d{0,2}-?\d{0,2}):(?P<specific>.*)(.*:)*$/',
Chris@12 314 $id,
Chris@12 315 $matches
Chris@12 316 )) {
Chris@0 317 $dvalid = false;
Chris@0 318 $date = $matches['date'];
Chris@0 319 $d6 = strtotime($date);
Chris@0 320 if ((strlen($date) == 4) && $date <= date('Y')) {
Chris@0 321 $dvalid = true;
Chris@0 322 } elseif ((strlen($date) == 7) && ($d6 < strtotime("now"))) {
Chris@0 323 $dvalid = true;
Chris@0 324 } elseif ((strlen($date) == 10) && ($d6 < strtotime("now"))) {
Chris@0 325 $dvalid = true;
Chris@0 326 }
Chris@0 327 $validator = new Validator\EmailAddress;
Chris@0 328 if ($validator->isValid($matches['name'])) {
Chris@0 329 $nvalid = true;
Chris@0 330 } else {
Chris@0 331 $nvalid = $validator->isValid('info@' . $matches['name']);
Chris@0 332 }
Chris@0 333 return $dvalid && $nvalid;
Chris@0 334 }
Chris@0 335 return false;
Chris@0 336 }
Chris@0 337
Chris@0 338 /**
Chris@0 339 * Set a feed image (URI at minimum). Parameter is a single array with the
Chris@0 340 * required key 'uri'. When rendering as RSS, the required keys are 'uri',
Chris@0 341 * 'title' and 'link'. RSS also specifies three optional parameters 'width',
Chris@0 342 * 'height' and 'description'. Only 'uri' is required and used for Atom rendering.
Chris@0 343 *
Chris@0 344 * @param array $data
Chris@0 345 * @throws Exception\InvalidArgumentException
Chris@0 346 * @return AbstractFeed
Chris@0 347 */
Chris@0 348 public function setImage(array $data)
Chris@0 349 {
Chris@12 350 if (empty($data['uri']) || ! is_string($data['uri'])
Chris@12 351 || ! Uri::factory($data['uri'])->isValid()
Chris@0 352 ) {
Chris@0 353 throw new Exception\InvalidArgumentException('Invalid parameter: parameter \'uri\''
Chris@0 354 . ' must be a non-empty string and valid URI/IRI');
Chris@0 355 }
Chris@0 356 $this->data['image'] = $data;
Chris@0 357
Chris@0 358 return $this;
Chris@0 359 }
Chris@0 360
Chris@0 361 /**
Chris@0 362 * Set the feed language
Chris@0 363 *
Chris@0 364 * @param string $language
Chris@0 365 * @throws Exception\InvalidArgumentException
Chris@0 366 * @return AbstractFeed
Chris@0 367 */
Chris@0 368 public function setLanguage($language)
Chris@0 369 {
Chris@12 370 if (empty($language) || ! is_string($language)) {
Chris@0 371 throw new Exception\InvalidArgumentException('Invalid parameter: parameter must be a non-empty string');
Chris@0 372 }
Chris@0 373 $this->data['language'] = $language;
Chris@0 374
Chris@0 375 return $this;
Chris@0 376 }
Chris@0 377
Chris@0 378 /**
Chris@0 379 * Set a link to the HTML source
Chris@0 380 *
Chris@0 381 * @param string $link
Chris@0 382 * @throws Exception\InvalidArgumentException
Chris@0 383 * @return AbstractFeed
Chris@0 384 */
Chris@0 385 public function setLink($link)
Chris@0 386 {
Chris@12 387 if (empty($link) || ! is_string($link) || ! Uri::factory($link)->isValid()) {
Chris@12 388 throw new Exception\InvalidArgumentException(
Chris@12 389 'Invalid parameter: parameter must be a non-empty string and valid URI/IRI'
Chris@12 390 );
Chris@0 391 }
Chris@0 392 $this->data['link'] = $link;
Chris@0 393
Chris@0 394 return $this;
Chris@0 395 }
Chris@0 396
Chris@0 397 /**
Chris@0 398 * Set a link to an XML feed for any feed type/version
Chris@0 399 *
Chris@0 400 * @param string $link
Chris@0 401 * @param string $type
Chris@0 402 * @throws Exception\InvalidArgumentException
Chris@0 403 * @return AbstractFeed
Chris@0 404 */
Chris@0 405 public function setFeedLink($link, $type)
Chris@0 406 {
Chris@12 407 if (empty($link) || ! is_string($link) || ! Uri::factory($link)->isValid()) {
Chris@12 408 throw new Exception\InvalidArgumentException(
Chris@12 409 'Invalid parameter: "link"" must be a non-empty string and valid URI/IRI'
Chris@12 410 );
Chris@0 411 }
Chris@12 412 if (! in_array(strtolower($type), ['rss', 'rdf', 'atom'])) {
Chris@12 413 throw new Exception\InvalidArgumentException(
Chris@12 414 'Invalid parameter: "type"; You must declare the type of feed the link points to, i.e. RSS, RDF or Atom'
Chris@12 415 );
Chris@0 416 }
Chris@0 417 $this->data['feedLinks'][strtolower($type)] = $link;
Chris@0 418
Chris@0 419 return $this;
Chris@0 420 }
Chris@0 421
Chris@0 422 /**
Chris@0 423 * Set the feed title
Chris@0 424 *
Chris@0 425 * @param string $title
Chris@0 426 * @throws Exception\InvalidArgumentException
Chris@0 427 * @return AbstractFeed
Chris@0 428 */
Chris@0 429 public function setTitle($title)
Chris@0 430 {
Chris@16 431 if ((empty($title) && ! is_numeric($title)) || ! is_string($title)) {
Chris@0 432 throw new Exception\InvalidArgumentException('Invalid parameter: parameter must be a non-empty string');
Chris@0 433 }
Chris@0 434 $this->data['title'] = $title;
Chris@0 435
Chris@0 436 return $this;
Chris@0 437 }
Chris@0 438
Chris@0 439 /**
Chris@0 440 * Set the feed character encoding
Chris@0 441 *
Chris@0 442 * @param string $encoding
Chris@0 443 * @throws Exception\InvalidArgumentException
Chris@0 444 * @return AbstractFeed
Chris@0 445 */
Chris@0 446 public function setEncoding($encoding)
Chris@0 447 {
Chris@12 448 if (empty($encoding) || ! is_string($encoding)) {
Chris@0 449 throw new Exception\InvalidArgumentException('Invalid parameter: parameter must be a non-empty string');
Chris@0 450 }
Chris@0 451 $this->data['encoding'] = $encoding;
Chris@0 452
Chris@0 453 return $this;
Chris@0 454 }
Chris@0 455
Chris@0 456 /**
Chris@0 457 * Set the feed's base URL
Chris@0 458 *
Chris@0 459 * @param string $url
Chris@0 460 * @throws Exception\InvalidArgumentException
Chris@0 461 * @return AbstractFeed
Chris@0 462 */
Chris@0 463 public function setBaseUrl($url)
Chris@0 464 {
Chris@12 465 if (empty($url) || ! is_string($url) || ! Uri::factory($url)->isValid()) {
Chris@0 466 throw new Exception\InvalidArgumentException('Invalid parameter: "url" array value'
Chris@0 467 . ' must be a non-empty string and valid URI/IRI');
Chris@0 468 }
Chris@0 469 $this->data['baseUrl'] = $url;
Chris@0 470
Chris@0 471 return $this;
Chris@0 472 }
Chris@0 473
Chris@0 474 /**
Chris@0 475 * Add a Pubsubhubbub hub endpoint URL
Chris@0 476 *
Chris@0 477 * @param string $url
Chris@0 478 * @throws Exception\InvalidArgumentException
Chris@0 479 * @return AbstractFeed
Chris@0 480 */
Chris@0 481 public function addHub($url)
Chris@0 482 {
Chris@12 483 if (empty($url) || ! is_string($url) || ! Uri::factory($url)->isValid()) {
Chris@0 484 throw new Exception\InvalidArgumentException('Invalid parameter: "url" array value'
Chris@0 485 . ' must be a non-empty string and valid URI/IRI');
Chris@0 486 }
Chris@12 487 if (! isset($this->data['hubs'])) {
Chris@0 488 $this->data['hubs'] = [];
Chris@0 489 }
Chris@0 490 $this->data['hubs'][] = $url;
Chris@0 491
Chris@0 492 return $this;
Chris@0 493 }
Chris@0 494
Chris@0 495 /**
Chris@0 496 * Add Pubsubhubbub hub endpoint URLs
Chris@0 497 *
Chris@0 498 * @param array $urls
Chris@0 499 * @return AbstractFeed
Chris@0 500 */
Chris@0 501 public function addHubs(array $urls)
Chris@0 502 {
Chris@0 503 foreach ($urls as $url) {
Chris@0 504 $this->addHub($url);
Chris@0 505 }
Chris@0 506
Chris@0 507 return $this;
Chris@0 508 }
Chris@0 509
Chris@0 510 /**
Chris@0 511 * Add a feed category
Chris@0 512 *
Chris@0 513 * @param array $category
Chris@0 514 * @throws Exception\InvalidArgumentException
Chris@0 515 * @return AbstractFeed
Chris@0 516 */
Chris@0 517 public function addCategory(array $category)
Chris@0 518 {
Chris@12 519 if (! isset($category['term'])) {
Chris@0 520 throw new Exception\InvalidArgumentException('Each category must be an array and '
Chris@0 521 . 'contain at least a "term" element containing the machine '
Chris@0 522 . ' readable category name');
Chris@0 523 }
Chris@0 524 if (isset($category['scheme'])) {
Chris@0 525 if (empty($category['scheme'])
Chris@12 526 || ! is_string($category['scheme'])
Chris@12 527 || ! Uri::factory($category['scheme'])->isValid()
Chris@0 528 ) {
Chris@0 529 throw new Exception\InvalidArgumentException('The Atom scheme or RSS domain of'
Chris@0 530 . ' a category must be a valid URI');
Chris@0 531 }
Chris@0 532 }
Chris@12 533 if (! isset($this->data['categories'])) {
Chris@0 534 $this->data['categories'] = [];
Chris@0 535 }
Chris@0 536 $this->data['categories'][] = $category;
Chris@0 537
Chris@0 538 return $this;
Chris@0 539 }
Chris@0 540
Chris@0 541 /**
Chris@0 542 * Set an array of feed categories
Chris@0 543 *
Chris@0 544 * @param array $categories
Chris@0 545 * @return AbstractFeed
Chris@0 546 */
Chris@0 547 public function addCategories(array $categories)
Chris@0 548 {
Chris@0 549 foreach ($categories as $category) {
Chris@0 550 $this->addCategory($category);
Chris@0 551 }
Chris@0 552
Chris@0 553 return $this;
Chris@0 554 }
Chris@0 555
Chris@0 556 /**
Chris@0 557 * Get a single author
Chris@0 558 *
Chris@0 559 * @param int $index
Chris@0 560 * @return string|null
Chris@0 561 */
Chris@0 562 public function getAuthor($index = 0)
Chris@0 563 {
Chris@0 564 if (isset($this->data['authors'][$index])) {
Chris@0 565 return $this->data['authors'][$index];
Chris@0 566 }
Chris@0 567
Chris@0 568 return;
Chris@0 569 }
Chris@0 570
Chris@0 571 /**
Chris@0 572 * Get an array with feed authors
Chris@0 573 *
Chris@17 574 * @return array|null
Chris@0 575 */
Chris@0 576 public function getAuthors()
Chris@0 577 {
Chris@12 578 if (! array_key_exists('authors', $this->data)) {
Chris@0 579 return;
Chris@0 580 }
Chris@0 581 return $this->data['authors'];
Chris@0 582 }
Chris@0 583
Chris@0 584 /**
Chris@0 585 * Get the copyright entry
Chris@0 586 *
Chris@0 587 * @return string|null
Chris@0 588 */
Chris@0 589 public function getCopyright()
Chris@0 590 {
Chris@12 591 if (! array_key_exists('copyright', $this->data)) {
Chris@0 592 return;
Chris@0 593 }
Chris@0 594 return $this->data['copyright'];
Chris@0 595 }
Chris@0 596
Chris@0 597 /**
Chris@0 598 * Get the feed creation date
Chris@0 599 *
Chris@0 600 * @return string|null
Chris@0 601 */
Chris@0 602 public function getDateCreated()
Chris@0 603 {
Chris@12 604 if (! array_key_exists('dateCreated', $this->data)) {
Chris@0 605 return;
Chris@0 606 }
Chris@0 607 return $this->data['dateCreated'];
Chris@0 608 }
Chris@0 609
Chris@0 610 /**
Chris@0 611 * Get the feed modification date
Chris@0 612 *
Chris@0 613 * @return string|null
Chris@0 614 */
Chris@0 615 public function getDateModified()
Chris@0 616 {
Chris@12 617 if (! array_key_exists('dateModified', $this->data)) {
Chris@0 618 return;
Chris@0 619 }
Chris@0 620 return $this->data['dateModified'];
Chris@0 621 }
Chris@0 622
Chris@0 623 /**
Chris@0 624 * Get the feed last-build date
Chris@0 625 *
Chris@0 626 * @return string|null
Chris@0 627 */
Chris@0 628 public function getLastBuildDate()
Chris@0 629 {
Chris@12 630 if (! array_key_exists('lastBuildDate', $this->data)) {
Chris@0 631 return;
Chris@0 632 }
Chris@0 633 return $this->data['lastBuildDate'];
Chris@0 634 }
Chris@0 635
Chris@0 636 /**
Chris@0 637 * Get the feed description
Chris@0 638 *
Chris@0 639 * @return string|null
Chris@0 640 */
Chris@0 641 public function getDescription()
Chris@0 642 {
Chris@12 643 if (! array_key_exists('description', $this->data)) {
Chris@0 644 return;
Chris@0 645 }
Chris@0 646 return $this->data['description'];
Chris@0 647 }
Chris@0 648
Chris@0 649 /**
Chris@0 650 * Get the feed generator entry
Chris@0 651 *
Chris@0 652 * @return string|null
Chris@0 653 */
Chris@0 654 public function getGenerator()
Chris@0 655 {
Chris@12 656 if (! array_key_exists('generator', $this->data)) {
Chris@0 657 return;
Chris@0 658 }
Chris@0 659 return $this->data['generator'];
Chris@0 660 }
Chris@0 661
Chris@0 662 /**
Chris@0 663 * Get the feed ID
Chris@0 664 *
Chris@0 665 * @return string|null
Chris@0 666 */
Chris@0 667 public function getId()
Chris@0 668 {
Chris@12 669 if (! array_key_exists('id', $this->data)) {
Chris@0 670 return;
Chris@0 671 }
Chris@0 672 return $this->data['id'];
Chris@0 673 }
Chris@0 674
Chris@0 675 /**
Chris@0 676 * Get the feed image URI
Chris@0 677 *
Chris@0 678 * @return array
Chris@0 679 */
Chris@0 680 public function getImage()
Chris@0 681 {
Chris@12 682 if (! array_key_exists('image', $this->data)) {
Chris@0 683 return;
Chris@0 684 }
Chris@0 685 return $this->data['image'];
Chris@0 686 }
Chris@0 687
Chris@0 688 /**
Chris@0 689 * Get the feed language
Chris@0 690 *
Chris@0 691 * @return string|null
Chris@0 692 */
Chris@0 693 public function getLanguage()
Chris@0 694 {
Chris@12 695 if (! array_key_exists('language', $this->data)) {
Chris@0 696 return;
Chris@0 697 }
Chris@0 698 return $this->data['language'];
Chris@0 699 }
Chris@0 700
Chris@0 701 /**
Chris@0 702 * Get a link to the HTML source
Chris@0 703 *
Chris@0 704 * @return string|null
Chris@0 705 */
Chris@0 706 public function getLink()
Chris@0 707 {
Chris@12 708 if (! array_key_exists('link', $this->data)) {
Chris@0 709 return;
Chris@0 710 }
Chris@0 711 return $this->data['link'];
Chris@0 712 }
Chris@0 713
Chris@0 714 /**
Chris@0 715 * Get a link to the XML feed
Chris@0 716 *
Chris@0 717 * @return string|null
Chris@0 718 */
Chris@0 719 public function getFeedLinks()
Chris@0 720 {
Chris@12 721 if (! array_key_exists('feedLinks', $this->data)) {
Chris@0 722 return;
Chris@0 723 }
Chris@0 724 return $this->data['feedLinks'];
Chris@0 725 }
Chris@0 726
Chris@0 727 /**
Chris@0 728 * Get the feed title
Chris@0 729 *
Chris@0 730 * @return string|null
Chris@0 731 */
Chris@0 732 public function getTitle()
Chris@0 733 {
Chris@12 734 if (! array_key_exists('title', $this->data)) {
Chris@0 735 return;
Chris@0 736 }
Chris@0 737 return $this->data['title'];
Chris@0 738 }
Chris@0 739
Chris@0 740 /**
Chris@0 741 * Get the feed character encoding
Chris@0 742 *
Chris@0 743 * @return string|null
Chris@0 744 */
Chris@0 745 public function getEncoding()
Chris@0 746 {
Chris@12 747 if (! array_key_exists('encoding', $this->data)) {
Chris@0 748 return 'UTF-8';
Chris@0 749 }
Chris@0 750 return $this->data['encoding'];
Chris@0 751 }
Chris@0 752
Chris@0 753 /**
Chris@0 754 * Get the feed's base url
Chris@0 755 *
Chris@0 756 * @return string|null
Chris@0 757 */
Chris@0 758 public function getBaseUrl()
Chris@0 759 {
Chris@12 760 if (! array_key_exists('baseUrl', $this->data)) {
Chris@0 761 return;
Chris@0 762 }
Chris@0 763 return $this->data['baseUrl'];
Chris@0 764 }
Chris@0 765
Chris@0 766 /**
Chris@0 767 * Get the URLs used as Pubsubhubbub hubs endpoints
Chris@0 768 *
Chris@0 769 * @return string|null
Chris@0 770 */
Chris@0 771 public function getHubs()
Chris@0 772 {
Chris@12 773 if (! array_key_exists('hubs', $this->data)) {
Chris@0 774 return;
Chris@0 775 }
Chris@0 776 return $this->data['hubs'];
Chris@0 777 }
Chris@0 778
Chris@0 779 /**
Chris@0 780 * Get the feed categories
Chris@0 781 *
Chris@0 782 * @return string|null
Chris@0 783 */
Chris@0 784 public function getCategories()
Chris@0 785 {
Chris@12 786 if (! array_key_exists('categories', $this->data)) {
Chris@0 787 return;
Chris@0 788 }
Chris@0 789 return $this->data['categories'];
Chris@0 790 }
Chris@0 791
Chris@0 792 /**
Chris@0 793 * Resets the instance and deletes all data
Chris@0 794 *
Chris@0 795 * @return void
Chris@0 796 */
Chris@0 797 public function reset()
Chris@0 798 {
Chris@0 799 $this->data = [];
Chris@0 800 }
Chris@0 801
Chris@0 802 /**
Chris@0 803 * Set the current feed type being exported to "rss" or "atom". This allows
Chris@0 804 * other objects to gracefully choose whether to execute or not, depending
Chris@0 805 * on their appropriateness for the current type, e.g. renderers.
Chris@0 806 *
Chris@0 807 * @param string $type
Chris@0 808 * @return AbstractFeed
Chris@0 809 */
Chris@0 810 public function setType($type)
Chris@0 811 {
Chris@0 812 $this->type = $type;
Chris@0 813 return $this;
Chris@0 814 }
Chris@0 815
Chris@0 816 /**
Chris@0 817 * Retrieve the current or last feed type exported.
Chris@0 818 *
Chris@0 819 * @return string Value will be "rss" or "atom"
Chris@0 820 */
Chris@0 821 public function getType()
Chris@0 822 {
Chris@0 823 return $this->type;
Chris@0 824 }
Chris@0 825
Chris@0 826 /**
Chris@0 827 * Unset a specific data point
Chris@0 828 *
Chris@0 829 * @param string $name
Chris@0 830 * @return AbstractFeed
Chris@0 831 */
Chris@0 832 public function remove($name)
Chris@0 833 {
Chris@0 834 if (isset($this->data[$name])) {
Chris@0 835 unset($this->data[$name]);
Chris@0 836 }
Chris@0 837 return $this;
Chris@0 838 }
Chris@0 839
Chris@0 840 /**
Chris@0 841 * Method overloading: call given method on first extension implementing it
Chris@0 842 *
Chris@0 843 * @param string $method
Chris@0 844 * @param array $args
Chris@0 845 * @return mixed
Chris@0 846 * @throws Exception\BadMethodCallException if no extensions implements the method
Chris@0 847 */
Chris@0 848 public function __call($method, $args)
Chris@0 849 {
Chris@0 850 foreach ($this->extensions as $extension) {
Chris@0 851 try {
Chris@0 852 return call_user_func_array([$extension, $method], $args);
Chris@0 853 } catch (Exception\BadMethodCallException $e) {
Chris@0 854 }
Chris@0 855 }
Chris@0 856 throw new Exception\BadMethodCallException(
Chris@0 857 'Method: ' . $method . ' does not exist and could not be located on a registered Extension'
Chris@0 858 );
Chris@0 859 }
Chris@0 860
Chris@0 861 /**
Chris@0 862 * Load extensions from Zend\Feed\Writer\Writer
Chris@0 863 *
Chris@0 864 * @throws Exception\RuntimeException
Chris@0 865 * @return void
Chris@0 866 */
Chris@12 867 // @codingStandardsIgnoreStart
Chris@0 868 protected function _loadExtensions()
Chris@0 869 {
Chris@12 870 // @codingStandardsIgnoreEnd
Chris@0 871 $all = Writer::getExtensions();
Chris@0 872 $manager = Writer::getExtensionManager();
Chris@0 873 $exts = $all['feed'];
Chris@0 874 foreach ($exts as $ext) {
Chris@12 875 if (! $manager->has($ext)) {
Chris@12 876 throw new Exception\RuntimeException(
Chris@12 877 sprintf('Unable to load extension "%s"; could not resolve to class', $ext)
Chris@12 878 );
Chris@0 879 }
Chris@0 880 $this->extensions[$ext] = $manager->get($ext);
Chris@0 881 $this->extensions[$ext]->setEncoding($this->getEncoding());
Chris@0 882 }
Chris@0 883 }
Chris@0 884 }