README

日本語版はこちら

OctoberCMS plugin to detect user's browser, OS, and device. This is available not only from PHP but also from Twig templates.

This is a wrapper plugin of jenssegers/agent. Thanks to jenssegers, and also serbanghita created it's base serbanghita/Mobile-Detect.

API

Please refer jenssegers/agent for available APIs.

Usage

Installation

You can install this plugin either via composer or from the backend UI.

With Composer

Execute below at the root of your project.

composer require pikanji/agent-plugin

With OctoberCMS UI

Login to OctoberCMS backend
Go to Settings > Update & Plugins.
Click "Install plugins" button.
Search for "Agent", and select it to start installation.

Using in Twig Templates

Agent object will be available after Agent component is added to pages or layouts. I recommend to add the component to your layout, so that you don't have to add every page.

Preparation is to add [Agent] to the configuration section of page or layout files. There is no parameter needed for Agent component.

description = "Default layout"

[Agent]
==
<!DOCTYPE html>
...

Then you can use this Agent object to call jenssegers/agent APIs.

...
{% if Agent.isFireFox() %}
...

Using in PHP Code

Add use Agent;, and call methods from Agent facade.

use Agent;
...

if (Agent::isFireFox()) {
...

If you don't want to use facade, you can use it like this.

use Jenssegers\Agent\Agent;
...

$agent = new Agent();
if ($agent->isFireFox()) {
...

It is just using jenssegers/agent directly. Please refer to its documentation. You don't need to install it since it is installed as the dependency of this plugin.

pikanji / agent-plugin

Maintainers

Details