Added new user models

This commit is contained in:
Igor Scheller 2018-10-06 14:15:54 +02:00 committed by msquare
parent b443b53919
commit 8e62c4c52c
12 changed files with 774 additions and 0 deletions

View File

@ -0,0 +1,289 @@
<?php
namespace Engelsystem\Migrations;
use Carbon\Carbon;
use Engelsystem\Database\Migration\Migration;
use Engelsystem\Models\User\Contact;
use Engelsystem\Models\User\PasswordReset;
use Engelsystem\Models\User\PersonalData;
use Engelsystem\Models\User\Settings;
use Engelsystem\Models\User\State;
use Engelsystem\Models\User\User;
use Illuminate\Database\Schema\Blueprint;
use stdClass;
class CreateUsersTables extends Migration
{
use ChangesReferences;
/**
* Run the migration
*/
public function up()
{
$this->schema->create('users', function (Blueprint $table) {
$table->increments('id');
$table->string('name', 24)->unique();
$table->string('email', 254)->unique();
$table->string('password', 128);
$table->string('api_key', 32);
$table->dateTime('last_login_at')->nullable();
$table->timestamps();
});
$this->schema->create('users_personal_data', function (Blueprint $table) {
$this->referencesUser($table);
$table->string('first_name', 64)->nullable();
$table->string('last_name', 64)->nullable();
$table->string('shirt_size', 4)->nullable();
$table->date('planned_arrival_date')->nullable();
$table->dateTime('arrival_date')->nullable();
$table->date('planned_departure_date')->nullable();
});
$this->schema->create('users_contact', function (Blueprint $table) {
$this->referencesUser($table);
$table->string('dect', 5)->nullable();
$table->string('mobile', 40)->nullable();
$table->string('email', 254)->nullable();
});
$this->schema->create('users_settings', function (Blueprint $table) {
$this->referencesUser($table);
$table->string('language', 64);
$table->tinyInteger('theme');
$table->boolean('email_human')->default(false);
$table->boolean('email_shiftinfo')->default(false);
});
$this->schema->create('users_state', function (Blueprint $table) {
$this->referencesUser($table);
$table->boolean('arrived')->default(false);
$table->boolean('active')->default(false);
$table->boolean('force_active')->default(false);
$table->boolean('got_shirt')->default(false);
$table->integer('got_voucher')->default(0);
});
$this->schema->create('password_resets', function (Blueprint $table) {
$this->referencesUser($table);
$table->text('token');
$table->timestamp('created_at')->nullable();
});
if ($this->schema->hasTable('User')) {
/** @var stdClass[] $users */
$users = $this->schema->getConnection()->table('User')->get();
foreach ($users as $data) {
$user = new User([
'name' => $data->Nick,
'password' => $data->Passwort,
'email' => $data->email,
'api_key' => $data->api_key,
'last_login_at' => Carbon::createFromTimestamp($data->lastLogIn),
]);
$user->setAttribute('id', $data->UID);
if (!in_array(
$data->CreateDate,
['0000-00-00 00:00:00', '0001-01-01 00:00:00', '1000-01-01 00:00:00']
)) {
$user->setAttribute('created_at', new Carbon($data->CreateDate));
}
$user->save();
$contact = new Contact([
'dect' => ($data->DECT && $data->DECT != '-') ? $data->DECT : null,
'mobile' => $data->Handy ?: ($data->Telefon ?: null),
]);
$contact->user()
->associate($user)
->save();
$personalData = new PersonalData([
'first_name' => $data->Vorname ?: null,
'last_name' => $data->Name ?: null,
'shirt_size' => $data->Size ?: null,
'planned_arrival_date' => $data->planned_arrival_date ? Carbon::createFromTimestamp($data->planned_arrival_date) : null,
'arrival_date' => $data->arrival_date ? Carbon::createFromTimestamp($data->arrival_date) : null,
'planned_departure_date' => $data->planned_departure_date ? Carbon::createFromTimestamp($data->planned_departure_date) : null,
]);
$personalData->user()
->associate($user)
->save();
$settings = new Settings([
'language' => $data->Sprache,
'theme' => $data->color,
'email_human' => $data->email_by_human_allowed,
'email_shiftinfo' => $data->email_shiftinfo,
]);
$settings->user()
->associate($user)
->save();
$state = new State([
'arrived' => $data->Gekommen,
'active' => $data->Aktiv,
'force_active' => $data->force_active,
'got_shirt' => $data->Tshirt,
'got_voucher' => $data->got_voucher,
]);
$state->user()
->associate($user)
->save();
if ($data->password_recovery_token) {
$passwordReset = new PasswordReset([
'token' => $data->password_recovery_token,
]);
$passwordReset->user()
->associate($user)
->save();
}
}
$this->changeReferences(
'User',
'UID',
'users',
'id',
'unsignedInteger'
);
}
$this->schema->dropIfExists('User');
}
/**
* Reverse the migration
*/
public function down()
{
$this->schema->create('User', function (Blueprint $table) {
$table->increments('UID');
$table->string('Nick', 23)->unique()->default('');
$table->string('Name', 23)->nullable();
$table->string('Vorname', 23)->nullable();
$table->tinyInteger('Alter')->nullable();
$table->string('Telefon', 40)->nullable();
$table->string('DECT', 5)->nullable();
$table->string('Handy', 40)->nullable();
$table->string('email', 123)->nullable();
$table->boolean('email_shiftinfo')->default(false)->comment('User wants to be informed by mail about changes in his shifts');
$table->string('jabber', 200)->nullable();
$table->string('Size', 4)->nullable();
$table->string('Passwort', 128)->nullable();
$table->string('password_recovery_token', 32)->nullable();
$table->tinyInteger('Gekommen')->default(false);
$table->tinyInteger('Aktiv')->default(false);
$table->boolean('force_active');
$table->tinyInteger('Tshirt')->default(false)->nullable();
$table->tinyInteger('color')->default(10)->nullable();
$table->char('Sprache', 64)->nullable();
$table->char('Menu', 1)->default('L');
$table->integer('lastLogIn');
$table->dateTime('CreateDate')->default('0001-01-01 00:00:00');
$table->char('Art', 30)->nullable();
$table->text('kommentar')->nullable();
$table->string('Hometown')->default('');
$table->string('api_key', 32);
$table->integer('got_voucher');
$table->integer('arrival_date')->nullable();
$table->integer('planned_arrival_date');
$table->integer('planned_departure_date')->nullable();
$table->boolean('email_by_human_allowed');
$table->index('api_key', 'api_key');
$table->index('password_recovery_token', 'password_recovery_token');
$table->index('force_active', 'force_active');
$table->index(['arrival_date', 'planned_arrival_date'], 'arrival_date');
$table->index('planned_departure_date', 'planned_departure_date');
});
foreach (User::all() as $user) {
/** @var User $user */
$contact = $user->contact;
$personal = $user->personalData;
$settings = $user->settings;
$state = $user->state;
$this->schema
->getConnection()
->table('User')
->insert([
'UID' => $user->id,
'Nick' => $user->name,
'Name' => $personal->last_name,
'Vorname' => $personal->first_name,
'DECT' => $contact->dect,
'Handy' => $contact->mobile,
'email' => $user->email,
'email_shiftinfo' => $settings->email_shiftinfo,
'Size' => $personal->shirt_size,
'Passwort' => $user->password,
'Gekommen' => $state->arrived,
'Aktiv' => $state->active,
'force_active' => $state->force_active,
'Tshirt' => $state->got_shirt,
'color' => $settings->theme,
'Sprache' => $settings->language,
'lastLogIn' => $user->last_login_at ? $user->last_login_at->getTimestamp() : null,
'CreateDate' => $user->created_at ? $user->created_at->toDateTimeString() : null,
'api_key' => $user->api_key,
'got_voucher' => $state->got_voucher,
'arrival_date' => $personal->arrival_date ? $personal->arrival_date->getTimestamp() : null,
'planned_arrival_date' => $personal->planned_arrival_date ? $personal->planned_arrival_date->getTimestamp() : null,
'planned_departure_date' => $personal->planned_departure_date ? $personal->planned_departure_date->getTimestamp() : null,
'email_by_human_allowed' => $settings->email_human,
]);
}
foreach (PasswordReset::all() as $passwordReset) {
/** @var PasswordReset $passwordReset */
$this->schema->getConnection()
->table('User')
->where('UID', '=', $passwordReset->user_id)
->update(['password_recovery_token' => $passwordReset->token]);
}
$this->schema->drop('users_personal_data');
$this->schema->drop('users_contact');
$this->schema->drop('users_settings');
$this->schema->drop('users_state');
$this->schema->drop('password_resets');
$this->changeReferences(
'users',
'id',
'User',
'UID',
'integer'
);
$this->schema->drop('users');
}
/**
* @param Blueprint $table
*/
protected function referencesUser(Blueprint $table)
{
$table->unsignedInteger('user_id');
$table->primary('user_id');
$table->foreign('user_id')
->references('id')->on('users')
->onDelete('cascade');
}
}

