Browscap PHP

https://github.com/browscap/browscap-php
Admin
Browscap PHP is a standalone replacement for PHP's native get_browser() function that detects...
Tokens:29,869
Snippets:418
Trust Score:8.1
License:MIT
Update:2 months ago
Show doc for...
Tokens:
Raw
### Advanced Setup Example

Source: https://github.com/browscap/browscap-php/blob/7.8.x/README.md

Configure the library using a Flysystem adapter for cache storage.

```php
$fileCache = new \League\Flysystem\Local\LocalFilesystemAdapter($cacheDir);
$filesystem = new \League\Flysystem\Filesystem($fileCache);
$cache = new \MatthiasMullie\Scrapbook\Psr16\SimpleCache(
    new \MatthiasMullie\Scrapbook\Adapters\Flysystem($filesystem)
);

$logger = new \Monolog\Logger('name');

$bc = new \BrowscapPHP\Browscap($cache, $logger);
$result = $bc->getBrowser();
```

--------------------------------

### Cache Configuration Examples

Source: https://github.com/browscap/browscap-php/blob/7.8.x/_autodocs/configuration.md

Examples showing how to integrate PSR-16 compatible cache implementations like Flysystem/Scrapbook or Symfony Cache.

```php
use Leagueilesystemilesystem;
use Leagueilesystemilesystemilesystem;
use Leagueilesystemilesystemilesystem;
use Leagueilesystemilesystemilesystem;

$fileAdapter = new LocalFilesystemAdapter('/var/cache/browscap');
$filesystem = new Filesystem($fileAdapter);
$cache = new SimpleCache(new Flysystem($filesystem));
$updater = new BrowscapUpdater($cache, $logger);
```

```php
// Symfony Cache
$cache = new \Symfony\Component\Cache\Psr16Cache(
    new \Symfony\Component\Cache\Adapter\FilesystemAdapter()
);
$updater = new BrowscapUpdater($cache, $logger);

// Any PSR-16 implementation works
```

--------------------------------

### Initialize BrowscapUpdater

Source: https://github.com/browscap/browscap-php/blob/7.8.x/_autodocs/browscap-updater.md

Examples for initializing the updater with default settings or custom proxy configurations.

```php
use BrowscapPHProwscapUpdater;
use Monolog
Logger;
use MatthiasMullie\Scrapbook\Psr16
SimpleCache;

$updater = new BrowscapUpdater($cache, new Logger('browscap'));
```

```php
use GuzzleHttp\Client;

$proxyConfig = [
    'proxy' => [
        'http'  => 'tcp://proxy.company.com:8125',
        'https' => 'tcp://proxy.company.com:8124',
    ],
];
$client = new Client($proxyConfig);
$updater = new BrowscapUpdater($cache, $logger, $client, 10);
```

--------------------------------

### HTTP Client Configuration Examples

Source: https://github.com/browscap/browscap-php/blob/7.8.x/_autodocs/configuration.md

Examples for customizing the Guzzle HTTP client, including proxy settings, timeouts, and authentication.

```php
use GuzzleHttp\Client;

$clientConfig = [
    'proxy' => [
        'http'  => 'tcp://proxy.company.com:8080',
        'https' => 'tcp://proxy.company.com:8080',
    ],
];
$client = new Client($clientConfig);
$updater = new BrowscapUpdater($cache, $logger, $client);
```

```php
$client = new Client([
    'timeout' => 30,  // Global timeout
]);
$updater = new BrowscapUpdater($cache, $logger, $client, 15);  // connectTimeout
```

```php
$client = new Client([
    'auth' => ['username', 'password'],
]);
$updater = new BrowscapUpdater($cache, $logger, $client);
```

--------------------------------

### Initialize Support with $_SERVER

Source: https://github.com/browscap/browscap-php/blob/7.8.x/_autodocs/helpers.md

Example of initializing the Support helper using the global $_SERVER array.

```php
$support = new Support($_SERVER);
$userAgent = $support->getUserAgent();
```

--------------------------------

### Usage Example for getSettings

Source: https://github.com/browscap/browscap-php/blob/7.8.x/_autodocs/parser-helpers.md

Demonstrates how to instantiate the helper and retrieve properties for a specific user agent pattern.

```php
$dataHelper = new GetData($cache, $logger, $quoter);
$properties = $dataHelper->getSettings('Mozilla.*Windows.*Chrome.*');
// Returns all properties, including inherited from parent patterns
```

--------------------------------

### Install Browscap PHP

Source: https://github.com/browscap/browscap-php/blob/7.8.x/README.md

Use Composer to add the library to your project dependencies.

```shell
composer require browscap/browscap-php
```

--------------------------------

### Fetch browscap.ini files

Source: https://github.com/browscap/browscap-php/blob/7.8.x/_autodocs/browscap-updater.md

Examples demonstrating how to fetch standard and full versions of the browscap.ini file.

```php
try {
    $updater->fetch('./browscap.ini');
    echo "File downloaded to ./browscap.ini";
} catch (BrowscapPHP
Exception
NoNewVersionException $e) {
    echo "Cache is already up to date";
} catch (BrowscapPHP
Exception
FetcherException $e) {
    echo "Download failed: " . $e->getMessage();
}
```

```php
use BrowscapPHP\Helper\IniLoaderInterface;

$updater->fetch('./browscap-full.ini', IniLoaderInterface::PHP_INI_FULL);
```

--------------------------------

### Initialize BrowscapCache

Source: https://github.com/browscap/browscap-php/blob/7.8.x/_autodocs/cache.md

Example showing how to instantiate BrowscapCache using a Scrapbook adapter and Monolog logger.

```php
use BrowscapPHP\/Cache\/BrowscapCache;
use MatthiasMullie\/Scrapbook\/Psr16\/SimpleCache;
use MatthiasMullie\/Scrapbook\/Adapters\/Flysystem;
use Monolog\/Logger;

$filesystem = new Flysystem(new LocalFilesystemAdapter('/cache'));
$cache = new SimpleCache($filesystem);
$logger = new Logger('browscap');

$browscapCache = new BrowscapCache($cache, $logger);
```

--------------------------------

### Handle missing cache

Source: https://github.com/browscap/browscap-php/blob/7.8.x/_autodocs/exceptions.md

Example demonstrating how to catch NoCachedVersionException and trigger an update.

```php
try {
    $updater->checkUpdate();
} catch (BrowscapPHP\Exception\NoCachedVersionException $e) {
    echo "Cache not initialized, run update first";
    $updater->update();
}
```

--------------------------------

### Constructor Injection Examples

Source: https://github.com/browscap/browscap-php/blob/7.8.x/_autodocs/interfaces.md

Demonstrates how major classes in Browscap-PHP accept dependencies via constructor injection.

