YetiForceCompany/YetiForceCRM

View on GitHub
api/webservice/WebserviceStandard/Users/Logout.php

Summary

Maintainability
A
0 mins
Test Coverage
A
100%

Possibly zero references to use statement for classlike/namespace OA (\OpenApi\Annotations)
Open

use OpenApi\Annotations as OA;

Call to undeclared method \App\Db::createCommand
Open

        \App\Db::getInstance('webservice')->createCommand()

Spaces must be used for alignment; tabs are not allowed
Open

     *        description="Logout user out the system",

Spaces must be used for alignment; tabs are not allowed
Open

     *    @OA\SecurityScheme(

Spaces must be used for alignment; tabs are not allowed
Open

     *         description="JSON data",

Spaces must be used for alignment; tabs are not allowed
Open

     *            property="result",

Spaces must be used for alignment; tabs are not allowed
Open

     *            description="Content of responses from a given method",

Spaces must be used for alignment; tabs are not allowed
Open

        ]);

Spaces must be used for alignment; tabs are not allowed
Open

     *         name="X-TOKEN",

Spaces must be used for alignment; tabs are not allowed
Open

            ],

Spaces must be used for alignment; tabs are not allowed
Open

     *        tags={"Users"},

Spaces must be used for alignment; tabs are not allowed
Open

     *        security={{"basicAuth" : {}, "ApiKeyAuth" : {}, "token" : {}}},

Spaces must be used for alignment; tabs are not allowed
Open

     *        ),

Spaces must be used for alignment; tabs are not allowed
Open

     *        required={"status", "result"},

Spaces must be used for alignment; tabs are not allowed
Open

     *        required={"status", "result"},

Spaces must be used for alignment; tabs are not allowed
Open

     *            property="result",

Spaces must be used for alignment; tabs are not allowed
Open

     *        @OA\Parameter(name="X-ENCRYPTED", in="header", @OA\Schema(ref="#/components/schemas/Header-Encrypted"), required=true),

Spaces must be used for alignment; tabs are not allowed
Open

     *    ),

Spaces must be used for alignment; tabs are not allowed
Open

     *         schema="UsersLogoutResponseBody",

Spaces must be used for alignment; tabs are not allowed
Open

     *         description="JSON data",

Spaces must be used for alignment; tabs are not allowed
Open

     *        type="object",

Spaces must be used for alignment; tabs are not allowed
Open

     *        summary="Logout user",

Spaces must be used for alignment; tabs are not allowed
Open

     *        tags={"Users"},

Spaces must be used for alignment; tabs are not allowed
Open

     *       type="apiKey",

Spaces must be used for alignment; tabs are not allowed
Open

     *       in="header",

Spaces must be used for alignment; tabs are not allowed
Open

        return true;

Spaces must be used for alignment; tabs are not allowed
Open

     *            response=200,

Spaces must be used for alignment; tabs are not allowed
Open

     *            @OA\JsonContent(ref="#/components/schemas/UsersLogoutResponseBody"),

Spaces must be used for alignment; tabs are not allowed
Open

     *            @OA\XmlContent(ref="#/components/schemas/UsersLogoutResponseBody"),

Spaces must be used for alignment; tabs are not allowed
Open

     *            description="Content of responses from a given method",

Spaces must be used for alignment; tabs are not allowed
Open

     *            type="boolean",

Spaces must be used for alignment; tabs are not allowed
Open

                'logout_time' => date('Y-m-d H:i:s'),

Spaces must be used for alignment; tabs are not allowed
Open

     *        security={{"basicAuth" : {}, "ApiKeyAuth" : {}, "token" : {}}},

Spaces must be used for alignment; tabs are not allowed
Open

     *            @OA\JsonContent(ref="#/components/schemas/UsersLogoutResponseBody"),

Spaces must be used for alignment; tabs are not allowed
Open

     *        ),

Spaces must be used for alignment; tabs are not allowed
Open

     *        securityScheme="token",

Spaces must be used for alignment; tabs are not allowed
Open

     *            description="User details",

Spaces must be used for alignment; tabs are not allowed
Open

     *         name="X-TOKEN",

Spaces must be used for alignment; tabs are not allowed
Open

     *        ),

Spaces must be used for alignment; tabs are not allowed
Open

     * ),

Spaces must be used for alignment; tabs are not allowed
Open

     *       type="apiKey",

