TypesHelperTableBuilder::index() - Code Metrics - Inspection of "Psalm" - b2pweb/bdf-prime - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#29)

by Sébastien

created 2021-09-27 09:17 UTC

TypesHelperTableBuilder::index() A

↳ Parent: TypesHelperTableBuilder

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes

Metric	Value
eloc	2
dl	0
loc	5
ccs	3
cts	3
cp	1
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	4
crap	1

<?php

namespace Bdf\Prime\Schema\Builder;

use Bdf\Prime\Platform\PlatformTypeInterface;
use Bdf\Prime\Platform\PlatformTypesInterface;
use Bdf\Prime\Schema\IndexInterface;
use Bdf\Prime\Types\TypeInterface;
use Bdf\Prime\Types\TypesHelperInterface;

/**
 * Decorate TableBuilder for adding extra helper methods for adding types
 * Not like table builder, all helpers method will return $this
 * All those methods can be chained.
 *
 * The given type registry must be a @see PlatformTypesInterface for resolve "complex" types like bigint, or array

 *
 * <code>
 * $builder
 *     ->bigint('id')->autoincrement()->primary()
 *     ->string('first_name', 32)->nillable()->unique('idx_name')
 *     ->string('last_name', 32)->nillable()->unique('idx_name')
 * ;
 * </code>
 */
final class TypesHelperTableBuilder implements TableBuilderInterface, TypesHelperInterface
{
    /**
     * @var TableBuilderInterface
     */
    private $builder;

    /**
     * @var PlatformTypesInterface
     */
    private $types;


    /**
     * TypesHelperTableBuilder constructor.
     *
     * @param TableBuilderInterface $builder
     * @param PlatformTypesInterface $types
     */
    public function __construct(TableBuilderInterface $builder, PlatformTypesInterface $types)

    {
        $this->builder = $builder;
        $this->types = $types;
    }

    //===================//

    // Delegated methods //
    //===================//


    /**

     * {@inheritdoc}
     */
    public function name($name)
    {
        $this->builder->name($name);

        return $this;
    }

    /**

     * {@inheritdoc}
     */
    public function options(array $options)
    {
        $this->builder->options($options);

        return $this;
    }

    /**

     * {@inheritdoc}
     */
    public function indexes(array $indexes)
    {
        $this->builder->indexes($indexes);

        return $this;
    }

    /**

     * {@inheritdoc}
     */
    public function primary($columns = null, $name = null)
    {
        $this->builder->primary($columns, $name);

        return $this;
    }

    /**

     * {@inheritdoc}
     */
    public function add($column, PlatformTypeInterface $type, array $options = [])
    {
        return $this->builder->add($column, $type, $options);
    }

    /**

     * {@inheritdoc}
     */
    public function column($name = null)
    {
        return $this->builder->column($name);
    }

    /**

     * {@inheritdoc}
     */
    public function foreignKey($foreignTable, array $localColumnNames, array $foreignColumnNames, array $options = [], $constraintName = null)
    {
        $this->builder->foreignKey($foreignTable, $localColumnNames, $foreignColumnNames, $options, $constraintName);

        return $this;
    }