```php
// Example: Parser helpers
$parser = new Parser\Ini(
    $patternHelper,      // GetPatternInterface
    $dataHelper,         // GetDataInterface
    $formatter           // FormatterInterface
);

// Example: Cache wrapper
$cache = new BrowscapCache(
    $psr16Cache,         // CacheInterface (PSR-16)
    $logger              // LoggerInterface (PSR-3)
);

// Example: Main updater
$updater = new BrowscapUpdater(
    $cache,              // CacheInterface
    $logger,             // LoggerInterface
    $httpClient,         // ClientInterface (Guzzle)
    $timeout             // int
);
```

--------------------------------

### Initialize Support with HTTP headers

Source: https://github.com/browscap/browscap-php/blob/7.8.x/_autodocs/types.md

Example of passing an array of HTTP headers to the Support class to retrieve the User-Agent.

```php
$headers = [
    'HTTP_USER_AGENT' => 'Mozilla/5.0 (Windows NT 10.0; Win64; x64)',
    'HTTP_X_FORWARDED_FOR' => '192.168.1.1',
];
$support = new Support($headers);
$ua = $support->getUserAgent();  // Returns the User-Agent value
```

--------------------------------

### Configure PSR-3 Logger

Source: https://github.com/browscap/browscap-php/blob/7.8.x/_autodocs/configuration.md

Examples of integrating Monolog or a NullLogger with the BrowscapUpdater.

```php
use Monolog\Logger;
use Monolog\Handlers\StreamHandler;

$logger = new Logger('browscap');
$logger->pushHandler(new StreamHandler('/var/log/browscap.log'));
$updater = new BrowscapUpdater($cache, $logger);
```

```php
use Psr\Log\NullLogger;

$logger = new NullLogger();
$updater = new BrowscapUpdater($cache, $logger);
```

--------------------------------

### GetPattern Usage Example

Source: https://github.com/browscap/browscap-php/blob/7.8.x/_autodocs/parser-helpers.md

Demonstrates how the helper is used internally by the Ini parser to iterate through potential matches.

```php
$patternHelper = new GetPattern($cache, $logger);
foreach ($patternHelper->getPatterns('Mozilla/5.0...') as $patterns) {
    // Try to match each pattern against user agent
}
```

--------------------------------

### Handle current cache version

Source: https://github.com/browscap/browscap-php/blob/7.8.x/_autodocs/exceptions.md

Example demonstrating how to catch NoNewVersionException when the local cache is already up to date.

```php
try {
    $updater->update();
} catch (BrowscapPHP\Exception\NoNewVersionException $e) {
    echo "Cache is already current, no update needed";
}
```

--------------------------------

### Retrieve lowercase output

Source: https://github.com/browscap/browscap-php/blob/7.8.x/_autodocs/formatters.md

Example demonstrating how to retrieve data with property names converted to lowercase.

```php
$formatter = new LegacyFormatter(['lowercase' => true]);
$formatter->setData(['Browser' => 'Firefox']);
$data = $formatter->getData();
echo $data->browser;  // "Firefox" (property name lowercased)
```

--------------------------------

### Instantiate LegacyFormatter with lowercase option

Source: https://github.com/browscap/browscap-php/blob/7.8.x/_autodocs/formatters.md

Example of initializing the formatter with the lowercase option enabled.

```php
$formatter = new \BrowscapPHP\Formatter\LegacyFormatter(['lowercase' => true]);
```

--------------------------------

### Get Browser from Sample User Agent

Source: https://github.com/browscap/browscap-php/blob/7.8.x/README.md

Retrieves browser information for a specific provided user agent string.

```php
$bc = new \BrowscapPHP\Browscap($cache, $logger);
$current_browser = $bc->getBrowser($the_user_agent);
```

--------------------------------

### Catch fetch errors

Source: https://github.com/browscap/browscap-php/blob/7.8.x/_autodocs/exceptions.md

Example demonstrating how to catch FetcherException when an update operation fails.

```php
try {
    $updater->update();
} catch (BrowscapPHP\Exception\FetcherException $e) {
    echo "Failed to fetch update: " . $e->getMessage();
}
```

--------------------------------

### Detect and Output User Agent

Source: https://github.com/browscap/browscap-php/blob/7.8.x/_autodocs/helpers.md

Example usage of getUserAgent to detect and display the user agent string.

```php
$support = new Support($_SERVER);
$ua = $support->getUserAgent();
echo "Detected: " . $ua;
```

--------------------------------

### Structure Formatter data array

Source: https://github.com/browscap/browscap-php/blob/7.8.x/_autodocs/types.md

Example of the associative array structure expected by the Formatter.

```php
[
    'Browser' => 'Chrome',
    'Version' => '96.0',
    'Platform' => 'Win32',
    'isMobileDevice' => false,
    'Parent' => 'Default Browser',
    'Device_Name' => 'Desktop',
    // ... many more properties
]
```

--------------------------------

### Parse User Agent String

Source: https://github.com/browscap/browscap-php/blob/7.8.x/_autodocs/parsers.md

Example usage of the getBrowser method to retrieve and display browser data.

```php
$parser = $browscap->getParser();
$formatter = $parser->getBrowser('Mozilla/5.0 (Windows NT 10.0; Win64; x64)');

if ($formatter !== null) {
    $data = $formatter->getData();
    echo $data->Browser;
}
```

--------------------------------

### Use getPropertyType Method

Source: https://github.com/browscap/browscap-php/blob/7.8.x/_autodocs/helpers.md

Example usage of the getPropertyType method to determine property types.

```php
$holder = new PropertyHolder();
$type = $holder->getPropertyType('Version');  // Returns TYPE_NUMBER
$type = $holder->getPropertyType('Browser');   // Returns TYPE_STRING
```

--------------------------------

### Accessing BrowserData properties

Source: https://github.com/browscap/browscap-php/blob/7.8.x/_autodocs/types.md

Example of retrieving browser data for a specific user agent string and accessing its properties.

```php
$result = $browscap->getBrowser('Mozilla/5.0 (iPhone; CPU iPhone OS 14_0 like Mac OS X)');

// Type: stdClass
// Typical properties would be:
// $result->Browser = "iPhone"
// $result->Platform = "iOS"
// $result->isMobileDevice = true
// $result->isTablet = false
// $result->Device_Type = "Mobile Device"
```

--------------------------------

### Formatting Property Values

Source: https://github.com/browscap/browscap-php/blob/7.8.x/_autodocs/helpers.md

Example usage of the formatPropertyValue method to convert raw values into typed results.

```php
$holder = new PropertyHolder();
$formatter = new PropertyFormatter($holder);
$result = $formatter->formatPropertyValue('true', 'isMobileDevice');  // Returns bool true
$result = $formatter->formatPropertyValue('Chrome', 'Browser');        // Returns 'Chrome'
```

--------------------------------

### Get Browser from Global Server Variable

Source: https://github.com/browscap/browscap-php/blob/7.8.x/README.md

