tool_usertours

Namespaces
namespace	tool_usertours
namespace	tool_usertours\event
namespace	tool_usertours\hook
namespace	tool_usertours\local\clientside_filter
namespace	tool_usertours\local\filter
namespace	tool_usertours\local\forms
namespace	tool_usertours\local\table
namespace	tool_usertours\local\target
namespace	tool_usertours\output
namespace	tool_usertours\privacy

Classes
class	behat_tool_usertours
	User tour related steps definitions. More...
class	tool_usertours\cache
class	tool_usertours\configuration
class	tool_usertours\helper
class	tool_usertours\hook\before_clientside_filter_fetch
class	tool_usertours\hook\before_serverside_filter_fetch
class	tool_usertours\hook_callbacks
class	tool_usertours\local\clientside_filter\clientside_filter
class	tool_usertours\local\clientside_filter\cssselector
class	tool_usertours\local\filter\accessdate
class	tool_usertours\local\filter\base
class	tool_usertours\local\filter\category
class	tool_usertours\local\filter\course
class	tool_usertours\local\filter\courseformat
class	tool_usertours\local\filter\role
class	tool_usertours\local\filter\theme
class	tool_usertours\local\forms\editstep
	Form for editing steps. More...
class	tool_usertours\local\forms\edittour
	Form for editing tours. More...
class	tool_usertours\local\forms\importtour
	Form for importing tours. More...
class	tool_usertours\local\table\step_list
	Table to show the list of steps in a tour. More...
class	tool_usertours\local\table\tour_list
	Table to show the list of tours. More...
class	tool_usertours\local\target\base
class	tool_usertours\local\target\block
class	tool_usertours\local\target\selector
class	tool_usertours\local\target\unattached
class	tool_usertours\manager
class	tool_usertours\output\renderer
class	tool_usertours\output\step
	Tour Step Renderable. More...
class	tool_usertours\output\tour
class	tool_usertours\privacy\provider
class	tool_usertours\step
class	tool_usertours\target
class	tool_usertours\tour

Functions
	tool_usertours_extend_navigation_user ()
	Extend the user navigation to bootstrap tours.
	tool_usertours_get_fontawesome_icon_map ()
	Map icons for font-awesome themes.
	tool_usertours_inplace_editable ($itemtype, $itemid, $newvalue)
	Manage inplace editable saves.
	tool_usertours_pluginfile ($course, $cm, $context, $filearea, $args, $forcedownload, array $options=[])
	Serves any files associated with the user tour content.
	xmldb_tool_usertours_install ()
	Perform the post-install procedures.
	xmldb_tool_usertours_upgrade ($oldversion)
	Upgrade the user tours plugin.

Variables
	$callbacks
	$capabilities
	$capabilities
	$definitions
	$functions
	$plugin = 2024100100
$plugin	component = 'tool_usertours'
$plugin	version = 2024100700

Detailed Description

Function Documentation

tool_usertours_inplace_editable()

tool_usertours_inplace_editable	(		$itemtype,
			$itemid,
			$newvalue )

Manage inplace editable saves.

Parameters

string	$itemtype	The type of item.
int	$itemid	The ID of the item.
mixed	$newvalue	The new value

Return values

core\output\inplace_editable

tool_usertours_pluginfile()

tool_usertours_pluginfile	(		$course,
			$cm,
			$context,
			$filearea,
			$args,
			$forcedownload,
		array	$options = [] )

Serves any files associated with the user tour content.

Parameters

stdClass	$course	Course object
stdClass	$cm	Course module object
context	$context	Context
string	$filearea	File area for data privacy
array	$args	Arguments
bool	$forcedownload	If we are forcing the download
array	$options	More options

Return values

bool	Returns false if we don't find a file.

xmldb_tool_usertours_upgrade()

xmldb_tool_usertours_upgrade

(

$oldversion

)

Upgrade the user tours plugin.

Parameters

int

$oldversion

The old version of the user tours plugin

Return values

bool

Variable Documentation

$callbacks

$callbacks

Initial value:

= [
    [
        'hook' => core\hook\output\before_footer_html_generation::class,
        'callback' => tool_usertours\hook_callbacks::class . '::before_footer_html_generation',
        'priority' => 0,
    ],
]

$capabilities [1/2]

$capabilities

Initial value:

= [
    'tool/usertours:managetours' => [
        'captype' => 'write',
        'riskbitmask' => RISK_XSS,
        'contextlevel' => CONTEXT_SYSTEM,
        'archetypes' => [
            'manager' => CAP_ALLOW,
        ],
    ],
]

$capabilities [2/2]

$capabilities

Initial value:

= [
    'tool/usertours:managetours',
]

$definitions

$definitions

Initial value:

= [
    'tourdata' => [
        'mode' => cache_store::MODE_APPLICATION,
        'simplekeys' => true,
        'simpledata' => true,
        'staticacceleration' => true,
        'staticaccelerationsize' => 1,
    ],
    'stepdata' => [
        'mode' => cache_store::MODE_APPLICATION,
        'simplekeys' => true,
        'simpledata' => true,
        'staticacceleration' => true,
        'staticaccelerationsize' => 1,
    ],
]