Restriction.php 3.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148
  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. * Handles `<media:restriction>` as defined in Media RSS
  45. *
  46. * Used by {@see SimplePie_Enclosure::get_restriction()} and {@see SimplePie_Enclosure::get_restrictions()}
  47. *
  48. * This class can be overloaded with {@see SimplePie::set_restriction_class()}
  49. *
  50. * @package SimplePie
  51. * @subpackage API
  52. */
  53. class SimplePie_Restriction
  54. {
  55. /**
  56. * Relationship ('allow'/'deny')
  57. *
  58. * @var string
  59. * @see get_relationship()
  60. */
  61. var $relationship;
  62. /**
  63. * Type of restriction
  64. *
  65. * @var string
  66. * @see get_type()
  67. */
  68. var $type;
  69. /**
  70. * Restricted values
  71. *
  72. * @var string
  73. * @see get_value()
  74. */
  75. var $value;
  76. /**
  77. * Constructor, used to input the data
  78. *
  79. * For documentation on all the parameters, see the corresponding
  80. * properties and their accessors
  81. */
  82. public function __construct($relationship = null, $type = null, $value = null)
  83. {
  84. $this->relationship = $relationship;
  85. $this->type = $type;
  86. $this->value = $value;
  87. }
  88. /**
  89. * String-ified version
  90. *
  91. * @return string
  92. */
  93. public function __toString()
  94. {
  95. // There is no $this->data here
  96. return md5(serialize($this));
  97. }
  98. /**
  99. * Get the relationship
  100. *
  101. * @return string|null Either 'allow' or 'deny'
  102. */
  103. public function get_relationship()
  104. {
  105. if ($this->relationship !== null)
  106. {
  107. return $this->relationship;
  108. }
  109. return null;
  110. }
  111. /**
  112. * Get the type
  113. *
  114. * @return string|null
  115. */
  116. public function get_type()
  117. {
  118. if ($this->type !== null)
  119. {
  120. return $this->type;
  121. }
  122. return null;
  123. }
  124. /**
  125. * Get the list of restricted things
  126. *
  127. * @return string|null
  128. */
  129. public function get_value()
  130. {
  131. if ($this->value !== null)
  132. {
  133. return $this->value;
  134. }
  135. return null;
  136. }
  137. }