Add ownership type CRUD. #696

config/acl.yaml

@@ -568,3 +568,17 @@ access_keys:
           label: Update
         - id: emergency_type.delete
           label: Delete
+
+    - id: ownership_type
+      label: Ownership Type Access
+      acls:
+        - id: ownership_type.menu
+          label: Menu
+        - id: ownership_type.list
+          label: List
+        - id: ownership_type.add
+          label: Add
+        - id: ownership_type.update
+          label: Update
+        - id: ownership_type.delete
+          label: Delete

config/menu.yaml

@@ -245,3 +245,7 @@ main_menu:
       acl: emergency_type.menu
       label: Emergency Types
       parent: database 
+    - id: ownership_type_list
+      acl: ownership_type.menu
+      label: Ownership Types
+      parent: database

config/routes/ownership_type.yaml

@@ -0,0 +1,35 @@
+ownership_type_list:
+    path: /ownership-types
+    controller: App\Controller\OwnershipTypeController::index
+    methods: [GET]
+
+ownership_type_rows:
+    path: /ownership-types/rowdata
+    controller: App\Controller\OwnershipTypeController::datatableRows
+    methods: [POST]
+
+ownership_type_add_form:
+    path: /ownership-types/newform
+    controller: App\Controller\OwnershipTypeController::addForm
+    methods: [GET]
+
+ownership_type_add_submit:
+    path: /ownership-types
+    controller: App\Controller\OwnershipTypeController::addSubmit
+    methods: [POST]
+
+ownership_type_update_form:
+    path: /ownership-types/{id}
+    controller: App\Controller\OwnershipTypeController::updateForm
+    methods: [GET]
+
+ownership_type_update_submit:
+    path: /ownership-types/{id}
+    controller: App\Controller\OwnershipTypeController::updateSubmit
+    methods: [POST]
+
+ownership_type_delete:
+    path: /ownership-types/{id}
+    controller: App\Controller\OwnershipTypeController::deleteSubmit
+    methods: [DELETE]
+

src/Controller/OwnershipTypeController.php