Retrieves browser information based on the current request's user agent.

```php
$bc = new \BrowscapPHP\Browscap();
$current_browser = $bc->getBrowser();
```

--------------------------------

### Initialize Cache

Source: https://github.com/browscap/browscap-php/blob/7.8.x/_autodocs/quick-reference.md

Set up the filesystem and cache adapters required for storing browscap.ini data.

```php
use BrowscapPHProwscapUpdater;
use League\Flysystem\Filesystem;
use League\Flysystem\Local\LocalFilesystemAdapter;
use MatthiasMullie\Scrapbook\Adapters\Flysystem;
use MatthiasMullie\Scrapbook\Psr16\SimpleCache;
use Monolog\Logger;

$cacheDir = '/var/cache/browscap';
$fileAdapter = new LocalFilesystemAdapter($cacheDir);
$filesystem = new Filesystem($fileAdapter);
$cache = new SimpleCache(new Flysystem($filesystem));
$logger = new Logger('browscap');

// Download and cache browscap.ini data
$updater = new BrowscapUpdater($cache, $logger);
$updater->update();  // Download and parse from remote
```

--------------------------------

### Initialize BrowscapUpdater

Source: https://github.com/browscap/browscap-php/blob/7.8.x/_autodocs/README.md

Instantiate the updater with required PSR-16 cache and PSR-3 logger implementations.

```php
new BrowscapUpdater(
    CacheInterface $cache,           // Required: PSR-16 cache
    LoggerInterface $logger,         // Required: PSR-3 logger
    ?ClientInterface $client = null, // Optional: Guzzle HTTP client
    int $connectTimeout = 5          // Optional: HTTP timeout
)
```

--------------------------------

### Initialize Support Class

Source: https://github.com/browscap/browscap-php/blob/7.8.x/_autodocs/helpers.md

Constructor for the Support class, accepting an optional array of HTTP headers or server variables.

```php
public function __construct(?array $source = null)
```

--------------------------------

### Implement Custom Formatter

Source: https://github.com/browscap/browscap-php/blob/7.8.x/_autodocs/interfaces.md

Demonstrates implementing the FormatterInterface and registering it with the Browscap instance.

```php
class CustomFormatter implements FormatterInterface
{
    public function setData(array $settings): void { }
    public function getData(): stdClass { }
}

$browscap->setFormatter(new CustomFormatter());
```

--------------------------------

### Initialize Browscap Cache

Source: https://github.com/browscap/browscap-php/blob/7.8.x/_autodocs/README.md

Configure the cache and logger before performing updates. Ensure the cache directory is writable.

```php
use BrowscapPHProwscapUpdater;
use League\Flysystem\Filesystem;
use League\Flysystem\Local\LocalFilesystemAdapter;
use MatthiasMullie\Scrapbook\Adapters\Flysystem;
use MatthiasMullie\Scrapbook\Psr16\SimpleCache;
use Monolog\Logger;

$cache = new SimpleCache(new Flysystem(
    new Filesystem(new LocalFilesystemAdapter('/var/cache/browscap'))
));
$logger = new Logger('browscap');

$updater = new BrowscapUpdater($cache, $logger);
$updater->update();  // Download and cache browscap.ini
```

--------------------------------

### Implement Custom Parser

Source: https://github.com/browscap/browscap-php/blob/7.8.x/_autodocs/interfaces.md

Demonstrates implementing the ParserInterface and registering it with the Browscap instance.

```php
class CustomParser implements ParserInterface
{
    public function getBrowser(string $userAgent): ?FormatterInterface
    {
        // Custom implementation
    }
}

$browscap->setParser(new CustomParser());
```

--------------------------------

### Initialize Browscap with File Cache

Source: https://github.com/browscap/browscap-php/blob/7.8.x/_autodocs/browscap.md

Configures the Browscap instance using PSR-16 cache and PSR-3 logger implementations.

```php
use BrowscapPHP\Browscap;
use League\Flysystem\Local\LocalFilesystemAdapter;
use League\Flysystem\Filesystem;
use MatthiasMullie\Scrapbook\Adapters\Flysystem;
use MatthiasMullie\Scrapbook\Psr16\SimpleCache;
use Monolog\Logger;

$fileCache = new LocalFilesystemAdapter('/var/cache/browscap');
$filesystem = new Filesystem($fileCache);
$cache = new SimpleCache(new Flysystem($filesystem));
$logger = new Logger('browscap');

$browscap = new Browscap($cache, $logger);
```

--------------------------------

### GetData Constructor

Source: https://github.com/browscap/browscap-php/blob/7.8.x/_autodocs/parser-helpers.md

Initializes the helper with cache, logger, and quoter dependencies.

```php
public function __construct(
    BrowscapCacheInterface $cache,
    LoggerInterface $logger,
    QuoterInterface $quoter
)
```

--------------------------------

### Check for updates before performing an update

Source: https://github.com/browscap/browscap-php/blob/7.8.x/_autodocs/browscap-updater.md

Example usage of checkUpdate to verify if an update is required before calling the update method.

```php
try {
    $currentVersion = $updater->checkUpdate();
    echo "Cache version: $currentVersion, update available";
    $updater->update();
} catch (BrowscapPHP
Exception
NoNewVersionException $e) {
    echo "No update needed, cache is current";
}
```

--------------------------------

### Initialize Browscap and Retrieve Browser Data

Source: https://github.com/browscap/browscap-php/blob/7.8.x/_autodocs/architecture.md

Instantiate the Browscap class with cache and logger dependencies to perform user agent lookups.

```php
// User-facing entry point
$browscap = new Browscap($cache, $logger);
$result = $browscap->getBrowser('User-Agent-String');
```

--------------------------------

### BrowscapCache::__construct

Source: https://github.com/browscap/browscap-php/blob/7.8.x/_autodocs/cache.md

Initializes the cache wrapper with a PSR-16 cache adapter and a PSR-3 logger.

```APIDOC
## __construct

### Description
Initializes the cache wrapper with a PSR-16 cache adapter and logger.

### Parameters
- **adapter** (Psr\SimpleCache\CacheInterface) - Required - PSR-16 compatible cache.
- **logger** (Psr\Log\LoggerInterface) - Required - PSR-3 logger for error logging.

### Example
```php
$browscapCache = new BrowscapCache($cache, $logger);
```
```

--------------------------------

### Fetch File via CLI

Source: https://github.com/browscap/browscap-php/blob/7.8.x/_autodocs/quick-reference.md

Download the browscap.ini file without converting it.

```bash
vendor/bin/browscap-php browscap:fetch --file ./browscap.ini
```

--------------------------------

### Project File Structure

Source: https://github.com/browscap/browscap-php/blob/7.8.x/_autodocs/README.md

Overview of the project directory layout and documentation files.