View File

@ -0,0 +1,64 @@
<?php
namespace Engelsystem\Migrations;
use Illuminate\Database\Schema\Blueprint;
trait ChangesReferences
{
/**
* @param string $fromTable
* @param string $fromColumn
* @param string $targetTable
* @param string $targetColumn
* @param string $type
*/
protected function changeReferences($fromTable, $fromColumn, $targetTable, $targetColumn, $type)
{
$references = $this->getReferencingTables($fromTable, $fromColumn);
foreach ($references as $reference) {
/** @var stdClass $reference */
$this->schema->table($reference->table, function (Blueprint $table) use ($reference) {
$table->dropForeign($reference->constraint);
});
$this->schema->table($reference->table,
function (Blueprint $table) use ($reference, $targetTable, $targetColumn, $type) {
$table->{$type}($reference->column)->change();
$table->foreign($reference->column)
->references($targetColumn)->on($targetTable)
->onDelete('cascade');
});
}
}
/**
* @param string $table
* @param string $column
* @return array
*/
protected function getReferencingTables($table, $column): array
{
return $this->schema
->getConnection()
->select(
'
SELECT
`TABLE_NAME` as "table",
`COLUMN_NAME` as "column",
`CONSTRAINT_NAME` as "constraint"
FROM information_schema.KEY_COLUMN_USAGE
WHERE REFERENCED_TABLE_SCHEMA = ?
AND REFERENCED_TABLE_NAME = ?
AND REFERENCED_COLUMN_NAME = ?
',
[
$this->schema->getConnection()->getDatabaseName(),
$table,
$column,
]
);
}
}