@@ -0,0 +1,255 @@
+<?php
+
+namespace App\Controller;
+
+use App\Entity\OwnershipType;
+
+use Doctrine\ORM\Query;
+use Doctrine\ORM\QueryBuilder;
+use Doctrine\ORM\EntityManagerInterface;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\Validator\Validator\ValidatorInterface;
+use Symfony\Bundle\FrameworkBundle\Controller\Controller;
+
+use Sensio\Bundle\FrameworkExtraBundle\Configuration\ParamConverter;
+use Sensio\Bundle\FrameworkExtraBundle\Configuration\IsGranted;
+
+use Catalyst\MenuBundle\Annotation\Menu;
+
+class OwnershipTypeController extends Controller
+{
+    /**
+     * @Menu(selected="ownership_type_list")
+     * @IsGranted("ownership_type.list")
+     */
+    public function index()
+    {
+        $this->denyAccessUnlessGranted('ownership_type.list', null, 'No access.');
+
+        return $this->render('ownership-type/list.html.twig');
+    }
+
+    /**
+     * @IsGranted("ownership_type.list")
+     */
+    public function datatableRows(Request $req)
+    {
+        // get query builder
+        $qb = $this->getDoctrine()
+                ->getRepository(OwnershipType::class)
+                ->createQueryBuilder('q');
+
+        // get datatable params
+        $datatable = $req->request->get('datatable');
+
+        // count total records
+        $tquery = $qb->select('COUNT(q)');
+        $this->setQueryFilters($datatable, $tquery);
+        $total = $tquery->getQuery()
+            ->getSingleScalarResult();
+
+        // get current page number
+        $page = $datatable['pagination']['page'] ?? 1;
+
+        $perpage = $datatable['pagination']['perpage'];
+        $offset = ($page - 1) * $perpage;
+
+        // add metadata
+        $meta = [
+            'page' => $page,
+            'perpage' => $perpage,
+            'pages' => ceil($total / $perpage),
+            'total' => $total,
+            'sort' => 'asc',
+            'field' => 'id'
+        ];
+
+        // build query
+        $query = $qb->select('q');
+        $this->setQueryFilters($datatable, $query);
+
+        // check if sorting is present, otherwise use default
+        if (isset($datatable['sort']['field']) && !empty($datatable['sort']['field'])) {
+            $order = $datatable['sort']['sort'] ?? 'asc';
+            $query->orderBy('q.' . $datatable['sort']['field'], $order);
+        } else {
+            $query->orderBy('q.id', 'asc');
+        }
+
+        // get rows for this page
+        $obj_rows = $query->setFirstResult($offset)
+            ->setMaxResults($perpage)
+            ->getQuery()
+            ->getResult();
+
+        // process rows
+        $rows = [];
+        foreach ($obj_rows as $orow) {
+            // add row data
+            $row['id'] = $orow->getID();
+            $row['name'] = $orow->getName();
+
+            // add row metadata
+            $row['meta'] = [
+                'update_url' => '',
+                'delete_url' => ''
+            ];
+
+            // add crud urls
+            if ($this->isGranted('ownership_type.update'))
+                $row['meta']['update_url'] = $this->generateUrl('ownership_type_update_form', ['id' => $row['id']]);
+            if ($this->isGranted('ownership_type.delete'))
+                $row['meta']['delete_url'] = $this->generateUrl('ownership_type_delete', ['id' => $row['id']]);
+
+            $rows[] = $row;
+        }
+
+        // response
+        return $this->json([
+            'meta' => $meta,
+            'data' => $rows
+        ]);
+    }
+
+    /**
+     * @Menu(selected="ownership_type.list")
+     * @IsGranted("ownership_type.add")
+     */
+    public function addForm()
+    {
+        $ownership_type = new OwnershipType();
+        $params = [
+            'ownership_type' => $ownership_type,
+            'mode' => 'create',
+        ];
+
+        // response
+        return $this->render('ownership-type/form.html.twig', $params);
+    }
+
+    /**
+     * @IsGranted("ownership_type.add")
+     */
+    public function addSubmit(Request $req, EntityManagerInterface $em, ValidatorInterface $validator)
+    {
+        $ownership_type = new OwnershipType();
+
+        $this->setObject($ownership_type, $req);
+
+        // validate
+        $errors = $validator->validate($ownership_type);
+
+        // initialize error list
+        $error_array = [];
+
+        // add errors to list
+        foreach ($errors as $error) {
+            $error_array[$error->getPropertyPath()] = $error->getMessage();
+        }
+
+        // check if any errors were found
+        if (!empty($error_array)) {
+            // return validation failure response
+            return $this->json([
+                'success' => false,
+                'errors' => $error_array
+            ], 422);
+        }
+
+        // validated! save the entity
+        $em->persist($ownership_type);
+        $em->flush();
+
+        // return successful response
+        return $this->json([
+            'success' => 'Changes have been saved!'
+        ]);
+
+    }
+
+    /**
+     * @Menu(selected="ownership_type_list")
+     * @ParamConverter("ownership_type", class="App\Entity\OwnershipType")
+     * @IsGranted("ownership_type.update")
+     */
+    public function updateForm($id, EntityManagerInterface $em, OwnershipType $ownership_type)
+    {
+        $params = [];
+        $params['ownership_type'] = $ownership_type;
+        $params['mode'] = 'update';
+
+        // response
+        return $this->render('ownership-type/form.html.twig', $params);
+    }
+
+    /**
+     * @ParamConverter("ownership_type", class="App\Entity\OwnershipType")
+     * @IsGranted("ownership_type.update")
+     */
+    public function updateSubmit(Request $req, EntityManagerInterface $em, ValidatorInterface $validator, OwnershipType $ownership_type)
+    {
+        $this->setObject($ownership_type, $req);
+
+        // validate
+        $errors = $validator->validate($ownership_type);
+
+        // initialize error list
+        $error_array = [];
+
+        // add errors to list
+        foreach ($errors as $error) {
+            $error_array[$error->getPropertyPath()] = $error->getMessage();
+        }
+
+        // check if any errors were found
+        if (!empty($error_array)) {
+            // return validation failure response
+            return $this->json([
+                'success' => false,
+                'errors' => $error_array
+            ], 422);
+        }
+
+        // validated! save the entity
+        $em->flush();
+
+        // return successful response
+        return $this->json([
+            'success' => 'Changes have been saved!'
+        ]);
+    }
+
+    /**
+     * @ParamConverter("ownership_type", class="App\Entity\OwnershipType")
+     * @IsGranted("ownership_type.update")
+     */
+    public function deleteSubmit(EntityManagerInterface $em, OwnershipType $ownership_type)
+    {
+        // delete this object
+        $em->remove($ownership_type);
+        $em->flush();
+
+        // response
+        $response = new Response();
+        $response->setStatusCode(Response::HTTP_OK);
+        $response->send();
+    }
+
+
+    protected function setObject(OwnershipType $obj, Request $req)
+    {
+        // set and save values
+        $obj->setName($req->request->get('name'))
+            ->setCode($req->request->get('code'));
+    }
+
+    protected function setQueryFilters($datatable, QueryBuilder $query)
+    {
+        if (isset($datatable['query']['data-rows-search']) && !empty($datatable['query']['data-rows-search'])) {
+            $query->where('q.name LIKE :filter')
+                ->setParameter('filter', '%' . $datatable['query']['data-rows-search'] . '%');
+        }
+    }
+
+}

