From f57c9f5f4f00807547ad38771c26c7f96b9270fc Mon Sep 17 00:00:00 2001 From: Korina Cordero Date: Thu, 23 Feb 2023 03:08:17 +0000 Subject: [PATCH] Add CRUD for customer locations. #739 --- config/acl.yaml | 14 + config/menu.yaml | 4 + config/routes/customer_location.yaml | 35 +++ src/Controller/CustomerLocationController.php | 253 ++++++++++++++++++ src/Entity/CustomerLocation.php | 63 +++++ src/Entity/JobOrder.php | 18 ++ templates/customer-location/form.html.twig | 142 ++++++++++ templates/customer-location/list.html.twig | 146 ++++++++++ 8 files changed, 675 insertions(+) create mode 100644 config/routes/customer_location.yaml create mode 100644 src/Controller/CustomerLocationController.php create mode 100644 src/Entity/CustomerLocation.php create mode 100644 templates/customer-location/form.html.twig create mode 100644 templates/customer-location/list.html.twig diff --git a/config/acl.yaml b/config/acl.yaml index 64540ecf..0fe347e9 100644 --- a/config/acl.yaml +++ b/config/acl.yaml @@ -586,3 +586,17 @@ access_keys: label: Update - id: ownership_type.delete label: Delete + + - id: customer_location + label: Customer Location Access + acls: + - id: cust_location.menu + label: Menu + - id: cust_location.list + label: List + - id: cust_location.add + label: Add + - id: cust_location.update + label: Update + - id: cust_location.delete + label: Delete diff --git a/config/menu.yaml b/config/menu.yaml index b75a9d38..b2cccd56 100644 --- a/config/menu.yaml +++ b/config/menu.yaml @@ -249,3 +249,7 @@ main_menu: acl: ownership_type.menu label: Ownership Types parent: database + - id: customer_location_list + acl: cust_location.menu + label: Customer Locations + parent: database diff --git a/config/routes/customer_location.yaml b/config/routes/customer_location.yaml new file mode 100644 index 00000000..1ab10970 --- /dev/null +++ b/config/routes/customer_location.yaml @@ -0,0 +1,35 @@ +customer_location_list: + path: /customer-locations + controller: App\Controller\CustomerLocationController::index + methods: [GET] + +customer_location_rows: + path: /customer-locations/rowdata + controller: App\Controller\CustomerLocationController::datatableRows + methods: [POST] + +customer_location_add_form: + path: /customer-locations/newform + controller: App\Controller\CustomerLocationController::addForm + methods: [GET] + +customer_location_add_submit: + path: /customer-locations + controller: App\Controller\CustomerLocationController::addSubmit + methods: [POST] + +customer_location_update_form: + path: /customer-locations/{id} + controller: App\Controller\CustomerLocationController::updateForm + methods: [GET] + +customer_location_update_submit: + path: /customer-locations/{id} + controller: App\Controller\CustomerLocationController::updateSubmit + methods: [POST] + +customer_location_delete: + path: /customer-locations/{id} + controller: App\Controller\CustomerLocationController::deleteSubmit + methods: [DELETE] + diff --git a/src/Controller/CustomerLocationController.php b/src/Controller/CustomerLocationController.php new file mode 100644 index 00000000..f3287543 --- /dev/null +++ b/src/Controller/CustomerLocationController.php @@ -0,0 +1,253 @@ +render('customer-location/list.html.twig'); + } + + /** + * @IsGranted("cust_location.list") + */ + public function datatableRows(Request $req) + { + // get query builder + $qb = $this->getDoctrine() + ->getRepository(CustomerLocation::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('cust_location.update')) + $row['meta']['update_url'] = $this->generateUrl('customer_location_update_form', ['id' => $row['id']]); + if ($this->isGranted('cust_location.delete')) + $row['meta']['delete_url'] = $this->generateUrl('customer_location_delete', ['id' => $row['id']]); + + $rows[] = $row; + } + + // response + return $this->json([ + 'meta' => $meta, + 'data' => $rows + ]); + } + + /** + * @Menu(selected="customer_location.list") + * @IsGranted("cust_location.add") + */ + public function addForm() + { + $cust_location = new CustomerLocation(); + $params = [ + 'cust_location' => $cust_location, + 'mode' => 'create', + ]; + + // response + return $this->render('customer-location/form.html.twig', $params); + } + + /** + * @IsGranted("cust_location.add") + */ + public function addSubmit(Request $req, EntityManagerInterface $em, ValidatorInterface $validator) + { + $cust_location = new CustomerLocation(); + + $this->setObject($cust_location, $req); + + // validate + $errors = $validator->validate($cust_location); + + // 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($cust_location); + $em->flush(); + + // return successful response + return $this->json([ + 'success' => 'Changes have been saved!' + ]); + + } + + /** + * @Menu(selected="customer_location_list") + * @ParamConverter("cust_location", class="App\Entity\CustomerLocation") + * @IsGranted("cust_location.update") + */ + public function updateForm($id, EntityManagerInterface $em, CustomerLocation $cust_location) + { + $params = []; + $params['cust_location'] = $cust_location; + $params['mode'] = 'update'; + + // response + return $this->render('customer-location/form.html.twig', $params); + } + + /** + * @ParamConverter("cust_location", class="App\Entity\CustomerLocation") + * @IsGranted("cust_location.update") + */ + public function updateSubmit(Request $req, EntityManagerInterface $em, ValidatorInterface $validator, CustomerLocation $cust_location) + { + $this->setObject($cust_location, $req); + + // validate + $errors = $validator->validate($cust_location); + + // 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("cust_location", class="App\Entity\CustomerLocation") + * @IsGranted("cust_location.update") + */ + public function deleteSubmit(EntityManagerInterface $em, CustomerLocation $cust_location) + { + // delete this object + $em->remove($cust_location); + $em->flush(); + + // response + $response = new Response(); + $response->setStatusCode(Response::HTTP_OK); + $response->send(); + } + + + protected function setObject(CustomerLocation $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'] . '%'); + } + } + +} diff --git a/src/Entity/CustomerLocation.php b/src/Entity/CustomerLocation.php new file mode 100644 index 00000000..fd589685 --- /dev/null +++ b/src/Entity/CustomerLocation.php @@ -0,0 +1,63 @@ +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; + } +} diff --git a/src/Entity/JobOrder.php b/src/Entity/JobOrder.php index f9783568..b3b5a62e 100644 --- a/src/Entity/JobOrder.php +++ b/src/Entity/JobOrder.php @@ -422,6 +422,13 @@ class JobOrder */ protected $ownership_type; + // customer location + /** + * @ORM\ManyToOne(targetEntity="CustomerLocation", inversedBy="job_orders") + * @ORM\JoinColumn(name="cust_location_id", referencedColumnName="id", nullable=true) + */ + protected $cust_location; + public function __construct() { $this->date_create = new DateTime(); @@ -1199,4 +1206,15 @@ class JobOrder { return $this->ownership_type; } + + public function setCustomerLocation(CustomerLocation $cust_location = null) + { + $this->cust_location = $cust_location; + return $this; + } + + public function getCustomerLocation() + { + return $this->cust_location; + } } diff --git a/templates/customer-location/form.html.twig b/templates/customer-location/form.html.twig new file mode 100644 index 00000000..76af9e33 --- /dev/null +++ b/templates/customer-location/form.html.twig @@ -0,0 +1,142 @@ +{% extends 'base.html.twig' %} + +{% block body %} + +
+
+
+

Customer Locations

+
+
+
+ +
+ +
+
+
+
+
+
+ + + +

+ {% if mode == 'update' %} + Edit Ownership Type + {{ cust_location.getName() }} + {% else %} + New Customer Location + {% endif %} +

+
+
+
+
+
+
+ +
+ + +
+
+
+ +
+ + +
+
+
+
+
+
+
+ + Back +
+
+
+
+
+
+
+
+
+{% endblock %} + +{% block scripts %} + +{% endblock %} diff --git a/templates/customer-location/list.html.twig b/templates/customer-location/list.html.twig new file mode 100644 index 00000000..f78a2833 --- /dev/null +++ b/templates/customer-location/list.html.twig @@ -0,0 +1,146 @@ +{% extends 'base.html.twig' %} + +{% block body %} + +
+
+
+

+ Customer Locations +

+
+
+
+ +
+ +
+
+
+
+
+
+
+
+
+
+ + + + +
+
+
+
+
+ + + + New Customer Location + + +
+
+
+
+ +
+ +
+
+
+
+
+{% endblock %} + +{% block scripts %} + +{% endblock %}