Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.
/lib/editor/atto/ -> adminlib.php (source)

[Source view]

Atto admin setting stuff.

Copyright: 2014 Jerome Mouneyrac
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 252 lines (8 kb)
Included or required: 1 time
Referenced: 0 times
Includes or requires: 1 file
 lib/editor/atto/lib.php

Defines 2 classes

editor_atto_toolbar_setting:: (1 method):
  validate()

editor_atto_subplugins_setting:: (6 methods):
  __construct()
  get_setting()
  get_defaultsetting()
  write_setting()
  is_related()
  output_html()


Class: editor_atto_toolbar_setting  - X-Ref

Admin setting for toolbar.

validate($data)   X-Ref
Validate data.

This ensures that:
- Plugins are only used once,
- Group names are unique,
- Lines match: group = plugin[, plugin[, plugin ...]],
- There are some groups and plugins defined,
- The plugins used are installed.

param: string $data
return: mixed True on success, else error message.

Class: editor_atto_subplugins_setting  - X-Ref

Special class for Atto plugins administration.

__construct()   X-Ref
Constructor.


get_setting()   X-Ref
Returns current value of this setting.
Always returns true, does nothing.

return: true

get_defaultsetting()   X-Ref
Returns default setting if exists.
Always returns true, does nothing.

return: true

write_setting($data)   X-Ref
Store new setting.
Always returns '', does not write anything.

param: string $data string or array, must not be NULL.
return: string Always returns ''.

is_related($query)   X-Ref
Checks if $query is one of the available subplugins.

param: string $query The string to search for.
return: bool Returns true if found, false if not.

output_html($data, $query = '')   X-Ref
Builds the XHTML to display the control.

param: mixed $data Unused.
param: string $query
return: string highlight.