Spaces must be used for alignment; tabs are not allowed
Open

     * @OA\Schema(

Spaces must be used for alignment; tabs are not allowed
Open

     *        @OA\Property(

Spaces must be used for alignment; tabs are not allowed
Open

     *        ),

Spaces must be used for alignment; tabs are not allowed
Open

        $this->updateUser([

Spaces must be used for alignment; tabs are not allowed
Open

     *        @OA\Response(

Spaces must be used for alignment; tabs are not allowed
Open

     *            @OA\XmlContent(ref="#/components/schemas/UsersLogoutResponseBody"),

Spaces must be used for alignment; tabs are not allowed
Open

     *       in="header",

Spaces must be used for alignment; tabs are not allowed
Open

     *         title="Users module - Users logout response body",

Spaces must be used for alignment; tabs are not allowed
Open

     */

Spaces must be used for alignment; tabs are not allowed
Open

            ])->execute();

Spaces must be used for alignment; tabs are not allowed
Open

            'status' => 'LBL_SIGNED_OFF',

Spaces must be used for alignment; tabs are not allowed
Open

     *        @OA\Response(

Spaces must be used for alignment; tabs are not allowed
Open

     *            description="User details",

Spaces must be used for alignment; tabs are not allowed
Open

     *    @OA\SecurityScheme(

Spaces must be used for alignment; tabs are not allowed
Open

     *        type="object",

Spaces must be used for alignment; tabs are not allowed
Open

     *        @OA\Property(

Spaces must be used for alignment; tabs are not allowed
Open

        ]);

Spaces must be used for alignment; tabs are not allowed
Open

     *        summary="Logout user",

Spaces must be used for alignment; tabs are not allowed
Open

     *        @OA\Parameter(name="X-ENCRYPTED", in="header", @OA\Schema(ref="#/components/schemas/Header-Encrypted"), required=true),

Spaces must be used for alignment; tabs are not allowed
Open

     *            response=200,

Spaces must be used for alignment; tabs are not allowed
Open

     *    ),

Spaces must be used for alignment; tabs are not allowed
Open

     *         title="Users module - Users logout response body",

Spaces must be used for alignment; tabs are not allowed
Open

        $this->saveLoginHistory([

Spaces must be used for alignment; tabs are not allowed
Open

     *        path="/webservice/WebserviceStandard/Users/Logout",

Spaces must be used for alignment; tabs are not allowed
Open

     *        securityScheme="token",

Spaces must be used for alignment; tabs are not allowed
Open

     *         schema="UsersLogoutResponseBody",

Spaces must be used for alignment; tabs are not allowed
Open

    public function put(): bool

Spaces must be used for alignment; tabs are not allowed
Open

                'id' => $this->controller->headers['x-token'],

Spaces must be used for alignment; tabs are not allowed
Open

     *       description="Webservice api token by user header"

Spaces must be used for alignment; tabs are not allowed
Open

     *       description="Webservice api token by user header"

Spaces must be used for alignment; tabs are not allowed
Open

     *        @OA\Property(property="status", type="integer", enum={0, 1}, description="A numeric value of 0 or 1 that indicates whether the communication is valid. 1 - success , 0 - error"),

Spaces must be used for alignment; tabs are not allowed
Open

     *            type="boolean",

Spaces must be used for alignment; tabs are not allowed
Open

    {

Spaces must be used for alignment; tabs are not allowed
Open

            ->delete($this->controller->app['tables']['session'], [

Spaces must be used for alignment; tabs are not allowed
Open

     *        description="Logout user out the system",

Spaces must be used for alignment; tabs are not allowed
Open

     * ),

Spaces must be used for alignment; tabs are not allowed
Open

        \App\Db::getInstance('webservice')->createCommand()

Spaces must be used for alignment; tabs are not allowed
Open

    }

Spaces must be used for alignment; tabs are not allowed
Open

     *        @OA\Property(property="status", type="integer", enum={0, 1}, description="A numeric value of 0 or 1 that indicates whether the communication is valid. 1 - success , 0 - error"),

Spaces must be used for alignment; tabs are not allowed
Open

            'custom_params' => [

Spaces must be used to indent lines; tabs are not allowed
Open

    public $allowedMethod = ['PUT'];

Spaces must be used to indent lines; tabs are not allowed
Open

    {

Line exceeds 120 characters; contains 131 characters
Open

     *        @OA\Parameter(name="X-ENCRYPTED", in="header", @OA\Schema(ref="#/components/schemas/Header-Encrypted"), required=true),

Spaces must be used to indent lines; tabs are not allowed
Open

    /**

Spaces must be used to indent lines; tabs are not allowed
Open

     *

Spaces must be used to indent lines; tabs are not allowed
Open

    protected function checkPermissionToModule(): void

Spaces must be used to indent lines; tabs are not allowed
Open

    }

Spaces must be used to indent lines; tabs are not allowed
Open

     * @return bool

Spaces must be used to indent lines; tabs are not allowed
Open

     * @OA\Put(

Line exceeds 120 characters; contains 189 characters
Open

     *        @OA\Property(property="status", type="integer", enum={0, 1}, description="A numeric value of 0 or 1 that indicates whether the communication is valid. 1 - success , 0 - error"),

Spaces must be used to indent lines; tabs are not allowed
Open

    use \Api\Core\Traits\LoginHistory;

Spaces must be used to indent lines; tabs are not allowed
Open

    /** {@inheritdoc}  */

Spaces must be used to indent lines; tabs are not allowed
Open

     * Put method.

Spaces must be used to indent lines; tabs are not allowed
Open

     *

Spaces must be used to indent lines; tabs are not allowed
Open

     *

Spaces must be used to indent lines; tabs are not allowed
Open

    /** {@inheritdoc}  */

Spaces must be used to indent lines; tabs are not allowed
Open

     * @api

Spaces must be used to indent lines; tabs are not allowed
Open

     *        path="/webservice/WebserviceStandard/Users/Logout",

There are no issues that match your filters.

Category
Status