YetiForceCompany/YetiForceCRM

View on GitHub
api/webservice/WebservicePremium/Users/Preferences.php

Summary

Maintainability
A
0 mins
Test Coverage
F
0%

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

use OpenApi\Annotations as OA;

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

     *          description="Input data",

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

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

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(property="result", type="boolean", description="Password change status", example=false),

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

        $data = [];

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

     *          description="Input data",

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

     *                 mediaType="multipart/form-data",

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

     *                 @OA\Schema(ref="#/components/schemas/Users_Put_Preferences_Request")

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

     *                 mediaType="application/x-www-form-urlencoded",

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

     *             ),

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

     *        summary="Changes user’s preferences",

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

     *        description="Changes user’s preferences",

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

     *        description="Changes user’s preferences",

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

     *             @OA\MediaType(

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

     *        @OA\Response(

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

     *         schema="Users_Put_Preferences_Request",

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

     *                 mediaType="multipart/form-data",

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

     *             ),

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

     *    @OA\Schema(

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

     *         title="Users module - Response content of changing user settings",

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

     *             ),

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

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

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

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

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

     * @OA\Schema(

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

     * ),

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

    }

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\RequestBody(

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

    public function put(): bool

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

        foreach ($this->controller->request->getContentKeys() as $key) {

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

     *             @OA\MediaType(

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

     *             @OA\MediaType(

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

     *            description="Response",

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

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

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

     *         schema="Users_Put_Preferences_Response",

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

     *        @OA\RequestBody(

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

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

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

     *             @OA\MediaType(

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

     *        type="object",

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

            $data[$key] = $this->controller->request->get($key);

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\Schema(ref="#/components/schemas/Users_Put_Preferences_Request")

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

     * ),

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

     *        example={"menuPin" : 1},

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 - Response content of changing user settings",

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

            'preferences' => $data,

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

     *        path="/webservice/WebservicePremium/Users/Preferences",

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

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

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(property="result", type="boolean", description="Password change status", example=false),

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

     *          required=true,

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

     *                 @OA\Schema(ref="#/components/schemas/Users_Put_Preferences_Request")

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

     *        ),

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\Schema(

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

     *         schema="Users_Put_Preferences_Response",

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

     *        tags={"Users"},

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

     *          required=true,

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

     *        ),

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

     *        @OA\Response(

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

     *            response=200,

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

     *            description="Response",

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

     *         schema="Users_Put_Preferences_Request",

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

     *        example={"menuPin" : 1},

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

     *    ),

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

     *        type="object",

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

     *                 mediaType="application/x-www-form-urlencoded",

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

     *         title="Users module - Content of the request to change the user's settings",

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

        ]);

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

     *        summary="Changes user’s preferences",

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\Schema(ref="#/components/schemas/Users_Put_Preferences_Request")

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

     *         title="Users module - Content of the request to change the user's settings",

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

        return true;

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

     * Put method - Changes user’s preferences.

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

     *

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

     * @OA\Put(

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

     *        path="/webservice/WebservicePremium/Users/Preferences",

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

     * @return bool

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

    {

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

    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

    /**

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"),

There are no issues that match your filters.

Category
Status