WordPress at Your Fingertips
class is not described

SimplePie_Restriction{} WP 1.0

Handles <media:restriction> as defined in Media RSS

Used by SimplePie_Enclosure::get_restriction() and SimplePie_Enclosure::get_restrictions()

This class can be overloaded with SimplePie::set_restriction_class()

No Hooks.

Return

null. Nothing.

Usage

$SimplePie_Restriction = new SimplePie_Restriction();
// use class methods

Methods

  1. __construct($relationship = null, $type = null, $value = null)
  2. __toString()
  3. get_relationship()
  4. get_type()
  5. get_value()

Notes

  • Package: SimplePie
  • Subpackage: API

Code of SimplePie_Restriction{} WP 5.8.2

class SimplePie_Restriction
{
	/**
	 * Relationship ('allow'/'deny')
	 *
	 * @var string
	 * @see get_relationship()
	 */
	var $relationship;

	/**
	 * Type of restriction
	 *
	 * @var string
	 * @see get_type()
	 */
	var $type;

	/**
	 * Restricted values
	 *
	 * @var string
	 * @see get_value()
	 */
	var $value;

	/**
	 * Constructor, used to input the data
	 *
	 * For documentation on all the parameters, see the corresponding
	 * properties and their accessors
	 */
	public function __construct($relationship = null, $type = null, $value = null)
	{
		$this->relationship = $relationship;
		$this->type = $type;
		$this->value = $value;
	}

	/**
	 * String-ified version
	 *
	 * @return string
	 */
	public function __toString()
	{
		// There is no $this->data here
		return md5(serialize($this));
	}

	/**
	 * Get the relationship
	 *
	 * @return string|null Either 'allow' or 'deny'
	 */
	public function get_relationship()
	{
		if ($this->relationship !== null)
		{
			return $this->relationship;
		}

		return null;
	}

	/**
	 * Get the type
	 *
	 * @return string|null
	 */
	public function get_type()
	{
		if ($this->type !== null)
		{
			return $this->type;
		}

		return null;
	}

	/**
	 * Get the list of restricted things
	 *
	 * @return string|null
	 */
	public function get_value()
	{
		if ($this->value !== null)
		{
			return $this->value;
		}

		return null;
	}
}