fyre/typeparser

A database type parser library.

v3.0.5 2024-06-27 01:30 UTC

Requires

• friendsofphp/php-cs-fixer: ^3.59
• fyre/datetime: ^3.0
• fyre/php-cs-fixer-config: ^1.0

Requires (Dev)

• phpunit/phpunit: ^10

MIT

• elusivecodes

README

FyreTypeParser

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

Table Of Contents

• Installation
• Methods
• Types

Installation

Using Composer

composer require fyre/typeparser

In PHP:

use Fyre\DB\TypeParser;

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 Type

Map a value type to a class.

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

TypeParser::mapType($type, $typeClass);

Use

Load a shared Type instance for a value type.

• $type is a string representing the value type.

$parser = TypeParser::use($type);

Types

You can load a specific type parser by specifying the $type argument of the getType 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);

Boolean

$parser = TypeParser::getType('boolean');

Date

$parser = TypeParser::getType('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::getType('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.

$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::getType('decimal');

Float

$parser = TypeParser::getType('float');

Integer

$parser = TypeParser::getType('integer');

Json

$parser = TypeParser::getType('json');

Set Encoding Flags

Set the encoding flags.

• $flags is a number representing the encoding flags.

$parser->setEncodingFlags($flags);

String

$parser = TypeParser::getType('string');

Time

$parser = TypeParser::getType('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);