Moodle PHP Documentation 4.3
Moodle 4.3.5 (Build: 20240610) (7dcfaa79f78)
Credit Class Reference

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

Public Member Functions

 __construct ($role=null, $scheme=null, $name=null)
 Constructor, used to input the data.
 
 __toString ()
 String-ified version.
 
 get_name ()
 Get the credited person/entity's name.
 
 get_role ()
 Get the role of the person receiving credit.
 
 get_scheme ()
 Get the organizational scheme.
 

Public Attributes

string $name
 Credited name.
 
string $role
 Credited role.
 
string $scheme
 Organizational scheme.
 

Detailed Description

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

Used by {

See also
SimplePie\Enclosure\get_credit()} and {
SimplePie\Enclosureget_credits()}

This class can be overloaded with {

See also
SimplePie\SimplePie\set_credit_class()}

@subpackage API

Constructor & Destructor Documentation

◆ __construct()

Credit::__construct ( $role = null,
$scheme = null,
$name = null )

Constructor, used to input the data.

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

Member Function Documentation

◆ __toString()

Credit::__toString ( )

String-ified version.

Return values
string

◆ get_name()

Credit::get_name ( )

Get the credited person/entity's name.

Return values
string|null

◆ get_role()

Credit::get_role ( )

Get the role of the person receiving credit.

Return values
string|null

◆ get_scheme()

Credit::get_scheme ( )

Get the organizational scheme.

Return values
string|null

Member Data Documentation

◆ $name

string Credit::$name

Credited name.

See also
get_name()

◆ $role

string Credit::$role

Credited role.

See also
get_role()

◆ $scheme

string Credit::$scheme

Organizational scheme.

See also
get_scheme()

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