Add Static Content feature. #298

config/acl.yaml

@@ -366,3 +366,17 @@ access_keys:
           label: Add
         - id: warranty.update
           label: Update
+
+    - id: staticcontent
+      label: Static Content
+      acls:
+        - id: static_content.menu
+          label: Menu
+        - id: static_content.list
+          label: List
+        - id: static_content.add
+          label: Add
+        - id: static_content.update
+          label: Update
+        - id: static_content.delete
+          label: Delete

config/menu.yaml

@@ -155,6 +155,10 @@ main_menu:
       acl: warranty.upload
       label: Warranty Upload
       parent: support
+    - id: static_content_list
+      acl: static_content.list
+      label: Static Content
+      parent: support
 
     - id: service
       acl: service.menu

config/routes/static_content.yaml

@@ -0,0 +1,33 @@
+static_content_list:
+    path: /static_content
+    controller: App\Controller\StaticContentController::index
+
+static_content_rows:
+    path: /static_content/rows
+    controller: App\Controller\StaticContentController::rows
+    methods: [POST]
+
+static_content_create:
+    path: /static_content/create
+    controller: App\Controller\StaticContentController::addForm
+    methods: [GET]
+
+static_content_create_submit:
+    path: /static_content/create
+    controller: App\Controller\StaticContentController::addSubmit
+    methods: [POST]
+
+static_content_update:
+    path: /static_content/{id}
+    controller: App\Controller\StaticContentController::updateForm
+    methods: [GET]
+
+static_content_update_submit:
+    path: /static_content/{id}
+    controller: App\Controller\StaticContentController::updateSubmit
+    methods: [POST]
+
+static_content_delete:
+    path: /static_content/{id}
+    controller: App\Controller\StaticContentController::destroy
+    methods: [DELETE]

src/Controller/StaticContentController.php

