Plasma\ColumnDefinition

Complexity

Total Complexity

12

Size/Duplication

Total Lines	155
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	getCharset()	0	2	1
A	__construct()	0	10	1
A	getDecimals()	0	2	1
A	getType()	0	2	1
A	getName()	0	2	1
A	getLength()	0	2	1
A	isNullable()	0	2	1
A	parseValue()	0	8	2
A	getFlags()	0	2	1
A	getDatabaseName()	0	2	1
A	getTableName()	0	2	1

<?php
/**
 * Plasma Core component
 * Copyright 2018 PlasmaPHP, All Rights Reserved
 *
 * Website: https://github.com/PlasmaPHP
 * License: https://github.com/PlasmaPHP/core/blob/master/LICENSE
*/

namespace Plasma;

/**
 * Column Definitions define columns (who would've thought of that?). Such as their name, type, length, etc.
 */
class ColumnDefinition implements ColumnDefinitionInterface {
    /**
     * @var string
     */
    protected $database;
    
    /**
     * @var string
     */
    protected $table;
    
    /**
     * @var string
     */
    protected $name;
    
    /**
     * @var string
     */
    protected $type;
    
    /**
     * @var string
     */
    protected $charset;
    
    /**
     * @var int|null
     */
    protected $length;
    
    /**
     * @var bool
     */
    protected $nullable;
    
    /**
     * @var int
     */
    protected $flags;
    
    /**
     * @var int|null
     */
    protected $decimals;
    
    /**
     * Constructor.
     * @param string    $database
     * @param string    $table
     * @param string    $name
     * @param string    $type
     * @param string    $charset
     * @param int|null  $length
     * @param bool      $nullable
     * @param int       $flags
     * @param int|null  $decimals
     */
    function __construct(string $database, string $table, string $name, string $type, string $charset, ?int $length, bool $nullable, int $flags, ?int $decimals) {
        $this->database = $database;
        $this->table = $table;
        $this->name = $name;
        $this->type = $type;
        $this->charset = $charset;
        $this->length = $length;
        $this->nullable = $nullable;
        $this->flags = $flags;
        $this->decimals = $decimals;
    }
    
    /**
     * Get the database name this column is in.
     * @return string
     */
    function getDatabaseName(): string {
        return $this->database;
    }
    
    /**
     * Get the table name this column is in.
     * @return string
     */
    function getTableName(): string {
        return $this->table;
    }
    
    /**
     * Get the column name.
     * @return string
     */
    function getName(): string {
        return $this->name;
    }
    
    /**
     * Get the type name, such as `BIGINT`, `VARCHAR`, etc.
     * @return string
     */
    function getType(): string {
        return $this->type;
    }
    
    /**
     * Get the charset, such as `utf8mb4`.
     * @return string
     */
    function getCharset(): string {
        return $this->charset;
    }
    
    /**
     * Get the maximum field length, if any.
     * @return int|null
     */
    function getLength(): ?int {
        return $this->length;
    }
    
    /**
     * Whether the column is nullable (not `NOT NULL`).
     * @return bool
     */
    function isNullable(): bool {
        return $this->nullable;
    }
    
    /**
     * Get the column flags.
     * @return int
     */
    function getFlags(): int {
        return $this->flags;
    }
    
    /**
     * Get the maximum shown decimal digits.
     * @return int|null
     */
    function getDecimals(): ?int {
        return $this->decimals;
    }
    
    /**
     * Parses the row value into the field type.
     * @param mixed  $value
     * @return mixed
     */
    function parseValue($value) {
        try {
            return \Plasma\Types\TypeExtensionsManager::getManager()->decodeType($this->type, $value);
        } catch (\Plasma\Exception $e) {
            /* Continue regardless of error */
        }
        
        return $value;
    }
}