Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
Restriction Class Reference

Handles <media:restriction> as defined in Media RSS. More...

Public Member Functions

 __construct ($relationship=null, $type=null, $value=null)
 Constructor, used to input the data.
 
 __toString ()
 String-ified version.
 
 get_relationship ()
 Get the relationship.
 
 get_type ()
 Get the type.
 
 get_value ()
 Get the list of restricted things.
 

Public Attributes

string $relationship
 Relationship ('allow'/'deny')
 
string $type
 Type of restriction.
 
string $value
 Restricted values.
 

Detailed Description

Handles <media:restriction> as defined in Media RSS.

Used by {

See also
SimplePie\Enclosure\get_restriction()} and {
SimplePie\Enclosureget_restrictions()}

This class can be overloaded with {

See also
SimplePie\SimplePie\set_restriction_class()}

@subpackage API

Constructor & Destructor Documentation

◆ __construct()

Restriction::__construct ( $relationship = null,
$type = null,
$value = null )

Constructor, used to input the data.

For documentation on all the parameters, see the corresponding properties and their accessors

Member Function Documentation

◆ __toString()

Restriction::__toString ( )

String-ified version.

Return values
string

◆ get_relationship()

Restriction::get_relationship ( )

Get the relationship.

Return values
string|nullEither 'allow' or 'deny'

◆ get_type()

Restriction::get_type ( )

Get the type.

Return values
string|null

◆ get_value()

Restriction::get_value ( )

Get the list of restricted things.

Return values
string|null

Member Data Documentation

◆ $relationship

string Restriction::$relationship

Relationship ('allow'/'deny')

See also
get_relationship()

◆ $type

string Restriction::$type

Type of restriction.

See also
get_type()

◆ $value

string Restriction::$value

Restricted values.

See also
get_value()

The documentation for this class was generated from the following file: