adamjenkins/moodle-block_oerclient

Dashboard block for the OER Exchange platform: what this site has shared, and recent resources available on the Exchange.

Maintainers

Package info

github.com/adamjenkins/moodle-block_oerclient

Type:moodle-block

pkg:composer/adamjenkins/moodle-block_oerclient

Transparency log

Statistics

Installs: 0

Dependents: 0

Suggesters: 0

Stars: 0

Open Issues: 0

v1.0.3 2026-08-01 07:56 UTC

This package is auto-updated.

Last update: 2026-08-02 06:09:59 UTC


README

A Dashboard block for the OER Exchange platform's client-side plugin, local_oerclient. Install it alongside local_oerclient on a teacher's own Moodle site to give the Exchange a presence on the Dashboard, without navigating to a dedicated page first.

What it shows

  • Shared from this site — the site's own outgoing shares to the Exchange (course or activity), with their status (queued, building a backup, uploading, published, or failed). Read directly from the local database — no network call.
  • Recent OER available — a handful of the newest resources published on the connected Exchange, each leading with its cover-image thumbnail (a neutral panel of the same size where a resource has no cover, so rows stay aligned) and carrying its creator's name, fetched via the same search web service local_oerclient's browse page already uses. The thumbnail and creator-profile URLs arrive over the network from the Exchange, so both are passed through clean_param(..., PARAM_URL) before being rendered.

If the site isn't yet registered with an Exchange (or the Exchange can't be reached), the second panel shows a plain explanatory message instead of an error.

Requirements

  • local_oerclient must already be installed and configured (Exchange URL
    • site token) — this block declares it as a hard dependency in version.php, so Moodle's plugin installer will refuse to install this block without it.
  • Moodle 5.0–5.2 ($plugin->supported).

Installation

  1. Install local_oerclient first, if it isn't already, and complete its registration with an Exchange.
  2. Copy (or git clone) this repository into blocks/oerclient in your Moodle installation.
  3. Visit Site administration > Notifications to complete the install.
  4. Add the "OER Exchange" block to your Dashboard from the block drawer. Moodle always adds a new block to the side panel first — drag it into the main content column (below Course overview/Timeline) for better visibility; this is a one-time step per Dashboard.

License

GPL-3.0-or-later, see LICENSE.