Create organisation functionality

2022-02-04 11:23:48 +00:00
parent 584aa1909e
commit f850e4cace
11 changed files with 346 additions and 1 deletions
--- a/src/Controller/OrganisationController.php
+++ b/src/Controller/OrganisationController.php
@@ -29,6 +29,102 @@ use UserFrosting\Support\Exception\NotFoundException;
 */
 class OrganisationController extends SimpleController
 {
+    /**
+     * Processes the request to create a new organisation.
+     *
+     * Processes the request from the organisation creation form, checking that:
+     * 1. The organisation name and slug are not already in use;
+     * 2. The user has permission to create a new organisation;
+     * 3. The submitted data is valid.
+     * This route requires authentication (and should generally be limited to admins or the root user).
+     *
+     * Request type: POST
+     *
+     * @see getModalCreateOrganisation
+     *
+     * @param Request  $request
+     * @param Response $response
+     * @param array    $args
+     *
+     * @throws ForbiddenException If user is not authorized to access page
+     */
+    public function create(Request $request, Response $response, $args)
+    {
+        // Get POST parameters: name, slug, icon, description
+        $params = $request->getParsedBody();
+
+        /** @var \UserFrosting\Sprinkle\Account\Authorize\AuthorizationManager $authorizer */
+        $authorizer = $this->ci->authorizer;
+
+        /** @var \UserFrosting\Sprinkle\Account\Database\Models\Interfaces\UserInterface $currentUser */
+        $currentUser = $this->ci->currentUser;
+
+        // Access-controlled page
+        if (!$authorizer->checkAccess($currentUser, 'create_organisation')) {
+            throw new ForbiddenException();
+        }
+
+        /** @var \UserFrosting\Sprinkle\Core\Alert\AlertStream $ms */
+        $ms = $this->ci->alerts;
+
+        // Load the request schema
+        $schema = new RequestSchema('schema://requests/organisation/create.yaml');
+
+        // Whitelist and set parameter defaults
+        $transformer = new RequestDataTransformer($schema);
+        $data = $transformer->transform($params);
+
+        $error = false;
+
+        // Validate request data
+        $validator = new ServerSideValidator($schema, $this->ci->translator);
+        if (!$validator->validate($data)) {
+            $ms->addValidationErrors($validator);
+            $error = true;
+        }
+
+        /** @var \UserFrosting\Sprinkle\Core\Util\ClassMapper $classMapper */
+        $classMapper = $this->ci->classMapper;
+
+        // Check if name or slug already exists
+        if ($classMapper->getClassMapping('organisation')::where('name', $data['name'])->first()) {
+            $ms->addMessageTranslated('danger', 'ORGANISATION.NAME.IN_USE', $data);
+            $error = true;
+        }
+
+        if ($classMapper->getClassMapping('organisation')::where('slug', $data['slug'])->first()) {
+            $ms->addMessageTranslated('danger', 'ORGANISATION.SLUG.IN_USE', $data);
+            $error = true;
+        }
+
+        if ($error) {
+            return $response->withJson([], 400);
+        }
+
+        /** @var \UserFrosting\Support\Repository\Repository $config */
+        $config = $this->ci->config;
+
+        // All checks passed!  log events/activities and create organisation
+        // Begin transaction - DB will be rolled back if an exception occurs
+        Capsule::transaction(function () use ($classMapper, $data, $ms, $currentUser) {
+            // Create the organisation
+            $organisation = $classMapper->createInstance('organisation', $data);
+
+            // Store new organisation to database
+            $organisation->save();
+
+            // Create activity record
+            $this->ci->userActivityLogger->info("User {$currentUser->user_name} created organisation {$organisation->name}.", [
+                'type'    => 'organisation_create',
+                'user_id' => $currentUser->id,
+            ]);
+
+            $ms->addMessageTranslated('success', 'ORGANISATION.CREATION_SUCCESSFUL', $data);
+        });
+
+        return $response->withJson([], 200);
+    }
+
    /**
     * Returns a list of Organisations.
     *
@@ -69,6 +165,66 @@ class OrganisationController extends SimpleController
        return $sprunje->toResponse($response);
    }

+    /**
+     * Renders the modal form for creating a new organisation.
+     *
+     * This does NOT render a complete page.  Instead, it renders the HTML for the modal, which can be embedded in other pages.
+     * This page requires authentication.
+     *
+     * Request type: GET
+     *
+     * @param Request  $request
+     * @param Response $response
+     * @param array    $args
+     *
+     * @throws ForbiddenException If user is not authorized to access page
+     */
+    public function getModalCreate(Request $request, Response $response, $args)
+    {
+        /** @var \UserFrosting\Sprinkle\Account\Authorize\AuthorizationManager $authorizer */
+        $authorizer = $this->ci->authorizer;
+
+        /** @var \UserFrosting\Sprinkle\Account\Database\Models\Interfaces\UserInterface $currentUser */
+        $currentUser = $this->ci->currentUser;
+
+        /** @var \UserFrosting\I18n\Translator $translator */
+        $translator = $this->ci->translator;
+
+        // Access-controlled page
+        if (!$authorizer->checkAccess($currentUser, 'create_organisation')) {
+            throw new ForbiddenException();
+        }
+
+        /** @var \UserFrosting\Sprinkle\Core\Util\ClassMapper $classMapper */
+        $classMapper = $this->ci->classMapper;
+
+        // Create a dummy organisation to prepopulate fields
+        $organisation = $classMapper->createInstance('organisation', []);
+
+        $fieldNames = ['name', 'slug', 'description'];
+        $fields = [
+            'hidden'   => [],
+            'disabled' => [],
+        ];
+
+        // Load validation rules
+        $schema = new RequestSchema('schema://requests/organisation/create.yaml');
+        $validator = new JqueryValidationAdapter($schema, $this->ci->translator);
+
+        return $this->ci->view->render($response, 'modals/organisation.html.twig', [
+            'organisation' => $organisation,
+            'form'  => [
+                'action'      => 'api/organisations',
+                'method'      => 'POST',
+                'fields'      => $fields,
+                'submit_text' => $translator->translate('CREATE'),
+            ],
+            'page' => [
+                'validators' => $validator->rules('json', false),
+            ],
+        ]);
+    }
+
    /**
     * Renders the organisation listing page.
     *