```text
output/
├── README.md                 # This file
├── quick-reference.md        # Installation, basic usage, CLI
├── browscap.md              # Browscap class reference
├── browscap-updater.md      # BrowscapUpdater class reference
├── cache.md                 # BrowscapCache class reference
├── parsers.md               # Parser implementations
├── formatters.md            # Formatter implementations
├── helpers.md               # Helper utilities
├── ini-parser.md            # INI parsing details
├── parser-helpers.md        # Pattern/data helpers
├── exceptions.md            # Exception types
├── types.md                 # Type definitions
├── configuration.md         # Setup and options
├── interfaces.md            # Contracts and extension points
└── architecture.md          # System design overview
```

--------------------------------

### Fetch and Convert Cache

Source: https://github.com/browscap/browscap-php/blob/7.8.x/README.md

Download and convert the browscap.ini file into a cache format using CLI commands.

```shell
vendor/bin/browscap-php browscap:fetch
vendor/bin/browscap-php browscap:convert
```

--------------------------------

### Browscap::__construct

Source: https://github.com/browscap/browscap-php/blob/7.8.x/_autodocs/browscap.md

Initializes a new Browscap instance with required cache and logger dependencies.

```APIDOC
## Browscap::__construct

### Description
Initializes a new Browscap instance with cache and logger dependencies.

### Parameters
- **cache** (Psr\SimpleCache\CacheInterface) - Required - PSR-16 compatible cache implementation for storing parsed browser data
- **logger** (Psr\Log\LoggerInterface) - Required - PSR-3 compatible logger for recording operations and errors
```

--------------------------------

### PhpGetBrowser::__construct

Source: https://github.com/browscap/browscap-php/blob/7.8.x/_autodocs/formatters.md

Initializes a new instance of the PhpGetBrowser formatter.

```APIDOC
## PhpGetBrowser::__construct

### Description
Initializes a new instance of the PhpGetBrowser formatter. No parameters are required.

### Example
```php
$formatter = new \BrowscapPHP\Formatter\PhpGetBrowser();
```
```

--------------------------------

### IniLoader::__construct()

Source: https://github.com/browscap/browscap-php/blob/7.8.x/_autodocs/helpers.md

Initializes a new instance of the IniLoader class with default browscap.org URLs.

```APIDOC
## __construct()

### Description
Initializes a new instance of the IniLoader class. No parameters are required.

### Signature
`public function __construct()`
```

--------------------------------

### Support::__construct

Source: https://github.com/browscap/browscap-php/blob/7.8.x/_autodocs/helpers.md

Initializes the Support helper with an optional array of HTTP headers or server variables.

```APIDOC
## Support::__construct

### Description
Initializes the support helper with an array of HTTP headers/server variables.

### Parameters
- **source** (array<string, mixed>|null) - Optional - Associative array of headers/variables; if null, uses empty array.

### Example
```php
$support = new Support($_SERVER);
```
```

--------------------------------

### fetch(string $file, string $remoteFile)

Source: https://github.com/browscap/browscap-php/blob/7.8.x/_autodocs/browscap-updater.md

Fetches a remote browscap.ini file from browscap.org and stores it in a local file. Version checking ensures the file is only downloaded if a newer version is available.

```APIDOC
## fetch(string $file, string $remoteFile)

### Description
Fetches a remote browscap.ini file from browscap.org and stores it in a local file. Version checking ensures the file is only downloaded if a newer version is available remotely.

### Parameters
- **file** (string) - Required - Local file path where to save the downloaded INI file
- **remoteFile** (string) - Optional - Remote file type: PHP_INI (standard), Lite_PHP_BrowscapINI, or Full_PHP_BrowscapINI. Defaults to PHP_INI.

### Returns
void

### Throws
- BrowscapPHP\Exception\NoNewVersionException: If local cache has same or newer version than remote
- BrowscapPHP\Exception\NoCachedVersionException: If no cached version exists
- BrowscapPHP\Exception\FetcherException: If HTTP request fails or remote file is empty
- BrowscapPHP\Exception\ErrorCachedVersionException: If error reading cached version

### Example
```php
try {
    $updater->fetch('./browscap.ini');
    echo "File downloaded to ./browscap.ini";
} catch (BrowscapPHP\Exception\NoNewVersionException $e) {
    echo "Cache is already up to date";
} catch (BrowscapPHP\Exception\FetcherException $e) {
    echo "Download failed: " . $e->getMessage();
}
```
```

--------------------------------

### Configure File-based Cache Adapter

Source: https://github.com/browscap/browscap-php/blob/7.8.x/_autodocs/configuration.md

Use this adapter for simple deployments with small memory requirements.

```php
new LocalFilesystemAdapter('/var/cache/browscap')
```

--------------------------------

### GetPattern Constructor

Source: https://github.com/browscap/browscap-php/blob/7.8.x/_autodocs/parser-helpers.md

Initializes the helper with cache and logger dependencies.

```php
public function __construct(BrowscapCacheInterface $cache, LoggerInterface $logger)
```

--------------------------------

### Initialize LegacyFormatter

Source: https://github.com/browscap/browscap-php/blob/7.8.x/_autodocs/formatters.md

Constructor signature for initializing the formatter.

```php
public function __construct(array $options = [])
```

--------------------------------

### Initialize IniParser

Source: https://github.com/browscap/browscap-php/blob/7.8.x/_autodocs/ini-parser.md

The constructor requires no parameters.

```php
public function __construct()
```

--------------------------------

### getSettings Method Signature

Source: https://github.com/browscap/browscap-php/blob/7.8.x/_autodocs/parser-helpers.md

Retrieves browser properties for a pattern, recursively loading and merging parent properties.

```php
public function getSettings(string $pattern, array $settings = []): array
```

--------------------------------

### Execute Browscap-PHP CLI Commands

Source: https://github.com/browscap/browscap-php/blob/7.8.x/_autodocs/README.md

Use these commands to manage updates, fetch files, convert INI files, and parse user agents via the command line.

```bash
# Download and cache (main command)
vendor/bin/browscap-php browscap:update

# Check for updates
vendor/bin/browscap-php browscap:check-update

# Fetch remote file
vendor/bin/browscap-php browscap:fetch --file ./browscap.ini

# Convert local INI
vendor/bin/browscap-php browscap:convert --file ./browscap.ini

# Parse user agent
vendor/bin/browscap-php browscap:parse --user-agent "Mozilla/5.0..."
```

--------------------------------

### BrowscapUpdater Constructor Signature

Source: https://github.com/browscap/browscap-php/blob/7.8.x/_autodocs/browscap-updater.md

The constructor signature for initializing the updater.

```php
public function __construct(
    CacheInterface $cache,
    LoggerInterface $logger,
    ?ClientInterface $client = null,
    int $connectTimeout = self::DEFAULT_TIMEOUT
)
```

--------------------------------

### CLI Fetch Command

Source: https://github.com/browscap/browscap-php/blob/7.8.x/_autodocs/configuration.md