    /**

     * {@inheritdoc}
     */
    public function index($columns, $type = IndexInterface::TYPE_SIMPLE, $name = null, array $options = [])
    {
        $this->builder->index($columns, $type, $name, $options);

        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function build()
    {
        return $this->builder->build();
    }

    //================//

    // Helper methods //
    //================//


    /**
     * Add a new column with type as string
     *
     * @param string $column
     * @param string $type
     * @param array $options
     *
     * @return ColumnBuilderInterface
     *
     * @see TableBuilderInterface::add()
     */
    public function addTypeAsString($column, $type, array $options = [])
    {
        return $this->add(
            $column,
            $this->types->native($type),
            $options
        );
    }

    /**

     * {@inheritdoc}
     */
    public function string($name, $length = 255, $default = null)
    {
        $this->addTypeAsString($name, TypeInterface::STRING)
            ->length($length)

            ->setDefault($default)

        ;


        return $this;
    }

    /**

     * {@inheritdoc}
     */
    public function text($name, $default = null)
    {
        $this->addTypeAsString($name, TypeInterface::TEXT)->setDefault($default);

        return $this;
    }

    /**

     * {@inheritdoc}
     */
    public function integer($name, $default = null)
    {
        $this->addTypeAsString($name, TypeInterface::INTEGER)->setDefault($default);

        return $this;
    }

    /**

     * {@inheritdoc}
     */
    public function tinyint($name, $default = null)
    {
        $this->addTypeAsString($name, TypeInterface::TINYINT)->setDefault($default);

        return $this;
    }

    /**

     * {@inheritdoc}
     */
    public function smallint($name, $default = null)
    {
        $this->addTypeAsString($name, TypeInterface::SMALLINT)->setDefault($default);

        return $this;
    }

    /**
     * Create a new medium integer (3-byte) column on the table.
     *
     * @param  string  $name

     * @param  mixed   $default

     *
     * @return $this
     */
    public function mediumint($name, $default = null)
    {
        $this->addTypeAsString($name, 'mediumint')->setDefault($default);

        return $this;
    }

    /**

     * {@inheritdoc}
     */
    public function bigint($name, $default = null)
    {
        $this->addTypeAsString($name, TypeInterface::BIGINT)->setDefault($default);

        return $this;
    }

    /**
     * Create a new unsigned tiny integer (1-byte) column on the table.
     *
     * @param string $name
     * @param mixed $default
     *
     * @return $this
     */
    public function unsignedTinyint($name, $default = null)
    {
        return $this->tinyint($name, $default)->unsigned();
    }

    /**
     * Create a new unsigned small integer (2-byte) column on the table.
     *
     * @param string $name
     * @param mixed $default
     *
     * @return $this
     */
    public function unsignedSmallint($name, $default = null)
    {
        return $this->smallint($name, $default)->unsigned();
    }

    /**
     * Create a new unsigned medium integer (3-byte) column on the table.
     *
     * @param string $name
     * @param mixed $default
     *
     * @return $this
     */
    public function unsignedMediumint($name, $default = null)
    {
        return $this->mediumint($name, $default)->unsigned();
    }

    /**
     * Create a new unsigned integer (4-byte) column on the table.
     *
     * @param string $name
     * @param mixed $default
     *
     * @return $this
     */
    public function unsignedInteger($name, $default = null)
    {
        return $this->integer($name, $default)->unsigned();
    }

    /**
     * Create a new unsigned big integer (8-byte) column on the table.
     *
     * @param string $name
     * @param mixed $default
     *
     * @return $this
     */
    public function unsignedBigint($name, $default = null)
    {
        return $this->bigint($name, $default)->unsigned();
    }

    /**

     * {@inheritdoc}
     */
    public function float($name, $default = null)
    {
        $this->addTypeAsString($name, TypeInterface::FLOAT)->setDefault($default);

        return $this;
    }

    /**

     * {@inheritdoc}
     */
    public function double($name, $default = null)
    {
        $this->addTypeAsString($name, TypeInterface::DOUBLE)->setDefault($default);

        return $this;
    }

    /**

     * {@inheritdoc}
     */
    public function decimal($name, $default = null)
    {
        $this->addTypeAsString($name, TypeInterface::DECIMAL)->setDefault($default);

        return $this;
    }

    /**

     * {@inheritdoc}
     */
    public function boolean($name, $default = null)
    {
        $this->addTypeAsString($name, TypeInterface::BOOLEAN)->setDefault($default);

        return $this;
    }

    /**
     * Create a new enum column on the table.
     *
     * @param  string  $name

     * @param  array   $allowed

     *
     * @return $this
     */
//    public function enum($name, array $allowed)

//    {

//        $this->addTypeAsString($name, 'enum', ['allowed' => $allowed]);

//

//        return $this;

//    }


    /**

     * {@inheritdoc}
     */
    public function date($name, $default = null)
    {
        $this->addTypeAsString($name, TypeInterface::DATE)->setDefault($default);

        return $this;
    }

    /**

     * {@inheritdoc}
     */
    public function dateTime($name, $default = null)
    {
        $this->addTypeAsString($name, TypeInterface::DATETIME)->setDefault($default);

        return $this;
    }

    /**

     * {@inheritdoc}
     */
    public function dateTimeTz($name, $default = null)
    {
        $this->addTypeAsString($name, TypeInterface::DATETIMETZ)->setDefault($default);

        return $this;
    }

    /**

     * {@inheritdoc}
     */
    public function time($name, $default = null)
    {
        $this->addTypeAsString($name, TypeInterface::TIME)->setDefault($default);

        return $this;
    }

    /**

     * {@inheritdoc}
     */
    public function timestamp($name, $default = null)
    {
        $this->addTypeAsString($name, TypeInterface::TIMESTAMP)->setDefault($default);

        return $this;
    }

    /**

     * {@inheritdoc}
     */
    public function binary($name, $default = null)
    {
        $this->addTypeAsString($name, TypeInterface::BINARY)->setDefault($default);

        return $this;
    }

    /**

     * {@inheritdoc}
     */
    public function blob($name, $default = null)
    {
        $this->addTypeAsString($name, TypeInterface::BLOB)->setDefault($default);

        return $this;
    }

    /**

     * {@inheritdoc}
     */
    public function guid($name, $default = null)
    {
        $this->addTypeAsString($name, TypeInterface::GUID)->setDefault($default);

        return $this;
    }

    /**
     * Create a new json column on the table.
     *
     * @param  string  $name

     * @param  mixed   $default

     *
     * @return $this
     */
    public function json($name, $default = null)
    {
        $this->addTypeAsString($name, TypeInterface::JSON)->setDefault($default);

        return $this;
    }

    /**

     * {@inheritdoc}
     */
    public function simpleArray($name, $default = null)
    {
        $this->addTypeAsString($name, TypeInterface::TARRAY)->setDefault($default);

        return $this;
    }

    /**

     * {@inheritdoc}
     */
    public function object($name, $default = null)
    {
        $this->addTypeAsString($name, TypeInterface::OBJECT)->setDefault($default);

        return $this;
    }

    /**

     * {@inheritdoc}
     */
    public function arrayObject($name, $default = null)
    {
        $this->addTypeAsString($name, TypeInterface::ARRAY_OBJECT)->setDefault($default);

        return $this;
    }

    /**

     * {@inheritdoc}
     */
    public function searchableArray($name, $default = null)
    {
        $this->addTypeAsString($name, TypeInterface::TARRAY)->setDefault($default);

        return $this;
    }

    /**

     * {@inheritdoc}
     */
    public function arrayOf($name, $type, $default = null)
    {
        $this->addTypeAsString($name, $type.'[]')->setDefault($default);

        return $this;
    }

    /**

     * {@inheritdoc}
     */
    public function arrayOfInt($name, $default = null)
    {
        return $this->arrayOf($name, TypeInterface::INTEGER, $default);
    }

    /**

     * {@inheritdoc}
     */
    public function arrayOfDouble($name, $default = null)
    {
        return $this->arrayOf($name, TypeInterface::DOUBLE, $default);
    }

    /**

     * {@inheritdoc}
     */
    public function arrayOfDateTime($name, $default = null)
    {
        return $this->arrayOf($name, TypeInterface::DATETIME, $default);
    }

    /**
     * Specify the autoincrement key.
     * /!\ Unlike FieldBuilder, this method will not set the column as primary key
     *
     * @param bool $flag         Activate/Deactivate autoincrement

     *
     * @return $this
     *
     * @see ColumnBuilderInterface::autoincrement()
     */
    public function autoincrement($flag = true)
    {
        $this->column()->autoincrement($flag);

        return $this;
    }

    /**
     * Set nillable flag of current field
     *
     * @param bool $flag         Activate/Deactivate nillable

     *
     * @return $this             This builder instance
     */
    public function nillable($flag = true)
    {
        $this->column()->nillable($flag);

        return $this;
    }

    /**
     * Set unsigned flag on the current field
     *
     * @param bool $flag Activate/Deactivate unsigned

     *
     * @return $this This builder instance
     */
    public function unsigned($flag = true)
    {
        $this->column()->unsigned($flag);

        return $this;
    }

    /**
     * Define the decimal field precision
     *
     * @param int $precision The number of significant digits that are stored for values

     * @param int $scale The number of digits that can be stored following the decimal point

     *
     * @return $this This builder instance
     */
    public function precision(int $precision, int $scale)
    {
        $this->column()->precision($precision, $scale);

        return $this;
    }
}


1			<?php
2
3			namespace Bdf\Prime\Schema\Builder;
4
5			use Bdf\Prime\Platform\PlatformTypeInterface;
6			use Bdf\Prime\Platform\PlatformTypesInterface;
7			use Bdf\Prime\Schema\IndexInterface;
8			use Bdf\Prime\Types\TypeInterface;
9			use Bdf\Prime\Types\TypesHelperInterface;
10
11			/**
12			* Decorate TableBuilder for adding extra helper methods for adding types
13			* Not like table builder, all helpers method will return $this
14			* All those methods can be chained.
15			*
16			* The given type registry must be a @see PlatformTypesInterface for resolve "complex" types like bigint, or array
			0 ignored issues – show introduced 2020-05-22 09:39 UTC by Report Bug Copy Issue Report Doc comment long description must end with a full stop Loading history...
17			*
18			* <code>
19			* $builder
20			* ->bigint('id')->autoincrement()->primary()
21			* ->string('first_name', 32)->nillable()->unique('idx_name')
22			* ->string('last_name', 32)->nillable()->unique('idx_name')
23			* ;
24			* </code>
25			*/
26			final class TypesHelperTableBuilder implements TableBuilderInterface, TypesHelperInterface
27			{
28			/**
29			* @var TableBuilderInterface
30			*/
31			private $builder;
32
33			/**
34			* @var PlatformTypesInterface
35			*/
36			private $types;
37
38
39			/**

b2pweb / bdf-prime

Pull Request — master (#29)

TypesHelperTableBuilder::index() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like