mvccore/ext-router-media

MvcCore - Extension - Router - Media - extension to manage website media versions (full/tablet/mobile) for different templates/CSS/JS files rendering, optionally contained in URL address in the beginning.

Maintainers

Details

github.com/mvccore/ext-router-media

Source

Issues

Installs: 301

Dependents: 3

Suggesters: 0

Security: 0

Stars: 1

Watchers: 2

Forks: 1

Open Issues: 0

v5.2.0 2023-12-12 13:07 UTC

Requires

BSD-3-Clause 1100227709c78577b5c4aa31a30bf2083d73a40e

frameworkroutingmediaaddresspluginversionmvcrouterextensionsiteroutesmobileflagtabletplug-inextfullmvccore

This package is auto-updated.

Last update: 2024-10-12 15:19:27 UTC

README

Latest Stable Version License PHP Version

MvcCore Router extension to manage your website media version in URL to have media flag in the request, controller and view to render different templates, CSS and js files for mobiles, tablets or desktops.

Outline

  1. Installation
  2. Features
    2.1. Features - Routing
    2.2. Features - Url Generating
  3. How It Works
    3.1. How It Works - Routing
    3.2. How It Works - Url Completing
  4. Usage
    4.1. Usage - Bootstrap Initialization
    4.2. Usage - Media Url Prefixes And Allowed Media Versions
  5. Advanced Configuration
    5.1. Advanced Configuration - Session Expiration
    5.2. Advanced Configuration - Strict Session Mode
    5.3. Advanced Configuration - Routing GET Requests Only

1. Installation

composer require mvccore/ext-router-media

go to top

2. Features

2.1. Features - Routing

  • Router works with requests with media site version prefix in URL address, prefixes are configurable.
  • Router recognizes user device as 3 predefined versions - full, tablet or mobile - in first request by HTTP header User-Agent with third-party \Mobile_Detect library.
  • Router redirects the first request if necessary to URL address with better media prefix, where is more suitable content for recognized device.
  • Router stores recognized device version string in its own session namespace with configurable expiration (to not process \Mobile_Detect recognition in every request again).
  • Router replaces possibly founded media prefix substring in request path ($request->GetPath()) with an empty string. It keeps request path every time in the same form to process routing as usual.
  • Router completes $request->GetMediaSiteVersion() value to use it anywhere in your app as strings: full, tablet or mobile.
  • Session strict mode for media site version (configurable) to drive application media version strictly by session value.

go to top

2.2. Features - Url Generating

  • Router completes every application URL (or every GET URL by configuration) generated by built-in Url() method with media prefix substring by requested media version or media version given as second argument array with URL params for Url() method.
  • There is also possible to configure the URL media version substring prefix.

go to top

3. How It Works