Fetch browser data from a remote source and save it to a local file.

```bash
vendor/bin/browscap-php browscap:fetch \
    --remote-file <type>  # Remote file type
    --cache <path>        # Cache directory
    --file <path>         # Local file to save to
```

--------------------------------

### Instantiate PhpGetBrowser

Source: https://github.com/browscap/browscap-php/blob/7.8.x/_autodocs/formatters.md

Constructor for the PhpGetBrowser formatter, which requires no parameters.

```php
public function __construct()
```

```php
$formatter = new \BrowscapPHP\Formatter\PhpGetBrowser();
```

--------------------------------

### Access Parser via Browscap

Source: https://github.com/browscap/browscap-php/blob/7.8.x/_autodocs/parsers.md

Demonstrates how the Browscap class internally creates the parser instance.

```php
// The Browscap class creates this internally
$parser = $browscap->getParser();
// $parser is an instance of Parser\Ini
```

--------------------------------

### Configure Custom Cache

Source: https://github.com/browscap/browscap-php/blob/7.8.x/_autodocs/interfaces.md

Shows how to inject a custom PSR-16 cache implementation into the BrowscapUpdater.

```php
$customCache = new CustomPsr16Cache();
$updater = new BrowscapUpdater($customCache, $logger);
```

--------------------------------

### Initialize Cache Updates

Source: https://github.com/browscap/browscap-php/blob/7.8.x/_autodocs/architecture.md

Use the BrowscapUpdater to fetch and process remote browser capability files.

```php
// Cache setup entry point
$updater = new BrowscapUpdater($cache, $logger);
$updater->update();
```

--------------------------------

### Query Phase Workflow

Source: https://github.com/browscap/browscap-php/blob/7.8.x/_autodocs/architecture.md

Visual representation of the user agent matching process from input to formatted output.

```text
User Agent String
        ↓
Browscap (parse request)
        ↓
Parser\Ini (match patterns)
        ↓
GetPattern (fetch candidates from cache)
        ↓
Regex matching (against patterns)
        ↓
GetData (fetch properties from cache)
        ↓
Formatter (format output)
        ↓
stdClass Object
```

--------------------------------

### Define Support::__construct signature

Source: https://github.com/browscap/browscap-php/blob/7.8.x/_autodocs/types.md

The constructor accepts an optional associative array matching the structure of $_SERVER.

```php
/**
 * @param array<string, mixed>|null $source
 */
public function __construct(?array $source = null);
```

--------------------------------

### LegacyFormatter::__construct

Source: https://github.com/browscap/browscap-php/blob/7.8.x/_autodocs/formatters.md

Initializes the LegacyFormatter with optional configuration settings.

```APIDOC
## __construct(array $options = [])

### Description
Initializes the formatter with optional configuration settings.

### Parameters
- **options** (array{lowercase?: bool}) - Optional - Formatting options; `lowercase => true` converts property names to lowercase.

### Example
```php
$formatter = new \BrowscapPHP\Formatter\LegacyFormatter(['lowercase' => true]);
```
```

--------------------------------

### Update with full version

Source: https://github.com/browscap/browscap-php/blob/7.8.x/_autodocs/browscap-updater.md

Update the cache using the full version of the browscap.ini file.

```php
use BrowscapPHP\Helper\IniLoaderInterface;

$updater->update(IniLoaderInterface::PHP_INI_FULL);
```

--------------------------------

### Configure Browscap Instance

Source: https://github.com/browscap/browscap-php/blob/7.8.x/_autodocs/configuration.md

Customize the Browscap instance by injecting a custom formatter or parser.

```php
$browscap = new Browscap($cache, $logger);

// Use custom formatter
$formatter = new LegacyFormatter(['lowercase' => true]);
$browscap->setFormatter($formatter);

// Use custom parser
$customParser = new CustomParserImplementation();
$browscap->setParser($customParser);
```

--------------------------------

### Update Cache in One Step

Source: https://github.com/browscap/browscap-php/blob/7.8.x/README.md

Download and convert the cache in a single command, checking for remote updates automatically.

```shell
vendor/bin/browscap-php browscap:update
```

--------------------------------

### Download and Cache Data via CLI

Source: https://github.com/browscap/browscap-php/blob/7.8.x/_autodocs/quick-reference.md

Update the local cache using different remote file versions or custom directories.

```bash
# Standard file (recommended)
vendor/bin/browscap-php browscap:update

# Lite version (smaller, mobile-focused)
vendor/bin/browscap-php browscap:update --remote-file Lite_PHP_BrowscapINI

# Full version (comprehensive)
vendor/bin/browscap-php browscap:update --remote-file Full_PHP_BrowscapINI

# Custom cache directory
vendor/bin/browscap-php browscap:update --cache /custom/cache/path
```

--------------------------------

### convertFile(string $iniFile)

Source: https://github.com/browscap/browscap-php/blob/7.8.x/_autodocs/browscap-updater.md

Reads a local browscap.ini file and parses its contents into the cache.

```APIDOC
## convertFile(string $iniFile)

### Description
Reads a local browscap.ini file and parses its contents into the cache.

### Parameters
- **iniFile** (string) - Required - Absolute or relative path to browscap.ini file to convert

### Throws
- BrowscapPHP\Exception\FileNameMissingException - If iniFile is empty
- BrowscapPHP\Exception\FileNotFoundException - If file does not exist or is not readable
- BrowscapPHP\Exception\ErrorReadingFileException - If error occurs while reading file contents

### Example
```php
$updater = new BrowscapUpdater($cache, $logger);
try {
    $updater->convertFile('/tmp/browscap.ini');
    echo "Cache updated successfully";
} catch (BrowscapPHP\Exception\FileNotFoundException $e) {
    echo "File not found: " . $e->getMessage();
} catch (BrowscapPHP\Exception\FileNameMissingException $e) {
    echo "File name required";
}
```
```

--------------------------------

### browscap:fetch

Source: https://github.com/browscap/browscap-php/blob/7.8.x/README.md

Downloads an ini file from browscap.org to a local destination.

```APIDOC
## browscap:fetch

### Description
The `fetch` command downloads an ini file from browscap.org.

### Options
- **cache** (string) - Optional - The relative path to your cache directory.
- **remote-file** (string) - Optional - The type of file to download (PHP_BrowscapINI, Lite_PHP_BrowscapINI, Full_PHP_BrowscapINI).
- **file** (string) - Optional - The relative path to the local file where the remote content is stored.

### Return Codes
- 3: Error checking cached version
- 9: Error fetching remote data
- 10: Other error
```

--------------------------------

### Configure Proxy for Updates

Source: https://github.com/browscap/browscap-php/blob/7.8.x/README.md

Sets up a custom Guzzle client with proxy settings for the BrowscapUpdater.

