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

This filter defines the context level of the blog entries being searched: site, course, module. More...

Inheritance diagram for blog_filter_context:
blog_filter

Public Member Functions

 __construct ($id=null, $type='site')
 Constructor.
 

Static Public Member Functions

static get_instance ($id, $type)
 TODO This is poor design.
 

Public Attributes

array $availabletypes = array()
 An array of strings representing the available filter types for each blog_filter.
 
array $conditions = array()
 An array of WHERE conditions $conditions.
 
int $id
 The unique ID for a filter's associated record $id.
 
 $overrides = array()
 An array of filter types which this particular filter type overrides: their conditions will not be evaluated.
 
array $params = array()
 An array of SQL params $params.
 
array $tables = array()
 An array of table aliases that are used in the WHERE conditions $tables.
 
string $type
 The type of filter (for example, types of blog_filter_context are site, course and module) $type.
 

Detailed Description

This filter defines the context level of the blog entries being searched: site, course, module.

Constructor & Destructor Documentation

◆ __construct()

blog_filter_context::__construct ( $id = null,
$type = 'site' )

Constructor.

Parameters
string$type
int$id

Reimplemented from blog_filter.

Member Function Documentation

◆ get_instance()

static blog_filter::get_instance ( $id,
$type )
staticinherited

TODO This is poor design.

A parent class should not know anything about its children. The default case helps to resolve this design issue

Member Data Documentation

◆ $availabletypes

array blog_filter::$availabletypes = array()
inherited

An array of strings representing the available filter types for each blog_filter.

$availabletypes


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