3.1. How It Works - Routing

  • Router completes media site versions from these sources:
    • From requested URL (if there is no media site prefix in URL, it's completed to full).
    • From session (if there is nothing, it stays on NULL).
    • From special $_GET param to switch media site version in session strict mode (also could be NULL).
  • Router process pre-route redirections by source data if necessary:
    • If there is allowed value in special $_GET switching param: - New media site version is stored in session and request is redirected to new media site version by special switching param.
    • Else if there is no media site version in session from any previous request: - There is recognized media site version by the third-party library \Mobile_Detect and stored in the session for next requests.
      • There is also completed flag if the detected version is the same as the requested version.
    • If strict session mode is configured to FALSE (by default):
      • If the request is first (nothing is in session from previous requests):
        • If the detected version is different from the request version:
          • Redirect user to detected version:
        • Else route request with requested media site version in a standard way later, do not process any redirections.
      • Else route request with requested media site version in a standard way later, do not process any redirections.
    • If strict session mode is configured to TRUE:
      • If the requested media site version is different from the session version:
        • Redirect user to session version.
      • Else route request with requested media site version in a standard way later, do not process any redirections.
  • Router removes any founded media site version URL prefix to process routing for any media site version with the same request path.
  • Then the router, routes request in a standard way.

go to top

3.2. How It Works - Url Completing

  • The router generates URL addresses always with the same media site version as requested media site version:
    • For addresses without any defined rewrite route, there is added into query string additional param about media site version (&media_version=...).
    • For addresses with defined rewrite route, there is prepended media site version URL prefix by router configuration.
  • If requested version is full (full is by default), there is not necessary to put into URL addresses any additional data, so for full version, there is always the same original URL string without any special params or prefixes.
  • If you define into build-in Url() method into second argument array into params any different media site version than requested media version is, there is added into result URL string query param or media site URL prefix by given media site version.
  • If there is configured session strict mode, special $_GET switching param is always added automatically.

go to top

4. Usage

4.1. Usage - Bootstrap Initialization

Add this to /App/Bootstrap.php or to very application beginning, before application routing or any other extension configuration using router for any purposes:

$app = \MvcCore\Application::GetInstance();
$app->SetRouterClass('\MvcCore\Ext\Routers\Media');
...
// to get router instance for next configuration:
/** @var \MvcCore\Ext\Routers\Media $router */
$router = \MvcCore\Router::GetInstance();

go to top

4.2. Usage - Media Url Prefixes And Allowed Media Versions

There are configured three media site versions with URL address prefixes by default:

use \MvcCore\Ext\Routers;
...
$router->SetAllowedMediaVersionsAndUrlValues([
    Routers\Media::MEDIA_VERSION_MOBILE	=> 'm',
    Routers\Media::MEDIA_VERSION_TABLET	=> 't',
    Routers\Media::MEDIA_VERSION_FULL	=> '',
]);

To allow only selected media site versions and to configure url prefixes, you can use:

// to allow only mobile version (with url prefix '/mobile') 
// and full version (with no url prefix):
use \MvcCore\Ext\Routers;
...
// now, tablet version is not allowed:
$router->SetAllowedMediaVersionsAndUrlValues([
    Routers\Media::MEDIA_VERSION_MOBILE	=> 'mobile',
    // if you are using an empty string url prefix for full version, 
    // you need to define it as the last item!
    Routers\Media::MEDIA_VERSION_FULL	=> '',
]);

go to top

5. Advanced Configuration

5.1. Advanced Configuration - Session Expiration

There is possible to change session expiration about detected media site version value to not recognize media site version every request where is no prefix in URL, because to process all regular expressions in \Mobile_Detect library could take some time. By default there is 1 hour. You can change it by:

$router->SetSessionExpirationSeconds(
    \MvcCore\Session::EXPIRATION_SECONDS_DAY
);

go to top

5.2. Advanced Configuration - Strict Session Mode

In session strict mode, there is not possible to change media site version only by requesting different media site version prefix in URL. Strict session mode is router mode when media site version is managed by session value from the first request recognition. All requests to different media site version than the version in session are automatically redirected to media site version stored in the session.

Normally, there is possible to get different media site version only by requesting different media site version URL prefix. For example - to get a different version from full version, for example, to get mobile version, it's only necessary to request application with configured mobile prefix in URL like this: /mobile/any/application/request/path.

In session strict mode, there is possible to change media site version only by special $_GET parameter in your media version navigation. For example - to get a different version from full version, for example, mobile version, you need to add into query string parameters like this: /any/application/request/path?switch_media_version=mobile Then, there is changed media site version stored in the session and the user is redirected to the mobile application version with mobile URL prefixes everywhere.

To have this session strict mode, you only need to configure router by:

$router->SetStricModeBySession(TRUE);

go to top

5.3. Advanced Configuration - Routing GET Requests Only

The router manages media site version only for GET requests. It means redirections to the proper version in session strict mode or to redirect in the first request to recognized media site version. POST requests and other request methods to manage for media site version doesn't make sense. For those requests, you have still media site version record in session and you can use it any time. But to process all request methods, you can configure the router to do so like this:

$router->SetRouteGetRequestsOnly(FALSE);

go to top