File ConnectionOptions.php | ICanBoogie/ActiveRecord 2.3.x

 1  2  3  4  5  6  7  8  9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80

<?php

namespace ICanBoogie\ActiveRecord;

/**
 * Connection options.
 *
 * @package ICanBoogie\ActiveRecord
 */
final class ConnectionOptions
{
    /**
     * Default charset.
     */
    const DEFAULT_CHARSET = 'utf8';

    /**
     * Default collate.
     */
    const DEFAULT_COLLATE = 'utf8_general_ci';

    /**
     * Default value for {@link CHARSET_AND_COLLATE}.
     */
    const DEFAULT_CHARSET_AND_COLLATE = "utf8/general_ci";

    /**
     * Default value for {@link DEFAULT_TABLE_NAME_PREFIX}.
     */
    const DEFAULT_TABLE_NAME_PREFIX = '';

    /**
     * Default value for {@link TIMEZONE}.
     */
    const DEFAULT_TIMEZONE = '+00:00';

    /**
     * Connection identifier.
     */
    const ID = '#id';

    /**
     * Charset and collate.
     *
     * Default: {@link DEFAULT_CHARSET_AND_COLLATE}.
     */
    const CHARSET_AND_COLLATE = '#charset_and_collate';

    /**
     * Table name prefix.
     */
    const TABLE_NAME_PREFIX = '#table_name_prefix';

    /**
     * Time zone offset used for the connection.
     *
     * Default: {@link DEFAULT_TIMEZONE}.
     */
    const TIMEZONE = '#timezone';

    /**
     * Normalizes options.
     *
     * @param array $options
     *
     * @return array
     */
    static public function normalize(array $options)
    {
        return $options + [

            self::CHARSET_AND_COLLATE => self::DEFAULT_CHARSET_AND_COLLATE,
            self::ID => null,
            self::TABLE_NAME_PREFIX => self::DEFAULT_TABLE_NAME_PREFIX,
            self::TIMEZONE => self::DEFAULT_TIMEZONE

        ];
    }
}

Namespaces

Classes

Interfaces

Traits

Exceptions

Functions