Moodle APIs 3.9
Moodle 3.9.13+ (Build: 20220325)
Public Member Functions | Protected Attributes | List of all members
core\check\security\crawlers Class Reference

Verifies web crawler (search engine) access. More...

Inheritance diagram for core\check\security\crawlers:
core\check\check

Public Member Functions

 get_action_link ()
 A link to a place to action this. More...
 
 get_component ()
 Get the frankenstyle component name. More...
 
 get_id ()
 Get the check's id. More...
 
 get_name ()
 Get the short check name. More...
 
 get_ref ()
 Get the check reference. More...
 
 get_result ()
 Return result. More...
 
 set_component (string $component)
 Get the frankenstyle component name. More...
 

Protected Attributes

$string $component = 'core'
 $component - The component / plugin this task belongs to. More...
 

Detailed Description

Verifies web crawler (search engine) access.

Not combined with disabled guest access because attackers might gain guest access by modifying browser signature.

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

Member Function Documentation

◆ get_action_link()

core\check\security\crawlers::get_action_link ( )

A link to a place to action this.

Return values
action_link|null

Reimplemented from core\check\check.

◆ get_component()

core\check\check::get_component ( )
inherited

Get the frankenstyle component name.

Return values
string

◆ get_id()

core\check\check::get_id ( )
inherited

Get the check's id.

This defaults to the base name of the class which is ok in the most cases but if you have a check which can have multiple instances then you should override this to be unique.

Return values
stringmust be unique within a component

◆ get_name()

core\check\security\crawlers::get_name ( )

Get the short check name.

Return values
string

Reimplemented from core\check\check.

◆ get_ref()

core\check\check::get_ref ( )
inherited

Get the check reference.

Return values
stringmust be globally unique

◆ get_result()

core\check\security\crawlers::get_result ( )

Return result.

Return values
result

Reimplemented from core\check\check.

◆ set_component()

core\check\check::set_component ( string  $component)
inherited

Get the frankenstyle component name.

Parameters
string$componentname

Member Data Documentation

◆ $component

$string core\check\check::$component = 'core'
protectedinherited

$component - The component / plugin this task belongs to.

This is autopopulated by the check manager.


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