README.md

FyreTypeParser

FyreTypeParser is a free, open-source database type parser library for PHP.

Table Of Contents

• Installation
• Basic Usage
• Methods
• Types
  • Binary
  • Boolean
  • DateTime
  • DateTime (Fractional)
  • DateTime (Time Zone)
  • Decimal
  • Enum
  • Float
  • Integer
  • Json
  • Set
  • String
  • Text
  • Time

Installation

Using Composer

composer require fyre/typeparser

In PHP:

use Fyre\DB\TypeParser;

Basic Usage

• $container is a Container.

$typeParser = new TypeParser($container);

Autoloading

It is recommended to bind the TypeParser to the Container as a singleton.

$container->singleton(TypeParser::class);

Any dependencies will be injected automatically when loading from the Container.

$typeParser = $container->use(TypeParser::class);

Methods

Clear

Clear all loaded types.

$typeParser->clear();

Get Type

Get the mapped Type class for a value type.

• $type is a string representing the value type.

$typeClass = $typeParser->getType($type);

Get Type Map

Get the type class map.

$typeMap = $typeParser->getTypeMap();

Map

Map a value type to a class.

• $type is a string representing the value type.
• $typeClass is a string representing the class name.

$typeParser->map($type, $typeClass);

Use

Load a shared Type instance for a value type.

• $type is a string representing the value type.

$parser = $typeParser->use($type);

Custom Type dependencies will be resolved automatically from the Container.

Types

You can load a specific type parser by specifying the $type argument of the use method above.

Custom type parsers can be created by extending \Fyre\DB\Types\Type, ensuring all below methods are implemented.

From Database

Parse a database value to PHP value.

• $value is the value to parse.

$parsedValue = $parser->fromDatabase($value);

Parse

Parse a user value to PHP value.

• $value is the value to parse.

$parsedValue = $parser->parse($value);

To Database

Parse a PHP value to database value.

• $value is the value to parse.

$dbValue = $parser->toDatabase($value);

Binary

$parser = $typeParser->use('binary');

Boolean

$parser = $typeParser->use('boolean');

Date

$parser = $typeParser->use('date');

Get Locale Format

Get the locale format.

$format = $parser->getLocaleFormat();

Set Locale Format

Set the locale format.

• $format is a string representing the locale format.

$parser->setLocaleFormat($format);

DateTime

$parser = $typeParser->use('datetime');

Get Locale Format

Get the locale format.

$format = $parser->getLocaleFormat();

Get Server Time Zone

Get the server time zone.

$timeZone = $parser->getServerTimeZone();

Get User Time Zone

Get the user time zone.

$timeZone = $parser->getUserTimeZone();

Set Locale Format

Set the locale format.

• $format is a string representing the locale format, or a Closure that returns the locale format.

$parser->setLocaleFormat($format);

Set Server Time Zone

Get the server time zone.

• $timeZone is a string representing the time zone name.

$parser->setServerTimeZone($timeZone);

Set User Time Zone

Get the user time zone.

• $timeZone is a string representing the time zone name, or a Closure that returns the time zone name.

$parser->setUserTimeZone($timeZone);

DateTime (Fractional)

$parser = $typeParser->use('datetime-fractional');

Get Locale Format

Get the locale format.

$format = $parser->getLocaleFormat();

Get Server Time Zone

Get the server time zone.

$timeZone = $parser->getServerTimeZone();

Get User Time Zone

Get the user time zone.

$timeZone = $parser->getUserTimeZone();

Set Locale Format

Set the locale format.

• $format is a string representing the locale format.

$parser->setLocaleFormat($format);

Set Server Time Zone

Get the server time zone.

• $timeZone is a string representing the time zone name.

$parser->setServerTimeZone($timeZone);

Set User Time Zone

Get the user time zone.

• $timeZone is a string representing the time zone name.

$parser->setUserTimeZone($timeZone);

DateTime (Time Zone)

$parser = $typeParser->use('datetime-timezone');

Get Locale Format

Get the locale format.

$format = $parser->getLocaleFormat();

Get Server Time Zone

Get the server time zone.

$timeZone = $parser->getServerTimeZone();

Get User Time Zone

Get the user time zone.

$timeZone = $parser->getUserTimeZone();

Set Locale Format

Set the locale format.

• $format is a string representing the locale format.

$parser->setLocaleFormat($format);

Set Server Time Zone

Get the server time zone.

• $timeZone is a string representing the time zone name.

$parser->setServerTimeZone($timeZone);

Set User Time Zone

Get the user time zone.

• $timeZone is a string representing the time zone name.

$parser->setUserTimeZone($timeZone);

Decimal

$parser = $typeParser->use('decimal');

Enum

$parser = $typeParser->use('enum');

Float

$parser = $typeParser->use('float');

Integer

$parser = $typeParser->use('integer');

Json

$parser = $typeParser->use('json');

Set Encoding Flags

Set the encoding flags.

• $flags is a number representing the encoding flags.

$parser->setEncodingFlags($flags);

Set

$parser = $typeParser->use('set');

String

$parser = $typeParser->use('string');

Text

$parser = $typeParser->use('text');

Time

$parser = $typeParser->use('time');

Get Locale Format

Get the locale format.

$format = $parser->getLocaleFormat();

Set Locale Format

Set the locale format.

• $format is a string representing the locale format.

$parser->setLocaleFormat($format);