src/Entity/OwnershipType.php

@@ -0,0 +1,63 @@
+<?php
+
+namespace App\Entity;
+
+use Doctrine\ORM\Mapping as ORM;
+
+use Symfony\Component\Validator\Constraints as Assert;
+
+/**
+ * @ORM\Entity
+ * @ORM\Table(name="ownership_type", indexes={
+ *     @ORM\Index(name="ownership_type_idx", columns={"code"}),
+ * })
+ */
+class OwnershipType
+{
+    // unique id
+    /**
+     * @ORM\Id
+     * @ORM\Column(type="integer")
+     * @ORM\GeneratedValue(strategy="AUTO")
+     */
+    protected $id;
+
+    /**
+     * @ORM\Column(type="string", length=25)
+     * @Assert\NotBlank()
+     */
+    protected $code;
+
+    /**
+     * @ORM\Column(type="string", length=25)
+     * @Assert\NotBlank()
+     */
+    protected $name;
+
+    public function getID()
+    {
+        return $this->id;
+    }
+
+    public function setName($name)
+    {
+        $this->name = $name;
+        return $this;
+    }
+
+    public function getName()
+    {
+        return $this->name;
+    }
+
+    public function setCode($code)
+    {
+        $this->code = $code;
+        return $this;
+    }
+
+    public function getCode()
+    {
+        return $this->code;
+    }
+}

templates/ownership-type/form.html.twig

