inc/3rdparty/libraries/simplepie/library/SimplePie/Rating.php

   1 <?php
   2 /**
   3  * SimplePie
   4  *
   5  * A PHP-Based RSS and Atom Feed Framework.
   6  * Takes the hard work out of managing a complete RSS/Atom solution.
   7  *
   8  * Copyright (c) 2004-2012, Ryan Parman, Geoffrey Sneddon, Ryan McCue, and contributors
   9  * All rights reserved.
  10  *
  11  * Redistribution and use in source and binary forms, with or without modification, are
  12  * permitted provided that the following conditions are met:
  13  *
  14  *      * Redistributions of source code must retain the above copyright notice, this list of
  15  *        conditions and the following disclaimer.
  16  *
  17  *      * Redistributions in binary form must reproduce the above copyright notice, this list
  18  *        of conditions and the following disclaimer in the documentation and/or other materials
  19  *        provided with the distribution.
  20  *
  21  *      * Neither the name of the SimplePie Team nor the names of its contributors may be used
  22  *        to endorse or promote products derived from this software without specific prior
  23  *        written permission.
  24  *
  25  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS
  26  * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
  27  * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS
  28  * AND CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  29  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  30  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  31  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  32  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  33  * POSSIBILITY OF SUCH DAMAGE.
  34  *
  35  * @package SimplePie
  36  * @version 1.3.1
  37  * @copyright 2004-2012 Ryan Parman, Geoffrey Sneddon, Ryan McCue
  38  * @author Ryan Parman
  39  * @author Geoffrey Sneddon
  40  * @author Ryan McCue
  41  * @link http://simplepie.org/ SimplePie
  42  * @license http://www.opensource.org/licenses/bsd-license.php BSD License
  43  */
  44
  45 /**
  46  * Handles `<media:rating>` or `<itunes:explicit>` tags as defined in Media RSS and iTunes RSS respectively
  47  *
  48  * Used by {@see SimplePie_Enclosure::get_rating()} and {@see SimplePie_Enclosure::get_ratings()}
  49  *
  50  * This class can be overloaded with {@see SimplePie::set_rating_class()}
  51  *
  52  * @package SimplePie
  53  * @subpackage API
  54  */
  55 class SimplePie_Rating
  56 {
  57         /**
  58          * Rating scheme
  59          *
  60          * @var string
  61          * @see get_scheme()
  62          */
  63         var $scheme;
  64
  65         /**
  66          * Rating value
  67          *
  68          * @var string
  69          * @see get_value()
  70          */
  71         var $value;
  72
  73         /**
  74          * Constructor, used to input the data
  75          *
  76          * For documentation on all the parameters, see the corresponding
  77          * properties and their accessors
  78          */
  79         public function __construct($scheme = null, $value = null)
  80         {
  81                 $this->scheme = $scheme;
  82                 $this->value = $value;
  83         }
  84
  85         /**
  86          * String-ified version
  87          *
  88          * @return string
  89          */
  90         public function __toString()
  91         {
  92                 // There is no $this->data here
  93                 return md5(serialize($this));
  94         }
  95
  96         /**
  97          * Get the organizational scheme for the rating
  98          *
  99          * @return string|null
 100          */
 101         public function get_scheme()
 102         {
 103                 if ($this->scheme !== null)
 104                 {
 105                         return $this->scheme;
 106                 }
 107                 else
 108                 {
 109                         return null;
 110                 }
 111         }
 112
 113         /**
 114          * Get the value of the rating
 115          *
 116          * @return string|null
 117          */
 118         public function get_value()
 119         {
 120                 if ($this->value !== null)
 121                 {
 122                         return $this->value;
 123                 }
 124                 else
 125                 {
 126                         return null;
 127                 }
 128         }
 129 }