YetiForceCompany/YetiForceCRM

View on GitHub
api/webservice/WebservicePremium/Users/Record.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;

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

     *            description="Gets data for the user",

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

     * @OA\Schema(

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

     *            type="object",

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="fields", type="object", title="System field names and field labels", example={"field_name_1" : "Field label 1", "field_name_2" : "Field label 2"},

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

     *            @OA\Property(

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

     *            @OA\Property(property="rawData", description="Raw user data", type="object"),

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

     *            @OA\Property(property="rawData", description="Raw user data", type="object"),

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

     *        tags={"Users"},

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

     *            description="Gets data for the user",

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

     *        ),

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

     *            ),

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

     *            @OA\Schema(type="integer"),

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\XmlContent(ref="#/components/schemas/Exception"),

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

     *            response=404,

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

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

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

     *        schema="Users_Get_Record_Response",

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

     *            property="result",

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

     *            ),

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

     *            name="userId",

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

     *            @OA\Property(property="name", description="User label", type="string", example="System Admin"),

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

     *                type="object",

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

     *

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

     *        path="/webservice/WebservicePremium/Users/Record/{userId}",

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

     *        summary="Data for the user",

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

     *        @OA\Parameter(

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

     *            in="path",

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

     *            description="Access denied, access for administrators only",

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

     *            description="User doesn't exist",

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

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

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="id", description="User Id", type="integer", example=1),

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

     *            ),

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

     *            @OA\Property(

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

     *        path="/webservice/WebservicePremium/Users/Record/{userId}",

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

     *            description="User id",

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

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

     *        @OA\Property(

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

     *            @OA\Property(property="id", description="User Id", type="integer", example=1),

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

     * ),

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

        return parent::get();

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

     *        @OA\Parameter(name="x-raw-data", in="header", @OA\Schema(type="integer", enum={0, 1}), description="Gets raw data", required=false, example=1),

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

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

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

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

     *        @OA\Response(

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

     *                property="data",

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

     *                description="Parameters determining checking of editing rights and moving to the trash",

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

     *                 type="object",

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

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

     *        description="Gets details about the user",

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

     *            description="Access denied, access for administrators only",

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

     *            ),

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

     *                description="Parameters determining checking of editing rights and moving to the trash",

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="moveToTrash", description="Permission to delete", type="boolean", example=false),

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

    /**

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

     * Get user detail.

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

     *        summary="Data for the user",

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

     *            response=403,

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

     *        schema="Users_Get_Record_Response",

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

 * @author    Mariusz Krzaczkowski <m.krzaczkowski@yetiforce.com>

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

     *        description="Gets details about the user",

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

     *            in="path",

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

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

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

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

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

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

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

    public function get(): array

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

     *            description="User id",

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

     *            description="User doesn't exist",

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 body for user",

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

     *                 @OA\AdditionalProperties(type="string", description="Field label"),

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

     *                description="User data",

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

     *                description="User data",

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

     *                property="privileges",

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

     *                @OA\Property(property="isEditable", description="Check if user is editable", type="boolean", example=true),

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

     *                @OA\Property(property="moveToTrash", description="Permission to delete", type="boolean", example=false),

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

     *            ),

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

 * @license    YetiForce Public License 6.5 (licenses/LicenseEN.txt or yetiforce.com)

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

     *        @OA\Parameter(

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

     *            example=116,

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\Parameter(name="x-raw-data", in="header", @OA\Schema(type="integer", enum={0, 1}), description="Gets raw data", required=false, example=1),

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

     *            response=404,

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

     *        ),

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

     *            description="User data",

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

     *            @OA\Property(property="name", description="User label", type="string", example="System Admin"),

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

     *            @OA\Property(property="fields", type="object", title="System field names and field labels", example={"field_name_1" : "Field label 1", "field_name_2" : "Field label 2"},

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

     *                property="privileges",

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

     *            example=116,

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

     *            response=403,

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

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

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

     *            description="User data",

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

     *            @OA\Property(

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

     *                @OA\Property(property="isEditable", description="Check if user is editable", type="boolean", example=true),

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

     *            @OA\Schema(type="integer"),

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

     *        ),

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

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

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="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

    {

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 body for user",

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

     *        @OA\Property(

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\AdditionalProperties(type="string", description="Field label"),

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

     *                type="object",

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

     * @return array

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

     *        tags={"Users"},

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

     *            name="userId",

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

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

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

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

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

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

     *        type="object",

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

     *                property="data",

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

     *            ),

Line exceeds 120 characters; contains 155 characters
Open

     *        @OA\Parameter(name="x-raw-data", in="header", @OA\Schema(type="integer", enum={0, 1}), description="Gets raw data", required=false, example=1),

Line exceeds 120 characters; contains 185 characters
Open

     *            @OA\Property(property="fields", type="object", title="System field names and field labels", example={"field_name_1" : "Field label 1", "field_name_2" : "Field label 2"},

Line exceeds 120 characters; contains 131 characters
Open

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

Line exceeds 120 characters; contains 124 characters
Open

     *                @OA\Property(property="moveToTrash", description="Permission to delete", type="boolean", example=false),

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

Line exceeds 120 characters; contains 127 characters
Open

     *                @OA\Property(property="isEditable", description="Check if user is editable", type="boolean", example=true),

There are no issues that match your filters.

Category
Status