Model rules for default values

[uldisn]

Q	A
Is bugfix?	yes
New feature?	yes
Breaks BC?	no
Tests pass?	yes
Fixed issues	-

Bug

CREATE TABLE `contract` (
  `id` int(10) unsigned NOT NULL AUTO_INCREMENT,
  `contract_number` varchar(50)  NOT NULL DEFAULT 'NoNumber' COMMENT 'Number',
  `contract_date` date DEFAULT NULL COMMENT 'Contract date',
  `contract_place` varchar(250) DEFAULT NULL COMMENT 'Contract place',
  `notes` text COMMENT 'Notes',
  PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8

rules

    /**
     * @inheritdoc
     */
    public function rules()
    {
        return [
            [['contract_number'], 'required'],
            [['contract_date'], 'safe'],
            [['notes'], 'string'],
            [['contract_number'], 'string', 'max' => 50],
            [['contract_place'], 'string', 'max' => 250],
        ];
    }

If in rules no defined default value for field contract_number and not initiated, validation fired on require rule.

Example of generated rules:

    /**
     * {@inheritdoc}
     */
    public function rules()
    {
        return [
            [['name', 'address', 'profile_id'], 'default', 'value' => null],
	    [['status'], 'integer', 'default', 'value' => 0],
            [['email'], 'required'],
            [['address'], 'string'],
            [['status', 'profile_id'], 'integer'],
            [['email', 'name'], 'string', 'max' => 128],
        ];
    

[yii-bot]

Thank you for putting effort in the improvement of the Yii framework.
We have reviewed your pull request.

Unfortunately a use case is missing. It is required to get a better understanding of the pull request and helps us to determine the necessity and applicability of the suggested change to the framework.

Could you supply us with a use case please? Please be as detailed as possible and show some code!

Thanks!

This is an automated comment, triggered by adding the label pr:missing usecase.

[schmunk42]

I think this should either be enabled by a parameter or done in a 2.2.x release.

[uldisn]

Realy is bug! See description.

[samdark]

👍

[schmunk42]

I don't get it from the description, but apparently @samdark does, so it's fine 😄

[samdark]

Thinking more about it... @uldisn what's the use case for having explicit default rules if they match database ones? As far as I know, database silently uses default when value is not provided anyway...

[uldisn]

Sometimes rules is fired, if not set default values. For example, if field required ( not null), in database is defined default value and in model not set. Then rule required fired.
For optimal indexing not null is very actual, but usually using default CURRENT_TIMESTAMP fired on require rule.

[samdark]

Isn't it better not to generate required rule in this case?

[uldisn]

But my view is mirroring full table requirements in model. That allow in validation rules trust on default values. Currently my know problem is with require, but other problems can occur.

For tuning masters yes. They can do it ( not to generate required rule in this case).

Additionally i see follow improvements:

• default value define as model constant
• create method "loadDefaultValues()" - useful for new record before showing in form.

[samdark]

Currently my know problem is with require, but other problems can occur.

Any examples?

create method "loadDefaultValues()" - useful for new record before showing in form.

https://www.yiiframework.com/doc/api/2.0/yii-db-activerecord#loadDefaultValues()-detail is already there and works without any extra rules.

[uldisn]

On issue #335 is problem

[samdark]

#335 seems to have another pull request https://github.com/yiisoft/yii2-gii/pull/421/files

[uldisn]

Solutions:

• database fields with not null and default value not include in require rule
  • fired only on like Gii sets wrong model rule for integer field with default value #335 issue described situation
  • minimal and optimal code
• create full list rules for default values
  • work correctly in any situation
  • huge code
• create full list rules for default values excluding null default value
  • work correctly in any situation
  • no so huge code

[uldisn]

Generation default value rules cover follow problems:

• Gii sets wrong model rule for integer field with default value Gii sets wrong model rule for integer field with default value #335 Fix for issue #335 #421
• The generator makes all integer columns as […, 'default', 'value' => null] even column set as not nul The generator makes all integer columns as […, 'default', 'value' => null] even column set as not null #402

Only need adapt for PostgrSQL

[WinterSilence]

that's magic in yii confuse me - why not define properties with defaults from db table?

class Contact extends ActiveRecord
{
    /**
     * @var int
     */
    public $id;

    /**
     * @var string Number
     */
    public $contract_number = 'NoNumber';

    ...
}

/**
 * @var {type} {comment}
 */
public ${column} ={default};

[WinterSilence]

mssql/sql server:

DEFAULT definitions cannot be created on columns with a timestamp data type or columns with an IDENTITY property.

https://docs.microsoft.com/ru-ru/sql/t-sql/statements/create-table-transact-sql?view=sql-server-ver15

also it must be $defaultValue = 'time()';

[uldisn]

For timestamp column, if default value not set, fired on require rule.

[WinterSilence]

@uldisn

if (strtoupper($column->defaultValue) === 'CURRENT_TIMESTAMP') {
     if ($driverName === 'mssql') {
          $defaultValue = $this->generateString($column->defaultValue);
     } else {
        $defaultValue = 'time()';
    }
} 

[uldisn]

On MSSQL fired rule, who validate actual field value - time format.

[WinterSilence]

@uldisn yes, my fail

if (strtoupper($column->defaultValue) === 'CURRENT_TIMESTAMP') {
     if ($driverName === 'mysql' && $column->type === Schema::TYPE_TIMESTAMP) {
          $defaultValue = 'time()';
     } else {
        $defaultValue = "date('Y-m-d H:i:s')";
    }
}

[uldisn]

that's magic in yii confuse me - why not define properties with defaults from db table?

class Contact extends ActiveRecord
{
    /**
     * @var int
     */
    public $id;

    /**
     * @var string Number
     */
    public $contract_number = 'NoNumber';

    ...
}

/**
 * @var {type} {comment}
 */
public ${column} ={default};

For example, if default value is timestamp, it cannot set to property.

[WinterSilence]

@uldisn why? timestamp is integer

[WinterSilence]

why only that's drivers?

[uldisn]

I know only MySql.

[uldisn]

I'm sure just about MySql

[WinterSilence]

@uldisn that's types normalized check DB subfolders, also:

/**
 * @var string abstract type of this column. Possible abstract types include:
 * char, string, text, boolean, smallint, integer, bigint, float, decimal, datetime,
 * timestamp, time, date, binary, and money.
 */
public $type;
/**
 * @var string the PHP type of this column. Possible PHP types include:
 * `string`, `boolean`, `integer`, `double`, `array`.
 */
public $phpType;

as you can see, $phpType use only 5 types, you can detect numeric as if (in_array($column->phpType, ['integer', 'double', 'float'], true)) 'float' added because php dont have type 'double', i think it's used to set validation rule

[WinterSilence]

if ($column->defaultValue === null && !$column->allowNull) { continue; }

[uldisn]

Not need "&& !$column->allowNull"

[uldisn]

ok

[WinterSilence]

@uldisn no need $columnsDefaultNull set if ($column->allowNull) {$defaultValue = 'null';}

[uldisn]

by default all attributes has null value. Not need.

[WinterSilence]

@uldisn null !== 'null', echo null or echo false don't print null or false, in my packages I use <?=json_encode($var)?>

[uldisn]

I checked MySql schema. If in MySql field no default value, then $column->defaultValue is null.
$column->allowNull use for rules "required"
Correct:

 if ($column->defaultValue === null) { continue; }

[WinterSilence]

@uldisn $column->allowNull is @param type|null $foo, function setFoo(?type $value) and function getFoo(): ?type.

If in MySql field no default value, then $column->defaultValue is null.

CREATE TABLE `demo` (`a` VARCHAR(255) NULL, `b` TEXT NULL);
INSERT INTO `demo` (`a`) VALUES (NULL); // (NULL, NULL)

CREATE TABLE ` demo` (
    `id` INT(11) UNSIGNED NOT NULL AUTO_INCREMENT,
    `a` TEXT NULL DEFAULT NULL,
    `b` VARCHAR(50) NULL DEFAULT 'is default'
    PRIMARY KEY (`id`) USING BTREE
) ENGINE=InnoDB;

INSERT INTO ` demo` (`a`, `b`) VALUES ('...', NULL);
INSERT INTO ` demo` (`a`, `b`) VALUES (NULL, '...');
INSERT INTO `demo` (`b`) VALUES (NULL);
INSERT INTO `demo` (`a`) VALUES ('...');