libraries/src/Feed/FeedLink.php - 5.4-dev - githubmirror/joomla-cms

libraries/src/Feed/FeedLink.php
131 строка3 KB
Allon Moritz
Merge commit '36e4e3080f5b4456273af08737b1782b8c24c3d4' into upmerge
24 июн 2023, 17:41
24 июн 2023, 17:41c04738c
<?php

/**
 * Joomla! Content Management System
 *
 * @copyright  (C) 2012 Open Source Matters, Inc. <https://www.joomla.org>
 * @license    GNU General Public License version 2 or later; see LICENSE.txt
 */

namespace Joomla\CMS\Feed;

// phpcs:disable PSR1.Files.SideEffects
\defined('_JEXEC') or die;
// phpcs:enable PSR1.Files.SideEffects

/**
 * Feed Link class.
 *
 * @since  3.1.4
 */
class FeedLink
{
    /**
     * The URI to the linked resource.
     *
     * @var    string
     * @since  3.1.4
     */
    public $uri;

    /**
     * The relationship between the feed and the linked resource.
     *
     * @var    string
     * @since  3.1.4
     */
    public $relation;

    /**
     * The resource type.
     *
     * @var    string
     * @since  3.1.4
     */
    public $type;

    /**
     * The language of the resource found at the given URI.
     *
     * @var    string
     * @since  3.1.4
     */
    public $language;

    /**
     * The title of the resource.
     *
     * @var    string
     * @since  3.1.4
     */
    public $title;

    /**
     * The length of the resource in bytes.
     *
     * @var    integer
     * @since  3.1.4
     */
    public $length;

    /**
     * The link of the image.
     *
     * @var    integer
     * @since  4.4.0
     */
    public $link;

    /**
     * The description of the image.
     *
     * @var    integer
     * @since  4.4.0
     */
    public $description;

    /**
     * The height of the image.
     *
     * @var    integer
     * @since  4.4.0
     */
    public $height;

    /**
     * The width of the image.
     *
     * @var    integer
     * @since  4.4.0
     */
    public $width;

    /**
     * Constructor.
     *
     * @param   string   $uri       The URI to the linked resource.
     * @param   string   $relation  The relationship between the feed and the linked resource.
     * @param   string   $type      The resource type.
     * @param   string   $language  The language of the resource found at the given URI.
     * @param   string   $title     The title of the resource.
     * @param   integer  $length    The length of the resource in bytes.
     *
     * @since   3.1.4
     * @throws  \InvalidArgumentException
     */
    public function __construct($uri = null, $relation = null, $type = null, $language = null, $title = null, $length = null)
    {
        $this->uri      = $uri;
        $this->relation = $relation;
        $this->type     = $type;
        $this->language = $language;
        $this->title    = $title;

        // Validate the length input.
        if (isset($length) && !is_numeric($length)) {
            throw new \InvalidArgumentException('Length must be numeric.');
        }

        $this->length = (int) $length;
    }
}