@@ -0,0 +1,142 @@
+{% extends 'base.html.twig' %}
+
+{% block body %}
+<!-- BEGIN: Subheader -->
+<div class="m-subheader">
+    <div class="d-flex align-items-center">
+        <div class="mr-auto">
+            <h3 class="m-subheader__title">Ownership Types</h3>
+        </div>
+    </div>
+</div>
+<!-- END: Subheader -->
+<div class="m-content">
+    <!--Begin::Section-->
+    <div class="row">
+        <div class="col-xl-6">
+            <div class="m-portlet m-portlet--mobile">
+                <div class="m-portlet__head">
+                    <div class="m-portlet__head-caption">
+                        <div class="m-portlet__head-title">
+                            <span class="m-portlet__head-icon">
+                                <i class="la la-industry"></i>
+                            </span>
+                            <h3 class="m-portlet__head-text">
+                                {% if mode == 'update' %}
+                                    Edit Ownership Type
+                                    <small>{{ ownership_type.getName() }}</small>
+                                {% else %}
+                                    New Ownership Type
+                                {% endif %}
+                            </h3>
+                        </div>
+                    </div>
+                </div>
+                <form id="row-form" class="m-form m-form--fit m-form--label-align-right m-form--group-seperator-dashed" method="post" action="{{ mode == 'update' ? url('ownership_type_update_submit', {'id': ownership_type.getId()}) : url('ownership_type_add_submit') }}">
+                    <div class="m-portlet__body">
+                        <div class="form-group m-form__group row no-border">
+                            <label class="col-lg-3 col-form-label" data-field="code">
+                                Code:
+                            </label>
+                            <div class="col-lg-9">
+                                <input type="text" name="code" class="form-control m-input" value="{{ ownership_type.getCode() }}">
+                                <div class="form-control-feedback hide" data-field="code"></div>
+                            </div>
+                        </div>
+                        <div class="form-group m-form__group row">
+                            <label class="col-lg-3 col-form-label" data-field="name">
+                                Name:
+                            </label>
+                            <div class="col-lg-9">
+                                <input type="text" name="name" class="form-control m-input" value="{{ ownership_type.getName() }}">
+                                <div class="form-control-feedback hide" data-field="name"></div>
+                            </div>
+                        </div>
+                    </div>
+                    <div class="m-portlet__foot m-portlet__foot--fit">
+                        <div class="m-form__actions m-form__actions--solid m-form__actions--right">
+                            <div class="row">
+                                <div class="col-lg-12">
+                                    <button type="submit" class="btn btn-success">Submit</button>
+                                    <a href="{{ url('ownership_type_list') }}" class="btn btn-secondary">Back</a>
+                                </div>
+                            </div>
+                        </div>
+                    </div>
+                </form>
+            </div>
+        </div>
+    </div>
+</div>
+{% endblock %}
+
+{% block scripts %}
+<script>
+$(function() {
+    $("#row-form").submit(function(e) {
+        var form = $(this);
+
+        e.preventDefault();
+
+        $.ajax({
+            method: "POST",
+            url: form.prop('action'),
+            data: form.serialize()
+        }).done(function(response) {
+            // remove all error classes
+            removeErrors();
+            swal({
+                title: 'Done!',
+                text: 'Your changes have been saved!',
+                type: 'success',
+                onClose: function() {
+                    window.location.href = "{{ url('ownership_type_list') }}";
+                }
+            });
+        }).fail(function(response) {
+            if (response.status == 422) {
+                var errors = response.responseJSON.errors;
+                var firstfield = false;
+
+                // remove all error classes first
+                removeErrors();
+
+                // display errors contextually
+                $.each(errors, function(field, msg) {
+                    var formfield = $("[name='" + field + "']");
+                    var label = $("label[data-field='" + field + "']");
+                    var msgbox = $(".form-control-feedback[data-field='" + field + "']");
+
+                    // add error classes to bad fields
+                    formfield.addClass('form-control-danger');
+                    label.addClass('has-danger');
+                    msgbox.html(msg).addClass('has-danger').removeClass('hide');
+
+                    // check if this field comes first in DOM
+                    var domfield = formfield.get(0);
+
+                    if (!firstfield || (firstfield && firstfield.compareDocumentPosition(domfield) === 2)) {
+                        firstfield = domfield;
+                    }
+                });
+
+                // focus on first bad field
+                firstfield.focus();
+
+                // scroll to above that field to make it visible
+                $('html, body').animate({
+                    scrollTop: $(firstfield).offset().top - 200
+                }, 100);
+            }
+        });
+    });
+
+    // remove all error classes
+    function removeErrors() {
+        $(".form-control-danger").removeClass('form-control-danger');
+        $("[data-field]").removeClass('has-danger');
+        $(".form-control-feedback[data-field]").addClass('hide');
+    }
+});
+</script>
+{% endblock %}

templates/ownership-type/list.html.twig

