arbory/arbory

Administration interface for Laravel

Friday, July 27, 2018
by roboc
Repository
17 Watchers
26 Stars
2,817 Installations

PHP
1 Dependents
0 Suggesters
9 Forks
10 Open issues
36 Versions
39 % Grown

The README.md

, _(*1)

Installation

Create new Laravel project

composer create-project --prefer-dist laravel/laravel=8.0 my-project

Go to project root

cd my-project

Require Arbory package

composer require arbory/arbory

Fill in database info

vi .env

Run installer and follow instructions

php artisan arbory:install

That's it!

Visit http://localhost/admin

Usage

Registering new pages

Page::register( App\Pages\TextPage::class )
    ->fields( function( FieldSet $fieldSet )
    {
        $fieldSet->add( new Arbory\Base\Admin\Form\Fields\Richtext( 'text' ) );
    } )
    ->routes( function()
    {
        Route::get( '/', App\Http\Controllers\TextPageController::class . '@index' )->name( 'index' );
    } );

Registering new admin modules

Admin::modules()->register(  App\Http\Controllers\Admin\TextController::class );

Working with nodes

The node repository is used to ensure that the website only displays active nodes to the user, _(*2)

$currentNode = app( Arbory\Base\Nodes\Node::class );
$nodes = app( Arbory\Base\Repositories\NodesRepository::class ); 

// returns only the active children of the current node
$nodes->findUnder( $currentNode );

Validation

Validation rules can be attached to any field, like so, _(*3)

$form->addField( new Text( 'title' ) )->setRules( 'required' );

Validating translations

$form->addField( new Translatable( ( new Text( 'title' ) )->rules( 'required' ) ) );

Custom validators

arbory_require_one_localized - at least one translation exists for this field
arbory_file_required - file has been uploaded or is being passed in request

Fields

Object Relation

Create a relation to another model, _(*4)

new Arbory\Base\Admin\Form\Fields\ObjectRelation( 'field_name', Arbory\Base\Nodes\Node::class );

To limit the amount of relations the user can select a third argument can be passed. Relation fields limited to a single model will be rendered more compactly., _(*5)

new ObjectRelation( 'field_name', Arbory\Base\Nodes\Node::class, 1 ); // single relation, compact view 
new ObjectRelation( 'field_name', Arbory\Base\Nodes\Node::class, 10 );

An optional depth parameter can be passed (automatically set for the node relation) which adds visual nesting to the field items, _(*6)

( new ObjectRelation( 'field_name', Arbory\Base\Nodes\Node::class ) )->setIndentAttribute( 'depth' );

Items can be grouped by an attribute, _(*7)

$getName = function( \Arbory\Base\Nodes\Node $model ) 
{
    return class_basename( $model->content_type );
};

( new ObjectRelation( 'field_name', Arbory\Base\Nodes\Node::class ) )->groupBy( 'content_type', $getName );

Settings

return [
    'my_letter' => [
        'to' => 'a friend',
        'subject' => 'Hello!'
    ]
]

Settings::has('my_letter.to'); // true
Settings::get('my_letter.to'); // "a friend"

Defining a field type

return [
    'my_setting_key' => [
        'value' => 'My setting value',
        'type' => Arbory\Base\Admin\Form\Fields\CompactRichtext::class
    ],
]

File settings

return [
    'my_setting_file' => [
        'value' => null,
        'type' => Arbory\Base\Admin\Form\Fields\ArboryFile::class
    ],
    'my_setting_image' => [
        'value' => null,
        'type' => Arbory\Base\Admin\Form\Fields\ArboryImage::class
    ],
]

Translatable settings

return [
    'hello' => [
        'type' => Arbory\Base\Admin\Form\Fields\Translatable::class,
        'value' => [
            'type' => Arbory\Base\Admin\Form\Fields\CompactRichtext::class,
            'value' => [
                'en' => 'Hello',
                'lv' => 'Sveiks'
            ]
        ]
    ],
]

Generate admin User

php artisan arbory:create-user

Contributing

To submit SCSS/Js changes you must rebuild dist directory containing compiled assets. Run npm run prod to do that., _(*9)

Coding style

Use PSR-1/2, _(*10)

JS

We use airbnb coding style for both JS and SASS (links below)., _(*11)

To install the built-in inspections for PHPStorm, follow these instructions: https://www.themarketingtechnologist.co/how-to-get-airbnbs-javascript-code-style-working-in-webstorm/, _(*12)

Note!

When specifying JSCS package in the configuration window, it has to be installed locally (within the project). Global installation will not work (PHPStorm installs packages globally)., _(*13)

Customization

Rules can be modified either in separate files (.jscsrc or .jscs.json in project's root directory) or project's package.json file (jscsConfig section)., _(*14)

The Versions

27/07 2018

0.3.x-dev

0.3.9999999.9999999-dev

Administration interface for Laravel

library arbory

Administration interface for Laravel

arbory/arbory

The README.md

Installation

Create new Laravel project

Go to project root

Require Arbory package

Fill in database info

Run installer and follow instructions

That's it!

Usage

Registering new pages

Registering new admin modules

Working with nodes

Validation

Validating translations

Custom validators

Fields

Object Relation

Settings

Defining a field type

File settings

Translatable settings

Generate admin User

Contributing

Coding style

JS

Note!

Customization

Links:

The Versions

0.3.x-dev

The Requires

The Development Requires

by Roberts

dev-master

The Requires

The Development Requires

by Roberts

0.2.16

The Requires

The Development Requires

by Roberts

0.2.15

The Requires

The Development Requires

by Roberts

0.2.14

The Requires

The Development Requires

by Roberts

0.1.x-dev

The Requires

The Development Requires

by Roberts

0.2.13

The Requires

The Development Requires

by Roberts

dev-fix_icon_field

The Requires

The Development Requires

by Roberts

0.2.12

The Requires

The Development Requires

by Roberts

0.2.11

The Requires

The Development Requires

by Roberts

0.2.10

The Requires

The Development Requires

by Roberts

0.2.9

The Requires

The Development Requires

by Roberts