Canvas\Api\Controllers\CompaniesController

Complexity

Total Complexity

12

Size/Duplication

Total Lines	152
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes	1
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	onConstruct()	0	10	1
A	delete()	0	11	3
A	edit()	0	12	3
A	processOutput()	0	24	4
A	index()	0	4	1

<?php

declare(strict_types=1);

namespace Canvas\Api\Controllers;

use Canvas\Models\Companies;
use Phalcon\Http\Response;

The type Phalcon\Http\Response was not found. Maybe you did not declare it correctly or list all dependencies?

use Baka\Http\Contracts\Api\CrudCustomFieldsBehaviorTrait;

The type Baka\Http\Contracts\Api\CrudCustomFieldsBehaviorTrait was not found. Maybe you did not declare it correctly or list all dependencies?

use Canvas\Http\Exception\UnauthorizedException;

/**
 * Class CompaniesController.
 *
 * @package Canvas\Api\Controllers
 *
 * @property Users $userData
 * @property Request $request
 */
class CompaniesController extends BaseController
{
    use CrudCustomFieldsBehaviorTrait;

    /*
     * fields we accept to create
     *
     * @var array
     */
    protected $createFields = [
        'name',
        'profile_image',
        'website',
        'users_id',
        'address',
        'zipcode',
        'email',
        'language',
        'timezone',
        'currency_id',
        'phone'
    ];

    /*
     * fields we accept to create
     *
     * @var array
     */
    protected $updateFields = [
        'name',
        'profile_image',
        'website',
        'address',
        'zipcode',
        'email',
        'language',
        'timezone',
        'currency_id',
        'phone'];

    /**
     * set objects.
     *
     * @return void
     */
    public function onConstruct()
    {
        $this->model = new Companies();

The property model does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        $this->model->users_id = $this->userData->getId();

        //my list of avaiable companies
        $this->additionalSearchFields = [

The property additionalSearchFields does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

            ['id', ':', implode('|', $this->userData->getAssociatedCompanies())],
            ['is_deleted', ':', '0']
        ];
    }

    /**
     * List items.
     *
     * @method GET
     * url /v1/controller
     *
     * @param mixed $id
     * @return \Phalcon\Http\Response
     */
    public function index(): Response
    {
        $results = $this->processIndex();
        return $this->response($this->processOutput($results));
    }

    /**
     * Update an item.
     *
     * @method PUT
     * url /v1/companies/{id}
     *
     * @param mixed $id
     *
     * @return \Phalcon\Http\Response
     * @throws \Exception
     */
    public function edit($id): Response
    {
        $company = $this->model->findFirstOrFail($id);

        if (!$company->userAssociatedToCompany($this->userData) && !$this->userData->hasRole('Default.Admins')) {
            throw new UnauthorizedException(_('You dont have permission to update this company info'));
        }

        //process the input
        $result = $this->processEdit($this->request, $company);

        return $this->response($this->processOutput($result));
    }

    /**
     * Delete an item.
     *
     * @method DELETE
     * url /v1/companies/{id}
     *
     * @param mixed $id
     *
     * @return \Phalcon\Http\Response
     * @throws \Exception
     */
    public function delete($id): Response
    {
        $company = $this->model->findFirstOrFail($id);
        if (!$company->userAssociatedToCompany($this->userData) && !$this->userData->hasRole('Default.Admins')) {
            throw new UnauthorizedException(_('You dont have permission to delete this company'));
        }

        $company->is_deleted = 1;
        $company->updateOrFail();

        return $this->response(['Delete Successfully']);
    }

    /**
     * Format output.
     *
     * @param mixed $results
     * @return mixed
     */
    protected function processOutput($results)
    {
        /**
         * Check if the branches exists on results.
         */
        if (array_key_exists('branch', $results)) {
            /**
            * Format branches as an array of branches even if there is only one branch per company.
            */
            foreach ($results as $key => $value) {
                /*   if (is_object($value['branch'])) {
                      $results[$key]['branch'] = [$value['branch']];
                  } */
            }

            /**
             * Format branches as an array of branches even if there is only one branch in a unique company.
             */
            if (is_object(current($results)['branch'])) {
                $results[0]['branch'] = [current($results)['branch']];
            }
        }

        return $results;
    }
}