lib/simplepie/library/SimplePie/Category.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, 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  * @copyright 2004-2016 Ryan Parman, Geoffrey Sneddon, Ryan McCue
  37  * @author Ryan Parman
  38  * @author Geoffrey 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  * Manages all category-related data
  46  *
  47  * Used by {@see SimplePie_Item::get_category()} and {@see SimplePie_Item::get_categories()}
  48  *
  49  * This class can be overloaded with {@see SimplePie::set_category_class()}
  50  *
  51  * @package SimplePie
  52  * @subpackage API
  53  */
  54 class SimplePie_Category
  55 {
  56         /**
  57          * Category identifier
  58          *
  59          * @var string
  60          * @see get_term
  61          */
  62         var $term;
  63
  64         /**
  65          * Categorization scheme identifier
  66          *
  67          * @var string
  68          * @see get_scheme()
  69          */
  70         var $scheme;
  71
  72         /**
  73          * Human readable label
  74          *
  75          * @var string
  76          * @see get_label()
  77          */
  78         var $label;
  79
  80         /**
  81          * Constructor, used to input the data
  82          *
  83          * @param string $term
  84          * @param string $scheme
  85          * @param string $label
  86          */
  87         public function __construct($term = null, $scheme = null, $label = null)
  88         {
  89                 $this->term = $term;
  90                 $this->scheme = $scheme;
  91                 $this->label = $label;
  92         }
  93
  94         /**
  95          * String-ified version
  96          *
  97          * @return string
  98          */
  99         public function __toString()
 100         {
 101                 // There is no $this->data here
 102                 return md5(serialize($this));
 103         }
 104
 105         /**
 106          * Get the category identifier
 107          *
 108          * @return string|null
 109          */
 110         public function get_term()
 111         {
 112                 if ($this->term !== null)
 113                 {
 114                         return $this->term;
 115                 }
 116                 else
 117                 {
 118                         return null;
 119                 }
 120         }
 121
 122         /**
 123          * Get the categorization scheme identifier
 124          *
 125          * @return string|null
 126          */
 127         public function get_scheme()
 128         {
 129                 if ($this->scheme !== null)
 130                 {
 131                         return $this->scheme;
 132                 }
 133                 else
 134                 {
 135                         return null;
 136                 }
 137         }
 138
 139         /**
 140          * Get the human readable label
 141          *
 142          * @return string|null
 143          */
 144         public function get_label()
 145         {
 146                 if ($this->label !== null)
 147                 {
 148                         return $this->label;
 149                 }
 150                 else
 151                 {
 152                         return $this->get_term();
 153                 }
 154         }
 155 }
 156