View File

@ -0,0 +1,26 @@
<?php
namespace Engelsystem\Models\User;
/**
* @property string $dect
* @property string $email
* @property string $mobile
*
* @method static \Illuminate\Database\Query\Builder|\Engelsystem\Models\User\Contact whereDect($value)
* @method static \Illuminate\Database\Query\Builder|\Engelsystem\Models\User\Contact whereEmail($value)
* @method static \Illuminate\Database\Query\Builder|\Engelsystem\Models\User\Contact whereMobile($value)
*/
class Contact extends HasUserModel
{
/** @var string The table associated with the model */
protected $table = 'users_contact';
/** The attributes that are mass assignable */
protected $fillable = [
'user_id',
'dect',
'email',
'mobile',
];
}

View File

@ -0,0 +1,30 @@
<?php
namespace Engelsystem\Models\User;
use Engelsystem\Models\BaseModel;
use Illuminate\Database\Eloquent\Relations\BelongsTo;
/**
* @property integer $user_id
*
* @method static \Illuminate\Database\Query\Builder|static whereUserId($value)
*/
abstract class HasUserModel extends BaseModel
{
/** @var string The primary key for the model */
protected $primaryKey = 'user_id';
/** The attributes that are mass assignable */
protected $fillable = [
'user_id',
];
/**
* @return BelongsTo
*/
public function user()
{
return $this->belongsTo(User::class);
}
}

View File

@ -0,0 +1,25 @@
<?php
namespace Engelsystem\Models\User;
/**
* @property string $token
* @property \Carbon\Carbon $created_at
*
* @method static \Illuminate\Database\Query\Builder|\Engelsystem\Models\User\PasswordReset whereToken($value)
* @method static \Illuminate\Database\Query\Builder|\Engelsystem\Models\User\PasswordReset whereCreatedAt($value)
*/
class PasswordReset extends HasUserModel
{
/** @var bool enable timestamps for created_at */
public $timestamps = true;
/** @var null Disable updated_at */
const UPDATED_AT = null;
/** The attributes that are mass assignable */
protected $fillable = [
'user_id',
'token',
];
}

View File

