lib/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-2016, Ryan Parman, Sam 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  * @copyright 2004-2016 Ryan Parman, Sam Sneddon, Ryan McCue
  37  * @author Ryan Parman
  38  * @author Sam Sneddon
  39  * @author Ryan McCue
  40  * @link http://simplepie.org/ SimplePie
  41  * @license http://www.opensource.org/licenses/bsd-license.php BSD License
  42  */
  43
  44 /**
  45  * Handles `<media:rating>` or `<itunes:explicit>` tags as defined in Media RSS and iTunes RSS respectively
  46  *
  47  * Used by {@see SimplePie_Enclosure::get_rating()} and {@see SimplePie_Enclosure::get_ratings()}
  48  *
  49  * This class can be overloaded with {@see SimplePie::set_rating_class()}
  50  *
  51  * @package SimplePie
  52  * @subpackage API
  53  */
  54 class SimplePie_Rating
  55 {
  56         /**
  57          * Rating scheme
  58          *
  59          * @var string
  60          * @see get_scheme()
  61          */
  62         var $scheme;
  63
  64         /**
  65          * Rating value
  66          *
  67          * @var string
  68          * @see get_value()
  69          */
  70         var $value;
  71
  72         /**
  73          * Constructor, used to input the data
  74          *
  75          * For documentation on all the parameters, see the corresponding
  76          * properties and their accessors
  77          */
  78         public function __construct($scheme = null, $value = null)
  79         {
  80                 $this->scheme = $scheme;
  81                 $this->value = $value;
  82         }
  83
  84         /**
  85          * String-ified version
  86          *
  87          * @return string
  88          */
  89         public function __toString()
  90         {
  91                 // There is no $this->data here
  92                 return md5(serialize($this));
  93         }
  94
  95         /**
  96          * Get the organizational scheme for the rating
  97          *
  98          * @return string|null
  99          */
 100         public function get_scheme()
 101         {
 102                 if ($this->scheme !== null)
 103                 {
 104                         return $this->scheme;
 105                 }
 106
 107                 return null;
 108         }
 109
 110         /**
 111          * Get the value of the rating
 112          *
 113          * @return string|null
 114          */
 115         public function get_value()
 116         {
 117                 if ($this->value !== null)
 118                 {
 119                         return $this->value;
 120                 }
 121
 122                 return null;
 123         }
 124 }
 125
 126 class_alias('SimplePie_Rating', 'SimplePie\Rating', false);