```php
$proxyConfig = [
    'proxy' => [
        'http'  => 'tcp://localhost:8125',
        'https' => 'tcp://localhost:8124',
    ],
];
$client = new \GuzzleHttp\Client($proxyConfig);
$bcu = new BrowscapUpdater();
$bcu->setClient($client);
```

--------------------------------

### CLI Common Options

Source: https://github.com/browscap/browscap-php/blob/7.8.x/_autodocs/configuration.md

Standard cache directory configuration for CLI commands.

```bash
--cache <path>           # Cache directory (default: vendor/browscap resources)
```

--------------------------------

### convertFile Method

Source: https://github.com/browscap/browscap-php/blob/7.8.x/_autodocs/helpers.md

Reads a local INI file and converts it into cache entries.

```php
public function convertFile(string $iniFile): void
```

--------------------------------

### BrowscapCache Constructor Signature

Source: https://github.com/browscap/browscap-php/blob/7.8.x/_autodocs/cache.md

The constructor signature for initializing the cache wrapper.

```php
public function __construct(CacheInterface $adapter, LoggerInterface $logger)
```

--------------------------------

### Converter::__construct

Source: https://github.com/browscap/browscap-php/blob/7.8.x/_autodocs/helpers.md

Initializes the converter with a logger and cache interface.

```APIDOC
## __construct

### Description
Initializes the converter with logger and cache.

### Parameters
- **logger** (Psr\Log\LoggerInterface) - Required - Logger for operation logging
- **cache** (BrowscapPHP\Cache\BrowscapCacheInterface) - Required - Cache for storing parsed data
```

--------------------------------

### BrowscapUpdater Constructor

Source: https://github.com/browscap/browscap-php/blob/7.8.x/_autodocs/README.md

Initializes the updater service required to fetch and update browser capability data.

```APIDOC
## BrowscapUpdater Constructor

### Description
Initializes a new instance of the BrowscapUpdater to manage browser data updates.

### Parameters
- **cache** (CacheInterface) - Required - PSR-16 cache implementation.
- **logger** (LoggerInterface) - Required - PSR-3 logger implementation.
- **client** (ClientInterface) - Optional - Guzzle HTTP client for remote requests.
- **connectTimeout** (int) - Optional - HTTP connection timeout in seconds (default: 5).
```

--------------------------------

### Implement PhpGetBrowser Formatter

Source: https://github.com/browscap/browscap-php/blob/7.8.x/_autodocs/formatters.md

Default formatter implementation that outputs data compatible with PHP's native get_browser() function.

```php
final class PhpGetBrowser implements FormatterInterface
{
    public function setData(array $settings): void
    public function getData(): stdClass
}
```

--------------------------------

### Initialize Ini Parser Constructor

Source: https://github.com/browscap/browscap-php/blob/7.8.x/_autodocs/parsers.md

Constructor signature for the Ini parser, requiring pattern, data, and formatter helper components.

```php
public function __construct(
    GetPatternInterface $patternHelper,
    GetDataInterface $dataHelper,
    FormatterInterface $formatter
)
```

--------------------------------

### Configure In-memory Cache Adapter

Source: https://github.com/browscap/browscap-php/blob/7.8.x/_autodocs/configuration.md

Use this adapter exclusively for development purposes.

```php
new \Symfony\Component\Cache\Adapter\ArrayAdapter()
```

--------------------------------

### Set data for LegacyFormatter

Source: https://github.com/browscap/browscap-php/blob/7.8.x/_autodocs/formatters.md

Method signature for storing raw settings.

```php
public function setData(array $settings): void
```

--------------------------------

### Converter Constructor

Source: https://github.com/browscap/browscap-php/blob/7.8.x/_autodocs/helpers.md

Initializes the converter with a logger and cache implementation.

```php
public function __construct(LoggerInterface $logger, BrowscapCacheInterface $cache)
```

--------------------------------

### Fetch browser capability data

Source: https://github.com/browscap/browscap-php/blob/7.8.x/README.md

Downloads an ini file from browscap.org to a local destination.

```bash
vendor/bin/browscap-php browscap:fetch
```

--------------------------------

### Check update before execution

Source: https://github.com/browscap/browscap-php/blob/7.8.x/_autodocs/exceptions.md

Pattern for verifying update availability before triggering the update process, handling initialization scenarios.

```php
try {
    $updater->checkUpdate();
    echo "Update available, proceeding...";
} catch (BrowscapPHP
Exception
NoNewVersionException $e) {
    echo "Already current";
} catch (BrowscapPHP
Exception
NoCachedVersionException $e) {
    echo "Initializing cache...";
    $updater->update();
}
```

--------------------------------

### Identify User Agent

Source: https://github.com/browscap/browscap-php/blob/7.8.x/README.md

Initialize the Browscap instance with a PSR-16 cache and PSR-3 logger to retrieve browser information.

```php
$cache = new \MatthiasMullie\Scrapbook\Psr16\SimpleCache($doctrineFileCache); // or maybe any other PSR-16 compatible caches
$logger = new \Monolog\Logger('name'); // or maybe any other PSR-3 compatible logger

$browscap = new \BrowscapPHP\Browscap($cache, $logger);
$info = $browscap->getBrowser();
```

--------------------------------

### Catch Browscap Base Exception

Source: https://github.com/browscap/browscap-php/blob/7.8.x/_autodocs/exceptions.md

Demonstrates how to catch library-specific exceptions when calling getBrowser().

```php
try {
    $browser = $browscap->getBrowser();
} catch (BrowscapPHP\Exception $e) {
    echo "Browscap error: " . $e->getMessage();
}
```

--------------------------------

### Define fetch method signature

Source: https://github.com/browscap/browscap-php/blob/7.8.x/_autodocs/browscap-updater.md

The method signature for fetching a remote browscap.ini file.

```php
public function fetch(string $file, string $remoteFile = IniLoaderInterface::PHP_INI): void
```

--------------------------------

### Browscap::getParser

Source: https://github.com/browscap/browscap-php/blob/7.8.x/_autodocs/browscap.md

Returns the current parser instance.

```APIDOC
## Browscap::getParser

### Description
Returns the current parser instance, creating the default parser if not already initialized.

### Returns
- **ParserInterface** - The configured parser instance, or a newly created default INI parser
```

--------------------------------

### Implement Ini Parser

Source: https://github.com/browscap/browscap-php/blob/7.8.x/_autodocs/parsers.md

The default parser implementation for matching user agent strings against INI-based patterns.

```php
final class Ini implements ParserInterface
{
    public function __construct(
        GetPatternInterface $patternHelper,
        GetDataInterface $dataHelper,
        FormatterInterface $formatter
    )
    public function getBrowser(string $userAgent): ?FormatterInterface
}
```

--------------------------------

### Define NoNewVersionException class

Source: https://github.com/browscap/browscap-php/blob/7.8.x/_autodocs/exceptions.md

The NoNewVersionException class definition extending DomainException.

