tigron/skeleton-package-crud

Tigron Skeleton CRUD functionality

skeleton-package-crud

Description

This library enables CRUD functionality for skeleton objects, _(*1)

Installation

Installation via composer:, _(*2)

composer require tigron/skeleton-package-crud

Howto

Module

Create a module in your application that extends from Skeleton\Package\Web\Module\Crud, _(*3)

<?php
/**
 * Module Crud
 *
 * @author Christophe Gosiau <christophe@tigron.be>
 * @author Gerry Demaret <gerry@tigron.be>
 * @author David Vandemaele <david@tigron.be>
 */

use Skeleton\Package\Crud\Web\Module\Crud;

class Web_Module_User extends Crud {

    /**
     * The template
     *
     * @access public
     */
    public $template = 'user.twig';

    /**
     * Get the pager object
     *
     * @access public
     * @return Pager $pager
     */
    public function get_pager() {
    }
}

Create a route in your application Config.php

    /**
     * Routes
     */
    'routes' => [
        'web_module_user' => [
            '$language/user'
        ],
    ]

Template

Create a template for your module that injects the generated templates into your layout, _(*4)

{% extends "_default/layout.base.twig" %}

{% block header_js %}
    {% embed "@skeleton-package-crud/javascript.twig" %}{% endembed %}
{% endblock header_js %}

{% block header_css %}
    {% embed "@skeleton-package-crud/css.twig" %}{% endembed %}
{% endblock header_css %}

{% block content %}
    {% embed "@skeleton-package-crud/content.twig" with {'object_name': 'My object'} %}{% endembed %}
{% endblock content %}

Template blocks

In embed "@skeleton-package-crud/content.twig there are blocks available to customize the CRUD module. Below you can find the list of blocks with their default content:, _(*5)

Page 'Pager'

Filters for pager, _(*6)

{% block pager_filters %}
    <div class="form-group">
        <label class="control-label col-lg-2">{% trans "Search" %} </label>
        <div class="controls col-lg-10">
            <input type="text" class="form-control" name="search" value="{{ pager.get_search() }}"/>
        </div>
    </div>
{% endblock pager_filters %}

Breadcrumbs, _(*7)

{% block page_pager_breadcrumb %}
    {#
        Insert the full breadcrumbs for the edit page
    #}
{% endblock page_pager_breadcrumb %}

Table header for pager, _(*8)

{% block pager_table_head %}
    {% for definition in default_fields %}
        <th>{{ pager.create_header(definition.field, definition.field) }}</th>
    {% endfor %}
{% endblock pager_table_head %}

Table row for pager, _(*9)

{% block pager_table_row %}
    {% for definition in default_fields %}
        <td>{{ attribute(object, definition.field) }}</td>
    {% endfor %}
{% endblock pager_table_row %}

Page 'create'

Form for object creation, _(*10)

{% block form_create %}
    {#
        Insert a complete form for object creation here.
        Make sure that an array with key object[field] is posted
    #}
{% endblock form_create %}

Breadcrumbs, _(*11)

{% block page_create_breadcrumb %}
    {#
        Insert the full breadcrumbs for the create page
    #}
{% endblock page_create_breadcrumb %}

Page Create, _(*12)

{% block page_create %}
    {#
        Insert a complete page for creating the object here
        Make sure that an array with key object[field] is posted
    #}
{% endblock page_create %}

Page Create Footer, _(*13)

{% block page_create_footer %}
    {#
        This is a part of block page_create just below the edit form
        This can be used to show additional information about the object
    #}
{% endblock page_create_footer %}

Page 'edit'

Form for edit object, _(*14)

{% block form_edit %}
    {#
        Insert a complete form for editing the object here.
        Make sure that an array with key object[field] is posted
    #}
{% endblock form_edit %}

Breadcrumbs, _(*15)

{% block page_edit_breadcrumb %}
    {#
        Insert the full breadcrumbs for the edit page
    #}
{% endblock page_edit_breadcrumb %}

Page Edit, _(*16)

{% block page_edit %}
    {#
        Insert a complete page for editing the object here
        Make sure that an array with key object[field] is posted
    #}
{% endblock page_edit %}

Page Edit Footer, _(*17)

{% block page_edit_footer %}
    {#
        This is a part of block page_edit just below the edit form
        This can be used to show additional information about the object
    #}
{% endblock page_edit_footer %}

Module methods

In the module, you can use the following methods to configure the CRUD behavior, _(*18)

/**
 * Is deletable
 *
 * @access public
 * @param Object $object
 * @return bool $deletable
 */
public function is_deletable($object) {
    return true;
}

/**
 * Is editable
 *
 * @access public
 * @param Object $object
 * @return bool $editable
 */
public function is_editable($object) {
    return true;
}

/**
 * Is creatable
 *
 * @access public
 * @return bool $creatable
 */
public function is_creatable() {
    return true;
}