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

Abstract Blog_Listing class: used to gather blog entries and output them as listings. More...

Public Member Functions

 __construct ($filters=array())
 Constructor.
 
 count_entries ()
 Finds total number of blog entries.
 
 get_baseurl ()
 
 get_entries ($start=0, $limit=10)
 Fetches the array of blog entries.
 
 get_entry_fetch_sql ($count=false, $sort='lastmodified DESC', $userid=false)
 
 print_entries ()
 Outputs all the blog entries aggregated by this blog listing.
 

Public Attributes

array $entries = null
 Array of blog_entry objects.
 
array $filters = array()
 An array of blog_filter_* objects $filters.
 
int $totalentries = null
 Caches the total number of the entries.
 

Detailed Description

Abstract Blog_Listing class: used to gather blog entries and output them as listings.

One of the subclasses must be used.

@subpackage blog

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

Constructor & Destructor Documentation

◆ __construct()

blog_listing::__construct ( $filters = array())

Constructor.

Parameters
array$filtersAn associative array of filtername => filterid

Member Function Documentation

◆ count_entries()

blog_listing::count_entries ( )

Finds total number of blog entries.

Return values
int

◆ get_entries()

blog_listing::get_entries ( $start = 0,
$limit = 10 )

Fetches the array of blog entries.

Return values
array

◆ print_entries()

blog_listing::print_entries ( )

Outputs all the blog entries aggregated by this blog listing.

Return values
void

Member Data Documentation

◆ $entries

array blog_listing::$entries = null

Array of blog_entry objects.

$entries


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