No Description

Category.php 3.9KB

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