@ -0,0 +1,42 @@
<?php
namespace Engelsystem\Models\User;
/**
* @property string $first_name
* @property string $last_name
* @property string $shirt_size
* @property \Carbon\Carbon $arrival_date
* @property \Carbon\Carbon $planned_arrival_date
* @property \Carbon\Carbon $planned_departure_date
*
* @method static \Illuminate\Database\Query\Builder|\Engelsystem\Models\User\PersonalData whereFirstName($value)
* @method static \Illuminate\Database\Query\Builder|\Engelsystem\Models\User\PersonalData whereLastName($value)
* @method static \Illuminate\Database\Query\Builder|\Engelsystem\Models\User\PersonalData whereShirtSize($value)
* @method static \Illuminate\Database\Query\Builder|\Engelsystem\Models\User\PersonalData whereArrivalDate($value)
* @method static \Illuminate\Database\Query\Builder|\Engelsystem\Models\User\PersonalData wherePlannedArrivalDate($value)
* @method static \Illuminate\Database\Query\Builder|\Engelsystem\Models\User\PersonalData wherePlannedDepartureDate($value)
*/
class PersonalData extends HasUserModel
{
/** @var string The table associated with the model */
protected $table = 'users_personal_data';
/** @var array The attributes that should be mutated to dates */
protected $dates = [
'arrival_date',
'planned_arrival_date',
'planned_departure_date',
];
/** The attributes that are mass assignable. */
protected $fillable = [
'user_id',
'first_name',
'last_name',
'shirt_size',
'arrival_date',
'planned_arrival_date',
'planned_departure_date',
];
}

View File

@ -0,0 +1,29 @@
<?php
namespace Engelsystem\Models\User;
/**
* @property string $language
* @property int $theme
* @property bool $email_human
* @property bool $email_shiftinfo
*
* @method static \Illuminate\Database\Query\Builder|\Engelsystem\Models\User\Settings whereLanguage($value)
* @method static \Illuminate\Database\Query\Builder|\Engelsystem\Models\User\Settings whereTheme($value)
* @method static \Illuminate\Database\Query\Builder|\Engelsystem\Models\User\Settings whereEmailHuman($value)
* @method static \Illuminate\Database\Query\Builder|\Engelsystem\Models\User\Settings whereEmailShiftinfo($value)
*/
class Settings extends HasUserModel
{
/** @var string The table associated with the model */
protected $table = 'users_settings';
/** The attributes that are mass assignable */
protected $fillable = [
'user_id',
'language',
'theme',
'email_human',
'email_shiftinfo',
];
}

32
src/Models/User/State.php Normal file
View File

@ -0,0 +1,32 @@
<?php
namespace Engelsystem\Models\User;
/**
* @property bool $arrived
* @property bool $active
* @property bool $force_active
* @property bool $got_shirt
* @property int $got_voucher
*
* @method static \Illuminate\Database\Query\Builder|\Engelsystem\Models\User\State whereArrived($value)
* @method static \Illuminate\Database\Query\Builder|\Engelsystem\Models\User\State whereActive($value)
* @method static \Illuminate\Database\Query\Builder|\Engelsystem\Models\User\State whereForceActive($value)
* @method static \Illuminate\Database\Query\Builder|\Engelsystem\Models\User\State whereGotShirt($value)
* @method static \Illuminate\Database\Query\Builder|\Engelsystem\Models\User\State whereGotVoucher($value)
*/
class State extends HasUserModel
{
/** @var string The table associated with the model */
protected $table = 'users_state';
/** The attributes that are mass assignable */
protected $fillable = [
'user_id',
'arrived',
'active',
'force_active',
'got_shirt',
'got_voucher',
];
}

96
src/Models/User/User.php Normal file
View File

