https://github.com/catalyst/moodle-tool_metadata

Moodle Metadata API
https://github.com/catalyst/moodle-tool_metadata

Last synced: 3 days ago
JSON representation

Moodle Metadata API

• Host: GitHub
• URL: https://github.com/catalyst/moodle-tool_metadata
• Owner: catalyst
• Created: 2019-11-13T22:53:30.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2023-12-27T05:35:04.000Z (11 months ago)
• Last Synced: 2023-12-27T06:34:17.734Z (11 months ago)
• Language: PHP
• Size: 974 KB
• Stars: 1
• Watchers: 24
• Forks: 0
• Open Issues: 10
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Metadata API

[![Build Status](https://travis-ci.org/catalyst/moodle-tool_metadata.svg?branch=master)](https://travis-ci.org/catalyst/moodle-tool_metadata)

The Moodle Metadata API aims to create a programming interface for obtaining structured metadata from Moodle resources, the shape and type of metadata is determined by metadataextractor subplugins, the API itself is the framework for extracting this metadata and exposes the methods necessary to do so and associated scheduled tasks to conduct asynchronous extraction of metadata for resources.

## Subplugins

The Metadata API relies on subplugins of various types to populate metadata for consumption by Moodle users, so far this includes the following subplugin types:

__metadataextractor__: Metadata extractors are plugins which extract metadata from Moodle resources for use by the Metadata API, without an installed and enabled metadata extractor subplugin, no metadata can be populated by Moodle.

For developers, to create a __metadataextractor__ plugin, refer to the README in `/extractor` directory.

## API methods

API methods are static methods attached to the base class `tool_metadata\api` and can be called as follows: `\tool_metadata\api::extract_metadata($resourceinstance, $resourcetype, $extractor)`

See `\classes\api` method documentation for API method explanations.

## License ##

2020 Catalyst IT Australia

This program is free software: you can redistribute it and/or modify it under

the terms of the GNU General Public License as published by the Free Software

Foundation, either version 3 of the License, or (at your option) any later

version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY

WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A

PARTICULAR PURPOSE.  See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with

this program.  If not, see .

This plugin was developed by Catalyst IT Australia:

https://www.catalyst-au.net/