@@ -0,0 +1,146 @@
+{% extends 'base.html.twig' %}
+
+{% block body %}
+<!-- BEGIN: Subheader -->
+<div class="m-subheader">
+    <div class="d-flex align-items-center">
+        <div class="mr-auto">
+            <h3 class="m-subheader__title">
+                Ownership Types 
+            </h3>
+        </div>
+    </div>
+</div>
+<!-- END: Subheader -->
+<div class="m-content">
+    <!--Begin::Section-->
+    <div class="row">
+        <div class="col-xl-12">
+            <div class="m-portlet m-portlet--mobile">
+                <div class="m-portlet__body">
+                    <div class="m-form m-form--label-align-right m--margin-top-20 m--margin-bottom-30">
+                        <div class="row align-items-center">
+                            <div class="col-xl-8 order-2 order-xl-1">
+                                <div class="form-group m-form__group row align-items-center">
+                                    <div class="col-md-4">
+                                        <div class="m-input-icon m-input-icon--left">
+                                            <input type="text" class="form-control m-input m-input--solid" placeholder="Search..." id="data-rows-search">
+                                            <span class="m-input-icon__icon m-input-icon__icon--left">
+                                                <span><i class="la la-search"></i></span>
+                                            </span>
+                                        </div>
+                                    </div>
+                                </div>
+                            </div>
+                            <div class="col-xl-4 order-1 order-xl-2 m--align-right">
+                                <a href="{{ url('ownership_type_add_form') }}" class="btn btn-focus m-btn m-btn--custom m-btn--icon m-btn--air m-btn--pill">
+                                    <span>
+                                        <i class="la la-industry"></i>
+                                        <span>New Ownership Type</span>
+                                    </span>
+                                </a>					
+                                <div class="m-separator m-separator--dashed d-xl-none"></div>
+                            </div>
+                        </div>
+                    </div>
+                    <!--begin: Datatable -->
+                    <div id="data-rows"></div>
+                    <!--end: Datatable -->
+                </div>
+            </div>
+        </div>
+    </div>
+</div>
+{% endblock %}
+
+{% block scripts %}
+<script>
+$(function() {
+    var options = {
+        data: {
+            type: 'remote',
+            source: {
+                read: {
+                    url: '{{ url("ownership_type_rows") }}',
+                    method: 'POST'
+                }
+            },
+            saveState: {
+                cookie: false,
+                webstorage: false
+            },
+            pageSize: 10,
+            serverPaging: true,
+            serverFiltering: true,
+            serverSorting: true
+        },
+        layout: {
+            scroll: true
+        },
+        columns: [
+        {
+            field: 'id',
+            title: 'ID',
+            width: 30
+        },
+        {
+            field: 'name',
+            title: 'Name'
+        },
+        {
+            field: 'Actions',
+            width: 110,
+            title: 'Actions',
+            sortable: false,
+            overflow: 'visible',
+            template: function (row, index, datatable) {
+                var actions = '';
+                            
+                if (row.meta.update_url != '') {
+                    actions += '<a href="' + row.meta.update_url + '" class="m-portlet__nav-link btn m-btn m-btn--hover-accent m-btn--icon m-btn--icon-only m-btn--pill btn-edit" data-id="' + row.name + '" title="Edit"><i class="la la-edit"></i></a>';
+                }
+
+                if (row.meta.delete_url != '') {
+                    actions += '<a href="' + row.meta.delete_url + '" class="m-portlet__nav-link btn m-btn m-btn--hover-danger m-btn--icon m-btn--icon-only m-btn--pill btn-delete" data-id="' + row.name + '" title="Delete"><i class="la la-trash"></i></a>';
+                }
+							
+                return actions;
+            },
+        }
+        ],
+        search: {
+            onEnter: false,
+            input: $('#data-rows-search'),
+            delay: 400
+        }
+    };
+
+    var table = $("#data-rows").mDatatable(options);
+
+    $(document).on('click', '.btn-delete', function(e) {
+        var url = $(this).prop('href');
+        var id = $(this).data('id');
+        var btn = $(this);
+
+        e.preventDefault();
+
+        swal({
+            title: 'Confirmation',
+            html: 'Are you sure you want to delete <strong>' + id + '</strong>?',
+            type: 'warning',
+            showCancelButton: true
+        }).then((result) => {
+            if (result.value) {
+                $.ajax({
+                    method: "DELETE",
+                    url: url
+                }).done(function(response) {
+                    table.row(btn.parents('tr')).remove();
+                    table.reload();
+                });
+            }
+        });
+    });
+});
+</script>
+{% endblock %}