block_rss_client\output\item Class Reference

Class to help display an RSS Item. More...

Inheritance diagram for block_rss_client\output\item:

Public Member Functions
	__construct ($id, moodle_url $link, $title, $description, moodle_url $permalink, $timestamp, $showdescription=true)
	Contructor.
	export_for_template (\renderer_base $output)
	Export context for use in mustache templates.
	get_description ()
	Get description.
	get_id ()
	Get id.
	get_link ()
	Get link.
	get_permalink ()
	Get permalink.
	get_showdescription ()
	Get showdescription.
	get_timestamp ()
	Get timestamp.
	get_title ()
	Get title.
	set_description ($description)
	Set description.
	set_id ($id)
	Set id.
	set_link (\moodle_url $link)
	Set link.
	set_permalink ($permalink)
	Set permalink.
	set_showdescription ($showdescription)
	Set showdescription.
	set_timestamp ($timestamp)
	Set timestamp.
	set_title ($title)
	Set title.

Protected Attributes
string	$description
	The description of the item.
string	$id
	The unique id of the item.
moodle_url	$link
	The link to the item.
moodle_url	$permalink
	The item's permalink.
string	$showdescription
	Whether or not to show the item's description.
int	$timestamp
	The publish date of the item in Unix timestamp format.
string	$title
	The title of the item.

Detailed Description

Class to help display an RSS Item.

Copyright

2015 Howard County Public School System

Author

Brendan Anderson brend.nosp@m.an_a.nosp@m.nders.nosp@m.on@h.nosp@m.cpss..nosp@m.org

License

http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Constructor & Destructor Documentation

__construct()

block_rss_client\output\item::__construct	(		$id,
		moodle_url	$link,
			$title,
			$description,
		moodle_url	$permalink,
			$timestamp,
			$showdescription = true )

Contructor.

Parameters

string	$id	The id of the RSS item
moodle_url	$link	The URL of the RSS item
string	$title	The title pf the RSS item
string	$description	The description of the RSS item
moodle_url	$permalink	The permalink of the RSS item
int	$timestamp	The Unix timestamp that represents the published date
boolean	$showdescription	Whether or not to show the description

Member Function Documentation

export_for_template()

block_rss_client\output\item::export_for_template

(

\renderer_base

$output

)

Export context for use in mustache templates.

See also

templatable::export_for_template()

Parameters

renderer_base

$output

Return values

array

get_description()

block_rss_client\output\item::get_description

(

)

Get description.

Return values

string

get_id()

block_rss_client\output\item::get_id

(

)

Get id.

Return values

string

get_link()

block_rss_client\output\item::get_link

(

)

Get link.

Return values

moodle_url

get_permalink()

block_rss_client\output\item::get_permalink

(

)

Get permalink.

Return values

string

get_showdescription()

block_rss_client\output\item::get_showdescription

(

)

Get showdescription.

Return values

boolean

get_timestamp()

block_rss_client\output\item::get_timestamp

(

)

Get timestamp.

Return values

string

get_title()

block_rss_client\output\item::get_title

(

)

Get title.

Return values

string

set_description()

block_rss_client\output\item::set_description

(

$description

)

Set description.

Parameters

string

$description

Return values

block_rss_client\output\item

set_id()

block_rss_client\output\item::set_id

(

$id

)

Set id.

Parameters

string

$id

Return values

block_rss_client\output\item

set_link()

block_rss_client\output\item::set_link

(

\moodle_url

$link

)

Set link.

Parameters

moodle_url

$link

Return values

block_rss_client\output\item

set_permalink()

block_rss_client\output\item::set_permalink

(

$permalink

)

Set permalink.

Parameters

string

$permalink

Return values

block_rss_client\output\item

set_showdescription()

block_rss_client\output\item::set_showdescription

(

$showdescription

)

Set showdescription.

Parameters

boolean

$showdescription

Return values

block_rss_client\output\item

set_timestamp()

block_rss_client\output\item::set_timestamp

(

$timestamp

)

Set timestamp.

Parameters

int

$timestamp

Return values

block_rss_client\output\item

set_title()

block_rss_client\output\item::set_title

(

$title

)

Set title.

Parameters

string

$title

Return values

block_rss_client\output\item

---

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

• blocks/rss_client/classes/output/item.php