Moodle PHP Documentation 4.5
Moodle 4.5dev (Build: 20240606) (d3ae1391abe)
Category Class Reference

Manages all category-related data. More...

Public Member Functions

 __construct ($term=null, $scheme=null, $label=null, $type=null)
 Constructor, used to input the data.
 
 __toString ()
 String-ified version.
 
 get_label ($strict=false)
 Get the human readable label.
 
 get_scheme ()
 Get the categorization scheme identifier.
 
 get_term ()
 Get the category identifier.
 
 get_type ()
 Get the category type.
 

Public Attributes

string null $label
 Human readable label.
 
string null $scheme
 Categorization scheme identifier.
 
string null $term
 Category identifier.
 
string null $type
 Category type.
 

Detailed Description

Manages all category-related data.

Used by {

See also
SimplePie\Item\get_category()} and {
SimplePie\Itemget_categories()}

This class can be overloaded with {

See also
SimplePie\SimplePie\set_category_class()}

@subpackage API

Constructor & Destructor Documentation

◆ __construct()

Category::__construct ( $term = null,
$scheme = null,
$label = null,
$type = null )

Constructor, used to input the data.

Parameters
string | null$term
string | null$scheme
string | null$label
string | null$type

Member Function Documentation

◆ __toString()

Category::__toString ( )

String-ified version.

Return values
string

◆ get_label()

Category::get_label ( $strict = false)

Get the human readable label.

Parameters
bool$strict
Return values
string|null

◆ get_scheme()

Category::get_scheme ( )

Get the categorization scheme identifier.

Return values
string|null

◆ get_term()

Category::get_term ( )

Get the category identifier.

Return values
string|null

◆ get_type()

Category::get_type ( )

Get the category type.

Return values
string|null

Member Data Documentation

◆ $label

string null Category::$label

Human readable label.

See also
get_label()

◆ $scheme

string null Category::$scheme

Categorization scheme identifier.

See also
get_scheme()

◆ $term

string null Category::$term

Category identifier.

See also
get_term

◆ $type

string null Category::$type

Category type.

category for <category> subject for <dc:subject>

See also
get_type()

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