bhoft/yii2-autonumber

Auto number extension for the Yii framework

1.5 2019-04-17 08:18 UTC

Requires

• yiisoft/yii2: ~2.0

BSD-3-Clause

• Misbahul D Munir
• B Hoft

• yii2
• extension
• autonumber
• behavior

README

Yii2 extension to genarete formated autonumber. It can be used for generate document number.

This extension forked from mdm/yii2-autonumber and extended with some modifications.

modifications: targetClass attribute so the extension could also be used with different extended classes e.g. MyModel, MyModelForm and still get the same autonumber group could be now an model attribute or function or class function format set the format of the autonumber db to set a different database

Installation

The preferred way to install this extension is through composer.

Either run

php composer.phar require --prefer-dist bhoft/yii2-autonumber "~1.0"

or add

"bhoft/yii2-autonumber": "~1.0"

to the require section of your composer.json file.

Usage

Prepare required table by execute yii migrate.

yii migrate --migrationPath=@bhoft/yii2/autonumber/migrations

if wantn't use db migration. you can create required table manually.

CREATE TABLE auto_number (
    "group" varchar(32) NOT NULL,
    "number" int,
    optimistic_lock int,
    update_time int,
    PRIMARY KEY ("group")
);

Once the extension is installed, simply modify your ActiveRecord class:

public function behaviors()
{
	return [
		[
			'class' => 'bhoft\yii2\autonumber\Behavior',
			'targetClass' => 'app\models\MyModel',  // optional default OwnerClassname
			'attribute' => 'sales_num', // required
			'group' => 'groupAttribute', // optional
				// or as class function
	            // 'group' => array($this, 'getGroupId'),  // 
	            // or
	            // 'group' => $this->groupId'),  // 
			'format' => 'SA.'.date('Y-m-d').'.?' , // format auto number. '?' will be replaced with generated number
				//you could also use " 'format' => function($event){ return 'SA.'.date('Y-m-d').'.?' } "
			'digit' => 4 // optional, default to null.
			//'db' => Yii::app()->db,  // optional
		],
	];
}

// it will set value $model->sales_num as 'SA.2014-06-25.0001'

Instead of behavior, you can use this extension as validator

use bhoft\autonumber\AutonumberValidator;
...
public function rules()
{
    return [
        [['sales_num'], AutonumberValidator::className(), 'format'=>'SA.'.date('Y-m-d').'.?'],
        ...
        [['submission_num'], AutonumberValidator::className(), 'format'=>'?', 'targetClass' => 'app\models\MyModel', 'group' => 'call_id'],
    ];
}

• Api Documentation of original version