Skip to content

piotr-cz/joomla-customfields-vimeo

Repository files navigation

Joomla! Vimeo Custom Field Package

GitHub release Joomla 3 Joomla 4 PHP

This plugins lets you create new fields of type 'Vimeo' in any extensions where custom fields are supported.

Package contains following extensions:

  • Vimeo Fields plugin

    This plugin adds ability to add Vimeo to an article (or any other supported content) by defining Vimeo URL.

  • Vimeo Progress Content plugin

    This plugin adds ability to indicate seen Vimeo videos for logged-in users.
    It does it by adding

    • symbol indicator after an article title (✓)

    • progress bar after category and subcategory title (40%)

Requirements

  • Joomla 3.7+ or 4.0-beta.7+

  • PHP 7.1+

Installation

  1. Install

    • by pasting URL to zip file of latest release
      Extensions > Manage > Install > Install from URL

    • by downloading latest release and installing it using Extension Manager
      Extensions > Manage > Install > Upload Package File

  2. Enable Plugins
    Extensions > Plugins > Fields - Pcz - Vimeo > Enable
    Extensions > Plugins > Content - Pcz - Vimeo Progress > Enable (Optional)

Vimeo Fields plugin

Configuration

Custom field may be configured either

  • globally in plugin
    Extensions > Plugins > Fields - Pcz - Vimeo

  • per each field

Available settings

  • Aspect ratio

  • Disable on category views

  • Finished videos data store

  • All Vimeo Player Parameters (See Vimeo Help Center > Using Player Parameters)

    Notes:

    • Some parameters are available only on Vimeo Plus account or higher (Background, Color, Controls, Quality, Speed).

    • Some parameters have effect only if video owner allows (Byline, Portrait, Title).

      See Vimeo admin panel > Videos > [video] > Advanced > Embed > Your details > Let users decide

Vimeo progress Content plugin

Configuration

First of all, you have create storage where data about videos seen by users will be saved to. Plugin doesn't create it's own storage (like database table) but uses custom fields within user context.

To add finished Videos data store, add new field with type Vimeo Datastore

  1. Users > Fields > New

  2. Title: Videos seen by users (or any custom name)

  3. Type: Vimeo Datastore

  4. Optional: If you want to hide data from users, you may restrict Access level, set Options > Editable in: Site or set Options > Display when Read-Only: No

Now set up Vimeo Fields plugin to use the storage you just created:

  1. Extensions > Plugins > Fields - Pcz - Vimeo

  2. Finished videos data store: Videos seen by users (or custom name you entered)

Available settings

  • Enable for category

  • Enable for subcategories

  • Enable for articles

    • Article seen idicator

    • Article unseen indicator

  • Categories to process

  • Fields to process

Testing pre-releases

To allow updates for latest commit switch
Global Configuration > Installer > Minimum Extension Stability to Development.

Available extension update will show up as version 99.0.0-alpha and install as of latest commit from main branch of this repository.

Known issues

Joomla 4

  • Radio controls in plugin settings look different to Joomla 4 native ones.

    This is a aide effect of having extension compatible with both Jooma 3 and Joomla 4.