vdlp/oc-redirectconditions-plugin

Allows developers to create their own Redirect Conditions extension plugins for October CMS.

Maintainers

Details

github.com/vdlp/oc-redirectconditions-plugin

Source

Issues

Installs: 730

Dependents: 4

Suggesters: 0

Security: 0

Stars: 3

Watchers: 8

Forks: 2

Open Issues: 0

Type:october-plugin

1.3.1 2023-06-12 07:59 UTC

Requires

GPL-2.0-only e9f3f8d7607263ee9dfa7d5e500d277010836357

  • Van der Let & Partners <octobercms.woop@vdlp.nl>

This package is auto-updated.

Last update: 2024-12-14 15:52:41 UTC

README

Vdlp.RedirectConditions

This plugin allows developers to create their own Redirect conditions.

What is a Redirect Condition?

When a positive match occurs in the redirect engine, all registered redirect conditions will be checked if they pass. If one of the conditions does not pass the redirect will not take place.

A redirect condition must implement RedirectConditionInterface.

Each redirect condition must have:

  • getCode() - A unique code.
  • getDescription() - A short description.
  • getExplanation() - A brief explanation on when or how to use it.
  • getFormConfig() - A form configuration array.
  • passes(RedirectRule $rule, string $requestUri) - Logic whether the condition passes with the given $rule and $requestUri.

Requirements

  • The Vdlp.Redirect plugin.
  • PHP 8.0.2 or higher.
  • October CMS 3.0 or higher.

Example

This plugin contains an detailed implementation example (plugin). This plugin can be found at GitHub.