Search moodle.org's
Developer Documentation


  • Bug fixes for general core bugs in 2.8.x ended 9 November 2015 (12 months).
  • Bug fixes for security issues in 2.8.x ended 9 May 2016 (18 months).
  • minimum PHP 5.4.4 (always use latest PHP 5.4.x or 5.5.x on Windows - http://windows.php.net/download/), PHP 7 is NOT supported
  • Differences Between: [Versions 28 and 29] [Versions 28 and 30] [Versions 28 and 31] [Versions 28 and 32] [Versions 28 and 33] [Versions 28 and 34] [Versions 28 and 35] [Versions 28 and 36] [Versions 28 and 37]

    External notes API

    Copyright: 2011 Jerome Mouneyrac
    License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
    File Size: 514 lines (21 kb)
    Included or required:0 times
    Referenced: 6 times
    Includes or requires: 0 files

    Defines 2 classes

    core_notes_external:: (12 methods):
      create_notes_parameters()
      create_notes()
      create_notes_returns()
      delete_notes_parameters()
      delete_notes()
      delete_notes_returns()
      get_notes_parameters()
      get_notes()
      get_notes_returns()
      update_notes_parameters()
      update_notes()
      update_notes_returns()

    moodle_notes_external:: (3 methods):
      create_notes_parameters()
      create_notes()
      create_notes_returns()


    Class: core_notes_external  - X-Ref

    Notes external functions

    create_notes_parameters()   X-Ref
    Returns description of method parameters

    return: external_function_parameters

    create_notes($notes = array()   X-Ref
    Create notes about some users
    Note: code should be matching the /notes/edit.php checks
    and the /user/addnote.php checks. (they are similar cheks)

    return: array (success infos and fail infos)
    param: array $notes  An array of notes to create.

    create_notes_returns()   X-Ref
    Returns description of method result value

    return: external_description

    delete_notes_parameters()   X-Ref
    Returns description of delete_notes parameters

    return: external_function_parameters

    delete_notes($notes = array()   X-Ref
    Delete notes about users.
    Note: code should be matching the /notes/delete.php checks.

    return: null
    param: array $notes An array of ids for the notes to delete.

    delete_notes_returns()   X-Ref
    Returns description of delete_notes result value.

    return: external_description

    get_notes_parameters()   X-Ref
    Returns description of get_notes parameters.

    return: external_function_parameters

    get_notes($notes)   X-Ref
    Get notes about users.

    return: null
    param: array $notes An array of ids for the notes to retrieve.

    get_notes_returns()   X-Ref
    Returns description of get_notes result value.

    return: external_description

    update_notes_parameters()   X-Ref
    Returns description of update_notes parameters.

    return: external_function_parameters

    update_notes($notes = array()   X-Ref
    Update notes about users.

    return: array fail infos.
    param: array $notes An array of ids for the notes to update.

    update_notes_returns()   X-Ref
    Returns description of update_notes result value.

    return: external_description

    Class: moodle_notes_external  - X-Ref

    Deprecated notes external functions

    create_notes_parameters()   X-Ref
    Returns description of method parameters

    return: external_function_parameters

    create_notes($notes = array()   X-Ref
    Create notes about some users
    Note: code should be matching the /notes/edit.php checks
    and the /user/addnote.php checks. (they are similar cheks)

    return: array (success infos and fail infos)
    param: array $notes  An array of notes to create.

    create_notes_returns()   X-Ref
    Returns description of method result value

    return: external_description

    Search This Site: