dbizapps/utilities

Common utilities for PHP applications

v0.1.1 2021-09-23 21:28 UTC

Requires (Dev)

• phpunit/phpunit: 10.0.x-dev

MIT

• Mark Fluehmann

README

This package provides common utility capabilities for PHP applications.

One set of utility classes is focused on International Components for Unicode (ICU ) datasets. For the following components, default ICU datasets are available as configuration files:

• Locales
• Currencies
• Timezones

In certain use cases, e.g. file operations, it must be determained on which operating system the application is executed. For this reason a utility class provides methods to resolve the underlaying operating system.

Installation

composer require dbizapps/utilities

Basic Usage International Components for Unicode (ICU)

While creating instances of utility classes, default datasets are loaded from config files.

// create new currency class loads default configuration
$currencies = new Currency();
$locales = new Locale();
$timezones = new Timezone();

Datasets are searchable with key value pairs

// search for datasets
$currencies->search('code', 'USD']);
$locales->search('code', 'de']);

Custom Usage International Components for Unicode (ICU)

Custom utility datasets can be loaded via the constructor method. Custom datasets must comply to the internal data structure

// create new currency class with custom dataset 
$currencies = new Currency([...]);
$locales = new Locale([...]);
$timezones = new Timezone([...]);

Usage OperatingSystem

// static method to retrieve underlying os
$os = OperatingSystem::getOs()

// static method to evaluate if operating system is windows
$check = OperatingSystem::isWindows()

// static method to evaluate if operating system is windows
$check = OperatingSystem::isMac()