@@ -0,0 +1,272 @@
+<?php
+
+namespace App\Controller;
+
+use App\Entity\StaticContent;
+
+use Doctrine\ORM\Query;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\Security\Core\Encoder\EncoderFactoryInterface;
+use Symfony\Component\Validator\Validator\ValidatorInterface;
+use Symfony\Bundle\FrameworkBundle\Controller\Controller;
+
+use Catalyst\MenuBundle\Annotation\Menu;
+
+class StaticContentController extends Controller
+{
+    /**
+     * @Menu(selected="static_content_list")
+     */
+    public function index()
+    {
+        $this->denyAccessUnlessGranted('static_content.list', null, 'No access.');
+
+        return $this->render('static-content/list.html.twig');
+    }
+
+    public function rows(Request $req)
+    {
+        $this->denyAccessUnlessGranted('static_content.list', null, 'No access.');
+
+        // build query
+        $qb = $this->getDoctrine()
+                ->getRepository(StaticContent::class)
+                ->createQueryBuilder('q');
+
+        // get datatable params
+        $datatable = $req->request->get('datatable');
+
+        // count total records
+        $tquery = $qb->select('COUNT(q)');
+
+        // add fitlers to count query
+        $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');
+
+        // add filters to query
+        $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();
+
+            // add row metadata
+            $row['meta'] = [
+                'update_url' => '',
+                'delete_url' => ''
+            ];
+
+            // add crud urls
+            if ($this->isGranted('static_content.update'))
+                $row['meta']['update_url'] = $this->generateUrl('static_content_update', ['id' => $row['id']]);
+            if ($this->isGranted('static_content.delete'))
+                $row['meta']['delete_url'] = $this->generateUrl('static_content_delete', ['id' => $row['id']]);
+
+            $rows[] = $row;
+        }
+
+        // response
+        return $this->json([
+            'meta' => $meta,
+            'data' => $rows
+        ]);
+    }
+
+    /**
+     * @Menu(selected="static_content_list")
+     */
+    public function addForm()
+    {
+        $this->denyAccessUnlessGranted('static_content.add', null, 'No access.');
+
+        $params = [];
+        $params['obj'] = new StaticContent();
+        $params['mode'] = 'create';
+
+        // response
+        return $this->render('static-content/form.html.twig', $params);
+    }
+
+    public function addSubmit(Request $req, ValidatorInterface $validator)
+    {
+        $this->denyAccessUnlessGranted('static_content.add', null, 'No access.');
+
+        // create new object
+        $em = $this->getDoctrine()->getManager();
+        $row = new StaticContent();
+
+        // set and save values
+        $row->setID($req->request->get('id'));
+        $row->setContent($req->request->get('content'));
+
+        // validate
+        $errors = $validator->validate($row);
+
+        // 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);
+        } else {
+            // validated! save the entity
+            $em->persist($row);
+            $em->flush();
+
+            // return successful response
+            return $this->json([
+                'success' => 'Changes have been saved!'
+            ]);
+        }
+    }
+
+    /**
+     * @Menu(selected="static_content_list")
+     */
+    public function updateForm($id)
+    {
+        $this->denyAccessUnlessGranted('static_content.update', null, 'No access.');
+
+        $params = [];
+        $params['mode'] = 'update';
+
+        // get row data
+        $em = $this->getDoctrine()->getManager();
+        $row = $em->getRepository(StaticContent::class)->find($id);
+
+        // make sure this row exists
+        if (empty($row))
+            throw $this->createNotFoundException('The item does not exist');
+
+        $params['obj'] = $row;
+
+        // response
+        return $this->render('static-content/form.html.twig', $params);
+    }
+
+    public function updateSubmit(Request $req, ValidatorInterface $validator, $id)
+    {
+        $this->denyAccessUnlessGranted('static_content.update', null, 'No access.');
+
+        // get row data
+        $em = $this->getDoctrine()->getManager();
+        $row = $em->getRepository(StaticContent::class)->find($id);
+
+        // make sure this row exists
+        if (empty($row))
+            throw $this->createNotFoundException('The item does not exist');
+
+        // set and save values
+        $row->setID($req->request->get('id'))
+            ->setContent($req->request->get('content'));
+
+        // validate
+        $errors = $validator->validate($row);
+
+        // 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);
+        } else {
+            // validated! save the entity
+            $em->flush();
+
+            // return successful response
+            return $this->json([
+                'success' => 'Changes have been saved!'
+            ]);
+        }
+    }
+
+    /**
+     * @Menu(selected="static_content_list")
+     */
+    public function destroy($id)
+    {
+        $this->denyAccessUnlessGranted('static_content.delete', null, 'No access.');
+
+        $params = [];
+
+        // get row data
+        $em = $this->getDoctrine()->getManager();
+        $row = $em->getRepository(StaticContent::class)->find($id);
+
+        if (empty($row))
+            throw $this->createNotFoundException('The item does not exist');
+
+        // delete this row
+        $em->remove($row);
+        $em->flush();
+
+        // response
+        $response = new Response();
+        $response->setStatusCode(Response::HTTP_OK);
+        $response->send();
+    }
+
+    protected function setQueryFilters($datatable, &$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/StaticContent.php

@@ -0,0 +1,54 @@
+<?php
+
+namespace App\Entity;
+
+use Doctrine\ORM\Mapping as ORM;
+use Symfony\Component\Validator\Constraints as Assert;
+
+/**
+ * @ORM\Entity
+ * @ORM\Table(name="static_content")
+ */
+class StaticContent
+{
+    // unique id
+    /**
+     * @ORM\Id
+     * @ORM\Column(type="string", length=50)
+     * @Assert\NotBlank()
+     */
+    protected $id;
+
+    // content
+    /**
+     * @ORM\Column(type="text")
+     */
+    protected $content;
+
+    public function __construct()
+    {
+    }
+
+    public function setID($id)
+    {
+        $this->id = $id;
+        return $this;
+    }
+
+    public function getID()
+    {
+        return $this->id;
+    }
+
+    public function setContent($content)
+    {
+        $this->content = $content;
+        return $this;
+    }
+
+    public function getContent()
+    {
+        return $this->content;
+    }
+}
+

templates/static-content/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">Static Content</h3>
+            </div>
+        </div>
+    </div>
+    <!-- END: Subheader -->
+    <div class="m-content">
+        <!--Begin::Section -->
+        <div class="row">
+            <div class="col-xl-8">
+                <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-key"></i>
+                                </span>
+                                <h3 class="m-portlet__head-text">
+                                    {% if mode == 'update' %}
+                                        Edit Static Content 
+                                        <small>{{ obj.getID() }}</small>
+                                    {% else %}
+                                        New Static Content
+                                    {% 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('static_content_update_submit', {'id': obj.getID()}) : url('static_content_create_submit') }}">
+                        <div class="m-portlet__body">
+                            <div class="form-group m-form__group row no-border">
+                                <div class="col-lg-12">
+                                    <label data-field="id">
+                                        ID:
+                                    </label>
+                                    <input type="text" name="id" class="form-control m-input" value="{{ obj.getID() }}">
+                                    <div class="form-control-feedback hide" data-field="id"></div>
+                                </div>
+                            </div>
+                            <div class="form-group m-form__group row no-border">
+                                <div class="col-lg-12">
+                                    <label data-field="content">
+                                        Content
+                                    </label>
+                                    <textarea name="content" class="form-control m-input" data-name="content" rows="50">{{ obj.getContent() }}</textarea>
+                                    <div class="form-control-feedback hide" data-field="content"></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('static_content_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('static_content_list') }}";
+                    }
+                });
+            }).fail(function(response) {
+                if (response.status == 422 || response.status == 403) {
+                    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/static-content/list.html.twig

@@ -0,0 +1,138 @@
+{% 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">
+                    Static Content 
+                </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('static_content_create') }}" class="btn btn-focus m-btn m-btn--custom m-btn--icon m-btn--air m-btn--pill">
+                                        <span>
+                                            <i class="la la-key"></i>
+                                            <span>New Static Content</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("static_content_rows") }}',
+                        method: 'POST'
+                    }
+                },
+                saveState: {
+                    cookie: false,
+                    webstorage: false
+                },
+                pageSize: 10,
+                serverPaging: true,
+                serverFiltering: true,
+                serverSorting: true
+            },
+            columns: [
+            {
+                field: 'id',
+                title: 'ID'
+            },
+            {
+                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.id + '" 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 %}