```php
final class NoNewVersionException extends DomainException
```

--------------------------------

### Execute CLI Commands

Source: https://github.com/browscap/browscap-php/blob/7.8.x/_autodocs/architecture.md

Run library maintenance tasks or test parsing directly from the command line.

```bash
vendor/bin/browscap-php browscap:update
vendor/bin/browscap-php browscap:parse --user-agent "..."
```

--------------------------------

### Retrieve Release Date

Source: https://github.com/browscap/browscap-php/blob/7.8.x/_autodocs/cache.md

Fetches the release date string from the cache metadata.

```php
$date = $browscapCache->getReleaseDate();
echo "Browscap data released: " . ($date ?? "Unknown");
```

--------------------------------

### browscap:convert

Source: https://github.com/browscap/browscap-php/blob/7.8.x/README.md

Reads a locally stored browscap.ini file and writes the contents into a cache.

```APIDOC
## browscap:convert

### Description
The `convert` command reads a local stored browscap.ini file and writes the contents into a cache.

### Options
- **file** (string) - Optional - The relative path to the local file to convert.
- **cache** (string) - Optional - The relative path to your cache directory.

### Return Codes
- 6: Missing file name
- 7: File not available or not readable
- 8: Error reading the file
```

--------------------------------

### Convert browscap.ini file to cache

Source: https://github.com/browscap/browscap-php/blob/7.8.x/_autodocs/browscap-updater.md

Parses a local browscap.ini file and updates the cache. Requires handling specific exceptions for missing or unreadable files.

```php
$updater = new BrowscapUpdater($cache, $logger);
try {
    $updater->convertFile('/tmp/browscap.ini');
    echo "Cache updated successfully";
} catch (BrowscapPHP\Exception\FileNotFoundException $e) {
    echo "File not found: " . $e->getMessage();
} catch (BrowscapPHP\Exception\FileNameMissingException $e) {
    echo "File name required";
}
```

--------------------------------

### Configure Legacy Formatter

Source: https://github.com/browscap/browscap-php/blob/7.8.x/_autodocs/browscap.md

Sets a custom formatter to handle output, such as the LegacyFormatter for specific compatibility requirements.

```php
$browscap = new Browscap($cache, $logger);
$browscap->setFormatter(new \BrowscapPHP\Formatter\LegacyFormatter(['lowercase' => true]));
```

--------------------------------

### Configure Remote Filename

Source: https://github.com/browscap/browscap-php/blob/7.8.x/_autodocs/helpers.md

Sets the specific remote INI file type to be downloaded. Throws a BrowscapPHP\Helper\Exception if the name is empty.

```php
public function setRemoteFilename(string $name): void
```

```php
$loader = new IniLoader();
$loader->setRemoteFilename('Full_PHP_BrowscapINI');
```

--------------------------------

### Define getBrowser Method

Source: https://github.com/browscap/browscap-php/blob/7.8.x/_autodocs/parsers.md

Method signature for parsing a user agent string and returning a formatter.

```php
public function getBrowser(string $userAgent): ?FormatterInterface
```

--------------------------------

### Parse User Agent Strings

Source: https://github.com/browscap/browscap-php/blob/7.8.x/_autodocs/browscap.md

Demonstrates parsing specific user agents, automatic detection from the current request, and handling potential cache exceptions.

```php
$browscap = new Browscap($cache, $logger);
$result = $browscap->getBrowser('Mozilla/5.0 (iPhone; CPU iPhone OS 14_0 like Mac OS X)');

echo $result->Browser;        // iPhone
echo $result->Platform;       // iOS
echo $result->isMobileDevice; // true
```

```php
$result = $browscap->getBrowser();
// Uses HTTP_USER_AGENT or other headers from $_SERVER
```

```php
try {
    $result = $browscap->getBrowser('Mozilla/5.0...');
    echo "Detected browser: " . $result->Browser;
} catch (BrowscapPHP\Exception $e) {
    echo "Cache not available, run update first";
}
```

--------------------------------

### Configure Redis Cache Adapter

Source: https://github.com/browscap/browscap-php/blob/7.8.x/_autodocs/configuration.md

Use this adapter for high-performance, shared caching environments.

```php
// Using phpredis adapter
new \Predis\Client(['host' => 'localhost'])
```

--------------------------------

### browscap:update

Source: https://github.com/browscap/browscap-php/blob/7.8.x/README.md

Downloads an ini file from browscap.org and writes the contents directly into a cache without creating local files.

```APIDOC
## browscap:update

### Description
The `update` command downloads an ini file from browscap.org and writes the contents into a cache. No local files are created.

### Options
- **remote-file** (string) - Optional - The type of file to download (PHP_BrowscapINI, Lite_PHP_BrowscapINI, Full_PHP_BrowscapINI).
- **cache** (string) - Optional - The relative path to your cache directory.

### Return Codes
- 3: Error checking cached version
- 9: Error fetching remote data
- 10: Other error
```

--------------------------------

### getHashForPattern Method

Source: https://github.com/browscap/browscap-php/blob/7.8.x/_autodocs/parser-helpers.md

Generates hash prefixes from a user agent string for efficient pattern candidate selection.

```php
public static function getHashForPattern(string $pattern, bool $reverse = false): array
```

--------------------------------

### GetData::getSettings

Source: https://github.com/browscap/browscap-php/blob/7.8.x/_autodocs/parser-helpers.md

Retrieves browser properties for a given pattern, recursively loading and merging properties from parent patterns.

```APIDOC
## Method: getSettings

### Description
Retrieves browser properties for a pattern, recursively loading parent pattern properties and merging them. Child pattern properties override parent properties.

### Signature
`public function getSettings(string $pattern, array $settings = []): array`

### Parameters
- **pattern** (string) - Required - User agent pattern to look up
- **settings** (array) - Optional - Settings accumulated from parent patterns

### Returns
- **array** - Merged browser properties from pattern and parents (array<string, string|bool>)

### Example
```php
$dataHelper = new GetData($cache, $logger, $quoter);
$properties = $dataHelper->getSettings('Mozilla.*Windows.*Chrome.*');
```
```

--------------------------------

### Ini::getBrowser

Source: https://github.com/browscap/browscap-php/blob/7.8.x/_autodocs/parsers.md

Parses a user agent string and returns a configured formatter with matching browser data.

```APIDOC
## getBrowser(string $userAgent)

### Description
Parses a user agent string and returns a configured formatter with matching browser data, or null if no match found.

### Parameters
- **userAgent** (string) - Required - User agent string to parse

### Returns
- **FormatterInterface|null** - Formatter containing matched browser data, or null if no data found

### Throws
- **UnexpectedValueException** - If error occurs during pattern matching or data retrieval

### Example
```php
$parser = $browscap->getParser();
$formatter = $parser->getBrowser('Mozilla/5.0 (Windows NT 10.0; Win64; x64)');

