Skip to content
Manipulates ATK CRUD through the force of references
Branch: develop
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
demos
docs/images update readme Aug 16, 2018
src
tests
tools cleanups Mar 1, 2019
.gitignore
.travis.yml
CHANGELOG.md
LICENSE
README.md fix readme typo Aug 19, 2018
composer.json fix dependencies Mar 1, 2019
phpunit.xml

README.md

ATK UI is a UI library for building UI interfaces that has a built-in CRUD component. It can be used to create complex admin systems, but it requires you to populate multiple pages and inter-link them together yourself.

mastercrud

MasterCRUD is an add-on for ATK UI and ATK Data, which will orchestrate navigation between multiple CRUD pages by respecting relations and conditions. You can use MasterCRUD to:

  • Manage list of clients, and their individual invoices and payments.
  • Manage user groups and users within them
  • Manage multi-level catalogue and products in them

The syntax of MasterCRUD is incredibly simple and short. It automatically takes care of many details like:

  • record and track id of various records you have clicked on (BreadCrumb)
  • display multi-Tab pages with model details and optional relations
  • support hasOne and hasMany relations
  • allow flexible linking to a higher tree level (user - invoice - allocated_payment -> payment (drops invoice_id))

MasterCRUD can also be extended to contain your own views, you can interact with the menu and even place MasterCRUD inside a more complex layouts.

Example Use Case (see demos/clients.php for full demo):

Assuming you have Clients with Invoices and Payments and you also want to add "Line"s for each Invoice, you may want to add this interface for the admin, where user can use drill-downs to navigate through data:

step1

Clicking on Client 2 would bring you to a different page. Extra tabs Invoices and Payments offer you further way in:

step2

clicking on specific invoice, you can edit it's lines:

step3

On this screen however we turned off deletion of lines (because it is a demo). However clicking Edit brings up a Modal where you can easily update record data:

step4

All this UI can be created in just a few lines of code!

MasterCRUD operates like a regular CRUD, and you can easily substitute it in:

$crud = $app->add('\atk4\mastercrud\MasterCRUD');
$crud->setModel('Client');

You'll noticed that you can now click on the client name to get full details about this client. Next, we want to be able to see and manage Client invoices:

$crud = $app->add('\atk4\mastercrud\MasterCRUD');
$crud->setModel('Client', ['Invoices'=>[]]);

This will add 2nd tab to the "Client Details" screen listing invoices of said client. If you invoice is further broken down into "Lines", you can go one level deeper:

$crud = $app->add('\atk4\mastercrud\MasterCRUD');
$crud->setModel('Client', ['Invoices'=>['Lines'=>[]]]);

If Client hasMany('Payments') then you can also add that relation:

$crud = $app->add('\atk4\mastercrud\MasterCRUD');
$crud->setModel('Client', ['Invoices'=>['Lines'=>[]], 'Payments'=>[]]);

With some cleanup, this syntax is readable and nice:

$crud = $app->add('\atk4\mastercrud\MasterCRUD');
$crud->setModel('Client', [
  'Invoices'=>[
    'Lines'=>[]
  ], 
  'Payments'=>[]
]);

Support for actions

MasterCRUD is awesome for quickly creating admin systems. But basic C,R,U,D operations are not enough. Sometimes you want to invoke custom actions for individual element. MasterCRUD now supports that too:

$app->layout->add(new \atk4\mastercrud\MasterCRUD())
    ->setModel(new \saasty\Model\App($app->db), 
    [
        'columnActions'=>[
            'repair'=>['icon'=>'wrench'],
        ],
        'Models'=>[
            'columnActions'=>[
                'migrate'=>['icon'=>'database'],
            ],
            'Fields'=>[
                'ValidationRules'=>[],
            
            ],
            'Relations'=>[
                'ImportedFields'=>[],
            ],
        ],

actions

There are various invocation methods allowing you to specify icon, label, custom callbacks etc.

This also adds "MethodInvocator" - a view which asks you for arguments and then executes them.

This next example will use form to ask for an email, which will then be passed as argument to sendEmail($email)

[
    'columnActions'=>[
         'sendEmail' => ['icon'=>'wrench', 'email'=>'string']
   ]
]

Installation

Install through composer:

 composer require atk4/mastercrud

Also see introduction for ATK UI on how to render HTML.

Roadmap

  • Allow to specify custom CRUD seed. You can ever replace it with your own compatible view.
  • Add custom actions and function invocation
  • Create decent "View" mode (relies on ATK UI Card)
  • Traverse hasOne references (see below)

NOT IMPLEMENTED BELOW

Suppose that Invoice hasMany(Allocation)and Payment hasMany(Allocation) while allocation can have one Payment and one Invoice.

$crud = $app->add('\atk4\mastercrud\MasterCRUD');
$crud->setModel('Client', [
  'Invoices'=>[
    'Lines'=>[],
    'Allocations'=>[]
  ], 
  'Payments'=>[
    'Allocations'=>[]
  ]
]);

That's cool, but if you go through the route of Invoice -> allocation -> you should be able to click on the "payment":

$crud = $app->add('\atk4\mastercrud\MasterCRUD');
$crud->setModel('Client', [
  'Invoices'=>[
    'Lines'=>[],
    'Allocations'=>[
      'payment_id'=>['path'=>'Payments', 'payment_id'=>'payment_id']
    ]
  ], 
  'Payments'=>[
    'Allocations'=>[
      'invoice_id'=>['path'=>'Invoices', 'invoice_id'=>'invoice_id']
    ]
  ]
]);

Now you will be able to jump from Invoice->allocation to Payment and other way around.

You can’t perform that action at this time.