File content/feed/FeedData.class.php

  1:   2:   3:   4:   5:   6:   7:   8:   9:  10:  11:  12:  13:  14:  15:  16:  17:  18:  19:  20:  21:  22:  23:  24:  25:  26:  27:  28:  29:  30:  31:  32:  33:  34:  35:  36:  37:  38:  39:  40:  41:  42:  43:  44:  45:  46:  47:  48:  49:  50:  51:  52:  53:  54:  55:  56:  57:  58:  59:  60:  61:  62:  63:  64:  65:  66:  67:  68:  69:  70:  71:  72:  73:  74:  75:  76:  77:  78:  79:  80:  81:  82:  83:  84:  85:  86:  87:  88:  89:  90:  91:  92:  93:  94:  95:  96:  97:  98:  99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 110: 111: 112: 113: 114: 115: 116: 117: 118: 119: 120: 121: 122: 123: 124: 125: 126: 127: 128: 129: 130: 131: 132: 133: 134: 135: 136: 137: 138: 139: 140: 141: 142: 

<?php
/**
 * Contains meta-informations about a feed with its entries
 * @package     Content
 * @subpackage  Feed
 * @copyright   &copy; 2005-2019 PHPBoost
 * @license     https://www.gnu.org/licenses/gpl-3.0.html GNU/GPL-3.0
 * @author      Loic ROUCHON <horn@phpboost.com>
 * @version     PHPBoost 5.2 - last update: 2016 10 30
 * @since       PHPBoost 2.0 - 2008 06 21
 * @contributor Julien BRISWALTER <j1.seth@phpboost.com>
*/

class FeedData
{
    private $title = '';        // Feed Title
    private $link = '';         // Feed Url
    private $date = null;       // Feed date
    private $desc = '';         // Feed Description
    private $lang = '';         // Feed Language
    private $host = '';         // Feed Host
    private $items = array();   // Items
    private $auth_bit = 0;      // Auth bit

    /**
     * Builds a FeedData Object
     * @param FeedData $data an other FeedData object to clone
     */
    public function __construct($data = null)
    {
        if ($data !== null && $data instanceof FeedData)
        {
            $this->title = $data->title;
            $this->link = $data->link;
            $this->date = $data->date;
            $this->desc = $data->desc;
            $this->lang = $data->lang ;
            $this->host = $data->host;
            $this->items = $data->items;
        }
    }

    ## Setters ##
    /**
     * Sets the feed title
     * @param string $value The title
     */
    public function set_title($value) { $this->title = strip_tags($value); }
    /**
     * Sets the feed data date
     * @param Date $value a date object representing the feed date
     */
    public function set_date($value) { $this->date = $value; }
    /**
     * Sets the feed description
     * @param string $value the feed description
     */
    public function set_desc($value) { $this->desc = $value; }
    /**
     * Sets the feed language
     * @param string $value the feed language
     */
    public function set_lang($value) { $this->lang = $value; }
    /**
     * Sets the feed host
     * @param string $value the feed host
     */
    public function set_host($value) { $this->host = $value; }
    /**
     * Sets the feed auth bit, useful to check authorizations
     * @param int $value the bit position in an int (from 1 to 32)
     */
    public function set_auth_bit($value) { $this->auth_bit = $value; }
    /**
     * Sets the feed item link
     * @param mixed $value a string url or an Url object
     */
    public function set_link($value)
    {
        if (!($value instanceof Url))
        {
            $value = new Url($value);
        }
        $this->link = $value->absolute();
    }

    public function add_item($item) { array_push($this->items, $item); }

    ## Getters ##
    public function get_title() { return $this->title; }
    public function get_link() { return $this->link; }
    public function get_date() { return $this->date->format(Date::FORMAT_DAY_MONTH, Timezone::USER_TIMEZONE); }
    public function get_date_rfc2822() { return $this->date->format(Date::FORMAT_RFC2822, Timezone::USER_TIMEZONE); }
    public function get_date_iso8601() { return $this->date->format(Date::FORMAT_ISO8601, Timezone::USER_TIMEZONE); }
    public function get_date_text() { return $this->date->format(Date::FORMAT_DAY_MONTH_YEAR_LONG, Timezone::USER_TIMEZONE); }
    public function get_desc() { return $this->desc; }
    public function get_lang() { return $this->lang; }
    public function get_host() { return $this->host; }

    /**
     * Returns the feed items
     * @return FeedItem[] the feed items
     */
    public function get_items()
    {
        $items = array();
        foreach ($this->items as $item)
        {
            if ((gettype($item->get_auth()) != 'array' || $this->auth_bit == 0) || AppContext::get_current_user()->check_auth($item->get_auth(), $this->auth_bit))
                $items[] = $item;
        }

        return $items;
    }

    public function serialize()
    {
        return TextHelper::serialize($this);
    }


    /**
     * Returns a items list containing $number items starting from the $begin_at one
     * @param int $number the number of items to retrieve
     * @param int $begin_at the number of the first to retrieve
     * @return FeedItem[] the items list containing $number items starting from the $begin_at one
     */
    public function subitems($number = 10, $begin_at = 0)
    {
        $secured_items = $this->get_items();
        $nb_items = count($secured_items);

        $items = array();
        $end_at = $begin_at + $number;
        for ($i = $begin_at; ($i < $nb_items) && ($i < $end_at) ; $i++)
            $items[] =& $secured_items[$i];

        return $items;
    }
}
?>