File Commands/UserCommand.php | JRA, PHP cAPI interface

  1   2   3   4   5   6   7   8   9  10  11  12  13  14  15  16  17  18  19  20  21  22  23  24  25  26  27  28  29  30  31  32  33  34  35  36  37  38  39  40  41  42  43  44  45  46  47  48  49  50  51  52  53  54  55  56  57  58  59  60  61  62  63  64  65  66  67  68  69  70  71  72  73  74  75  76  77  78  79  80  81  82  83  84  85  86  87  88  89  90  91  92  93  94  95  96  97  98  99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154

<?php
/**
 * Created by PhpStorm.
 * Copyright: Bertschi AG, 2016
 * User: jbaumann
 * File: UserCommand.php
 * Date: 18.01.2016
 * Time: 17:09
 */

namespace JRA\Commands;


use JRA\Abstracts\AbstractCommand;
use JRA\Commands\Methods\User\GetUser;
use JRA\Commands\Methods\User\GetUserLoginUsernamePassword;
use JRA\Commands\Methods\User\GetUserLogoutUserSession;
use JRA\Commands\Methods\User\GetUserSessions;
use JRA\Commands\Methods\User\PutUserProfile;
use JRA\Commands\Methods\User\PutUserProfileId;
use JRA\Commands\Routes\UserRoutes;
use JRA\Exceptions\CommandException;

class UserCommand extends AbstractCommand
{

    /**
     * Processes the whole command
     *
     * @throws CommandException
     */
    public function process()
    {
        $this->_defineMethod();
        $this->_defineAdditionalArguments();
        $this->_checkMethodArguments();
        $this->_processAutoLogin();
        $this->_processMethod();
        $this->_storeResponse();
    }

    /**
     * Defines the current required class and registers them.
     *
     * @throws CommandException
     */
    private function _defineMethod()
    {
        switch ($this->getMethodRoute()) {
            case UserRoutes::GET_USER:
                $method = new GetUser($this->_config, $this->_factory);
                $method->setMethodRoute(UserRoutes::GET_USER);
                $this->_setMethod($method);
                break;
            case UserRoutes::GET_USER_LOGIN_USERNAME_PASSWORD:
                $method = new GetUserLoginUsernamePassword($this->_config, $this->_factory);
                $method->setMethodRoute(UserRoutes::GET_USER_LOGIN_USERNAME_PASSWORD);
                $this->_setMethod($method);
                break;
            case UserRoutes::GET_USER_LOGOUT_USER_SESSION:
                $method = new GetUserLogoutUserSession($this->_config, $this->_factory);
                $method->setMethodRoute(UserRoutes::GET_USER_LOGOUT_USER_SESSION);
                $this->_setMethod($method);
                break;
            case UserRoutes::GET_USER_SESSIONS:
                $method = new GetUserSessions($this->_config, $this->_factory);
                $method->setMethodRoute(UserRoutes::GET_USER_SESSIONS);
                $this->_setMethod($method);
                break;
            case UserRoutes::PUT_USER_PROFILE:
                $method = new PutUserProfile($this->_config, $this->_factory);
                $method->setMethodRoute(UserRoutes::PUT_USER_PROFILE);
                $this->_setMethod($method);
                break;
            case UserRoutes::PUT_USER_PROFILE_ID:
                $method = new PutUserProfileId($this->_config, $this->_factory);
                $method->setMethodRoute(UserRoutes::PUT_USER_PROFILE_ID);
                $this->_setMethod($method);
                break;
            default:
                throw new CommandException('No correct route specified.', CommandException::COMMAND_EXCEPTION_ROUTES_ERROR);
                break;
        }
    }

    /**
     * Set the additional arguments, which are given for the current request.
     */
    private function _defineAdditionalArguments()
    {
        $this->_getMethod()
            ->setAdditionalArguments(
                $this->getAdditionalArguments()
            );
    }


    /**
     * Checks if all required arguments are given.
     *
     * @return bool
     * @throws CommandException
     */
    protected function _checkMethodArguments()
    {
        if ($this->_getMethod()->checkArguments()) {
            return true;
        } else {
            throw new CommandException('Invalid additional arguments.', CommandException::COMMAND_EXCEPTION_ADDITIONAL_ARGUMENTS_ERROR);
        }
    }

    /**
     * The methods need to check addition arguments by itself.
     *
     * @return boolean
     */
    protected function _checkArguments()
    {
        return true;
    }

    /**
     * If the login should be process automatically, this will execute the necessary functions.
     */
    private function _processAutoLogin()
    {
        $globalAutoLogin = $this->_config->isAutoLoginOn();
        $methodSpecifiedAutoLogin = $this->_getMethod()->isAutoLogin();

        if ($globalAutoLogin && $methodSpecifiedAutoLogin) {
            $this->_factory
                ->getChainFactory()
                ->getLoginChain()
                ->handle($this->_config, $this->_factory);
        }
    }

    /**
     * Executes the process method of the given method.
     */
    private function _processMethod()
    {
        $this->_getMethod()->process();
    }

    /**
     * Stored the response of the method.
     */
    private function _storeResponse()
    {
        $this->setResponse($this->_getMethod()->getResponse());
    }
}

Namespaces

Classes

Interfaces

Exceptions