if ($formatter !== null) {
    $data = $formatter->getData();
    echo $data->Browser;
}
```
```

--------------------------------

### convertString(string $iniString)

Source: https://github.com/browscap/browscap-php/blob/7.8.x/_autodocs/browscap-updater.md

Parses browscap.ini content from a string and writes parsed data into the cache.

```APIDOC
## convertString(string $iniString)

### Description
Parses browscap.ini content from a string and writes parsed data into the cache. This can be called directly when you have INI content from alternative sources.

### Parameters
- **iniString** (string) - Required - Complete browscap.ini file contents as string

### Example
```php
$iniContent = file_get_contents('https://example.com/browscap.ini');
$updater->convertString($iniContent);
```
```

--------------------------------

### Define FileNotFoundException

Source: https://github.com/browscap/browscap-php/blob/7.8.x/_autodocs/exceptions.md

Exception thrown when a local file does not exist or is not readable.

```php
final class FileNotFoundException extends Exception
{
    public static function fileNotFound(string $file): self
}
```

```php
public static function fileNotFound(string $file): self
```

```php
try {
    $updater->convertFile('/nonexistent/file.ini');
} catch (BrowscapPHP\Exception\FileNotFoundException $e) {
    echo "File not found: " . $e->getMessage();
}
```

--------------------------------

### BrowscapCache Methods

Source: https://github.com/browscap/browscap-php/blob/7.8.x/_autodocs/README.md

Methods for interacting with the cache layer.

```APIDOC
## BrowscapCache Methods

- **getItem()**: Retrieves data from the cache.
- **setItem()**: Stores data in the cache.
- **hasItem()**: Checks if an item exists in the cache.
- **removeItem()**: Deletes a specific cache entry.
- **flush()**: Clears the entire cache.
- **getVersion() / getReleaseDate() / getType()**: Accesses metadata about the cached data.
```

--------------------------------

### Update Phase Workflow

Source: https://github.com/browscap/browscap-php/blob/7.8.x/_autodocs/architecture.md

Visual representation of the data pipeline from remote download to PSR-16 cache storage.

```text
Remote browscap.org
        ↓
HTTP Client (Guzzle)
        ↓
BrowscapUpdater (download + version check)
        ↓
Converter (parse INI)
        ↓
IniParser (structure data)
        ↓
BrowscapCache (serialize and store)
        ↓
PSR-16 Cache Storage
```

--------------------------------

### IniLoader::getRemoteIniUrl()

Source: https://github.com/browscap/browscap-php/blob/7.8.x/_autodocs/helpers.md

Retrieves the full URL for downloading the configured INI file.

```APIDOC
## getRemoteIniUrl()

### Description
Returns the complete URL for downloading the configured INI file from browscap.org.

### Returns
- (string) - Full HTTP URL for download
```

--------------------------------

### Scheduled Update via Cron

Source: https://github.com/browscap/browscap-php/blob/7.8.x/_autodocs/quick-reference.md

Automates the update process by running the browscap:update command daily at 3:00 AM.

```bash
# Daily update check and cache refresh
0 3 * * * /app/vendor/bin/browscap-php browscap:update >> /var/log/browscap.log 2>&1
```

--------------------------------

### Convert browscap.ini string to cache

Source: https://github.com/browscap/browscap-php/blob/7.8.x/_autodocs/browscap-updater.md

Parses raw browscap.ini content provided as a string and writes it to the cache.

```php
$iniContent = file_get_contents('https://example.com/browscap.ini');
$updater->convertString($iniContent);
```

--------------------------------

### update()

Source: https://github.com/browscap/browscap-php/blob/7.8.x/_autodocs/browscap-updater.md

Fetches a remote browscap.ini file and parses it into the cache. This method performs version checking and only updates if a newer version is available.

```APIDOC
## update(string $remoteFile)

### Description
Fetches a remote browscap.ini file and directly parses it into the cache without saving to disk. This is the recommended method for keeping the cache current.

### Parameters
- **remoteFile** (string) - Optional - Remote file type: PHP_INI (standard), Lite_PHP_BrowscapINI, or Full_PHP_BrowscapINI. Defaults to PHP_INI.

### Returns
- void

### Throws
- BrowscapPHP\Exception\NoNewVersionException: If remote version same or older than cached version
- BrowscapPHP\Exception\NoCachedVersionException: If no cached version exists initially
- BrowscapPHP\Exception\FetcherException: If HTTP request fails
- BrowscapPHP\Exception\ErrorCachedVersionException: If error reading cached version

### Example
```php
try {
    $updater->update();
    echo "Cache updated from remote";
} catch (BrowscapPHP\Exception\NoNewVersionException $e) {
    echo "Already latest version";
}
```
```

--------------------------------

### Update cache with full ini file

Source: https://github.com/browscap/browscap-php/blob/7.8.x/README.md

Updates the cache using the full version of the browscap.ini file instead of the standard version.

```bash
vendor/bin/browscap-php browscap:update --remote-file Full_PHP_BrowscapINI
```

--------------------------------

### Retrieve and Use Parser

Source: https://github.com/browscap/browscap-php/blob/7.8.x/_autodocs/browscap.md

Accesses the current parser instance to perform manual browser capability lookups.

```php
$parser = $browscap->getParser();
$result = $parser->getBrowser('Mozilla/5.0...');
```

--------------------------------

### PhpGetBrowser::setData

Source: https://github.com/browscap/browscap-php/blob/7.8.x/_autodocs/formatters.md

Stores the raw browser settings extracted from the INI file into the formatter.

```APIDOC
## PhpGetBrowser::setData

### Description
Stores the raw settings extracted from the INI file. This method is typically called by the parser during the matching process.

### Parameters
- **settings** (array<string, string|bool>) - Required - Browser properties and capabilities extracted from parsed INI data.

### Example
```php
$formatter->setData([
    'Browser' => 'Chrome',
    'Version' => '96.0',
    'isMobileDevice' => false,
    'Platform' => 'Win32'
]);
```
```

--------------------------------

### Store cache item with setItem()

Source: https://github.com/browscap/browscap-php/blob/7.8.x/_autodocs/cache.md

Serializes and stores data in the cache. The withVersion parameter defaults to true, appending the cache version to the key.

```php
public function setItem(string $cacheId, $content, bool $withVersion = true): bool
```

```php
$patterns = ['pattern1' => 'data1', 'pattern2' => 'data2'];
$success = $browscapCache->setItem('browscap.patterns.abc', $patterns, true);
if ($success) {
    echo "Patterns stored in cache";
} else {
    echo "Failed to store patterns";
}
```

--------------------------------

### CLI Check-Update Command

Source: https://github.com/browscap/browscap-php/blob/7.8.x/_autodocs/configuration.md

Check for available updates for the browser data.

```bash
vendor/bin/browscap-php browscap:check-update \
    --cache <path>        # Cache directory
```
Tokens:
Raw