@ -0,0 +1,96 @@
<?php
namespace Engelsystem\Models\User;
use Engelsystem\Models\BaseModel;
use Illuminate\Database\Eloquent\Relations\HasOne;
/**
* @property integer $id
* @property string $name
* @property string $email
* @property string $password
* @property string $api_key
* @property \Carbon\Carbon $last_login_at
* @property \Carbon\Carbon $created_at
* @property \Carbon\Carbon $updated_at
*
* @property-read \Illuminate\Database\Query\Builder|\Engelsystem\Models\User\Contact $contact
* @property-read \Illuminate\Database\Query\Builder|\Engelsystem\Models\User\PersonalData $personalData
* @property-read \Illuminate\Database\Query\Builder|\Engelsystem\Models\User\Settings $settings
* @property-read \Illuminate\Database\Query\Builder|\Engelsystem\Models\User\State $state
*
* @method static \Illuminate\Database\Query\Builder|\Engelsystem\Models\User\User whereId($value)
* @method static \Illuminate\Database\Query\Builder|\Engelsystem\Models\User\User whereName($value)
* @method static \Illuminate\Database\Query\Builder|\Engelsystem\Models\User\User whereEmail($value)
* @method static \Illuminate\Database\Query\Builder|\Engelsystem\Models\User\User wherePassword($value)
* @method static \Illuminate\Database\Query\Builder|\Engelsystem\Models\User\User whereApiKey($value)
* @method static \Illuminate\Database\Query\Builder|\Engelsystem\Models\User\User whereLastLoginAt($value)
* @method static \Illuminate\Database\Query\Builder|\Engelsystem\Models\User\User whereCreatedAt($value)
* @method static \Illuminate\Database\Query\Builder|\Engelsystem\Models\User\User whereUpdatedAt($value)
*/
class User extends BaseModel
{
/** @var bool enable timestamps */
public $timestamps = true;
/** The attributes that are mass assignable */
protected $fillable = [
'name',
'password',
'email',
'api_key',
'last_login_at',
];
/** @var array The attributes that should be hidden for serialization */
protected $hidden = [
'api_key',
'password',
];
/** @var array The attributes that should be mutated to dates */
protected $dates = [
'last_login_at',
];
/**
* @return HasOne
*/
public function contact()
{
return $this
->hasOne(Contact::class)
->withDefault();
}
/**
* @return HasOne
*/
public function personalData()
{
return $this
->hasOne(PersonalData::class)
->withDefault();
}
/**
* @return HasOne
*/
public function settings()
{
return $this
->hasOne(Settings::class)
->withDefault();
}
/**
* @return HasOne
*/
public function state()
{
return $this
->hasOne(State::class)
->withDefault();
}
}

View File

@ -0,0 +1,33 @@
<?php
namespace Engelsystem\Test\Unit\Models;
use Engelsystem\Models\User\HasUserModel;
use Engelsystem\Test\Unit\HasDatabase;
use Engelsystem\Test\Unit\Models\User\Stub\HasUserModelImplementation;
use Illuminate\Database\Eloquent\Relations\BelongsTo;
use PHPUnit\Framework\TestCase;
class HasUserModelTest extends TestCase
{
use HasDatabase;
/**
* @covers \Engelsystem\Models\User\HasUserModel::user
*/
public function testHasOneRelations()
{
/** @var HasUserModel $contact */
$model = new HasUserModelImplementation();
$this->assertInstanceOf(BelongsTo::class, $model->user());
}
/**
* Prepare test
*/
protected function setUp()
{
$this->initDatabase();
}
}

View File

@ -0,0 +1,10 @@
<?php
namespace Engelsystem\Test\Unit\Models\User\Stub;
use Engelsystem\Models\User\HasUserModel;
class HasUserModelImplementation extends HasUserModel
{
}

View File

@ -0,0 +1,98 @@
<?php
namespace Engelsystem\Test\Unit\Models;
use Engelsystem\Models\User\Contact;
use Engelsystem\Models\User\HasUserModel;
use Engelsystem\Models\User\PersonalData;
use Engelsystem\Models\User\Settings;
use Engelsystem\Models\User\State;
use Engelsystem\Models\User\User;
use Engelsystem\Test\Unit\HasDatabase;
use PHPUnit\Framework\TestCase;
class UserTest extends TestCase
{
use HasDatabase;
protected $data = [
'name' => 'lorem',
'password' => '',
'email' => 'foo@bar.batz',
'api_key' => '',
];
/**
* @return array
*/
public function hasOneRelationsProvider()
{
return [
[
Contact::class,
'contact',
[
'dect' => '1234',
'email' => 'foo@bar.batz',
'mobile' => '1234/12341234',
]
],
[
PersonalData::class,
'personalData',
[
'first_name' => 'Foo'
]
],
[
Settings::class,
'settings',
[
'language' => 'de_DE',
'theme' => 4,
]
],
[
State::class,
'state',
[
'force_active' => true,
]
],
];
}
/**
* @covers \Engelsystem\Models\User\User::contact
* @covers \Engelsystem\Models\User\User::personalData
* @covers \Engelsystem\Models\User\User::settings
* @covers \Engelsystem\Models\User\User::state
*
* @dataProvider hasOneRelationsProvider
*
* @param string $class
* @param string $name
* @param array $data
*/
public function testHasOneRelations($class, $name, $data)
{
$user = new User($this->data);
$user->save();
/** @var HasUserModel $contact */
$contact = new $class($data);
$contact->user()
->associate($user)
->save();
$this->assertArraySubset($data, (array)$user->{$name}->attributesToArray());
}
/**
* Prepare test
*/
protected function setUp()
{
$this->initDatabase();
}
}