cortex/foundation

The core foundation of Rinvex Cortex modular application architecture.

v8.0.1 2023-01-09 17:16 UTC

README

The core foundation of Rinvex Cortex modular application architecture.

Packagist Scrutinizer Code Quality Travis StyleCI License

Installation and Usage

This package should NOT be installed individually, it's required by rinvex/cortex and requires a new laravel application instance with special architecture satisfied with Rinvex Cortex.

This package still not yet documented, but you can use it on your own responsibility.

To be documented soon..!

Livewire Examples

Rinvex Cortex supports Livewire, to add an example Livewire Component, do the following:

Create a new component class app/cortex/foundation/src/Http/Components/Adminarea/Counter.php:

<?php

namespace Cortex\Foundation\Http\Components\Adminarea;

use Cortex\Foundation\Overrides\Livewire\Component;

class Counter extends Component
{
    public $count = 0;

    public function increment()
    {
        $this->count++;
    }

    public function render()
    {
        //$this->authorize('update', $this->post);

        return view('cortex/foundation::adminarea.components.counter');
    }
}

Create a new component view app/cortex/foundation/resources/views/adminarea/components/counter.blade.php:

<div style="text-align: center">
    <button wire:click="increment">+</button>
    <h1>{{ $count }}</h1>
</div>

Use the new component anywhere in your blade templates:

<livewire:adminarea.cortex.foundation.counter />

unique_with Validator Rule

This feature contains a variant of the validateUnique rule for Laravel, that allows for validation of multi-column UNIQUE indexes.

It was forked and merged from the awesome felixkiss/uniquewith-validator package, which at the time been outdated and un-maintained for a long time. Many thanks to core contributors for developing this.

unique_with Validator Rule: Usage

Use it like any Validator rule:

$rules = [
    '<field1>' => 'unique_with:<table>,<field2>[,<field3>,...,<ignore_rowid>]',
];

See the Validation documentation of Laravel.

Specify different column names in the database

If your input field names are different from the corresponding database columns, you can specify the column names explicitly.

E.g. your input contains a field 'last_name', but the column in your database is called 'sur_name':

$rules = [
    'first_name' => 'unique_with:users, middle_name, last_name = sur_name',
];

Ignore existing row (useful when updating)

You can also specify a row id to ignore (useful to solve unique constraint when updating)

This will ignore row with id 2:

$rules = [
    'first_name' => 'required|unique_with:users,last_name,2',
    'last_name' => 'required',
];

To specify a custom column name for the id, pass it like:

$rules = [
    'first_name' => 'required|unique_with:users,last_name,2 = custom_id_column',
    'last_name' => 'required',
];

If your id is not numeric, you can tell the validator:

$rules = [
    'first_name' => 'required|unique_with:users,last_name,ignore:abc123',
    'last_name' => 'required',
];

Add additional clauses (e.g. when using soft deletes)

You can also set additional clauses. For example, if your model uses soft deleting then you can use the following code to select all existing rows but marked as deleted

$rules = [
    'first_name' => 'required|unique_with:users,last_name,deleted_at,2 = custom_id_column',
    'last_name' => 'required',
];

Soft delete caveat:

In Laravel 5 (tested on 5.5), if the validation is performed in form request class, field deleted_at is skipped, because it's not send in request. To solve this problem, add 'deleted_at' => null to Your validation parameters in request class., e.g.:

protected function validationData()
{
    return array_merge($this->request->all(), [
        'deleted_at' => null
    ]);
}

Specify specific database connection to use

If we have a connection named some-database, we can enforce this connection (rather than the default) like this:

$rules = [
    'first_name' => 'unique_with:some-database.users, middle_name, last_name',
];

E.g. pretend you have a users table in your database plus User model like this:

<?php

use Illuminate\Database\Schema\Blueprint;
use Illuminate\Database\Migrations\Migration;

class CreateUsersTable extends Migration
{
    /**
     * Run the migrations.
     *
     * @return void
     */
    public function up()
    {
        Schema::create('users', function(Blueprint $table) {
            $table->increments('id');

            $table->timestamps();

            $table->string('first_name');
            $table->string('last_name');

            $table->unique(['first_name', 'last_name']);
        });
    }

    /**
     * Reverse the migrations.
     *
     * @return void
     */
    public function down()
    {
        Schema::drop('users');
    }
}
<?php

class User extends Eloquent { }

Now you can validate a given first_name, last_name combination with something like this:

Route::post('test', function() {
    $rules = [
        'first_name' => 'required|unique_with:users,last_name',
        'last_name' => 'required',
    ];

    $validator = Validator::make(Input::all(), $rules);

    if($validator->fails()) {
        return Redirect::back()->withErrors($validator);
    }

    $user = new User;
    $user->first_name = Input::get('first_name');
    $user->last_name = Input::get('last_name');
    $user->save();

    return Redirect::home()->with('success', 'User created!');
});

Changelog

Refer to the Changelog for a full history of the project.

Support

The following support channels are available at your fingertips:

Contributing & Protocols

Thank you for considering contributing to this project! The contribution guide can be found in CONTRIBUTING.md.

Bug reports, feature requests, and pull requests are very welcome.

Security Vulnerabilities

If you discover a security vulnerability within this project, please send an e-mail to help@rinvex.com. All security vulnerabilities will be promptly addressed.

About Rinvex

Rinvex is a software solutions startup, specialized in integrated enterprise solutions for SMEs established in Alexandria, Egypt since June 2016. We believe that our drive The Value, The Reach, and The Impact is what differentiates us and unleash the endless possibilities of our philosophy through the power of software. We like to call it Innovation At The Speed Of Life. That’s how we do our share of advancing humanity.

License

This software is released under The MIT License (MIT).

(c) 2016-2022 Rinvex LLC, Some rights reserved.