YetiForceCompany/YetiForceCRM

View on GitHub
api/webservice/WebservicePremium/BaseModule/RelatedModules.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

     *            @OA\XmlContent(ref="#/components/schemas/BaseModule_Get_RelatedModules_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\Property(property="relatedModuleName", type="string", description="Related module name", example="Documents"),

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

     *        @OA\Response(response=200, description="List of related modules",

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

     *        @OA\Response(response=405, description="Method Not Allowed",

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

     *            @OA\Property(property="base", type="object", title="Base list",

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

     *                    required={"type", "label", "icon"},

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

     *        ),

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

     *        @OA\Response(response=401, description="`No sent token` OR `Invalid token`",

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

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

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

     *        @OA\Response(response=403, description="No permissions for module",

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="base", type="object", title="Base list",

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

     *                     @OA\Property(property="icon", type="string", description="Icon class", example="fas fa-desktop"),

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

     *                     @OA\Property(property="icon", type="string", description="Icon class", example="fas fa-desktop"),

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/{moduleName}/RelatedModules",

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

     *                     @OA\Property(property="label", type="string", description="Translated label", example="Documents"),

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

     *        @OA\Response(response=403, description="No permissions for module",

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

     *                     @OA\Property(property="relationId", type="integer", description="Relation ID", example=3),

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

     *        description="Module action related modules list response body",

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

     *                     @OA\Property(property="icon", type="string", description="Icon class", example="yfm-Documents"),

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

     *                     @OA\Property(property="actions", type="array", @OA\Items(type="string"), description="Actions", example={"add", "select"}),

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

     *                     @OA\Property(property="customView", type="array", @OA\Items(type="string"), description="Custom view", example={"relation", "all"}),

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

     *        @OA\Property(property="result", type="object", title="List of related records",

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

     *        description="Gets a list of related modules",

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

     *        summary="Related list of modules",

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

     *        @OA\Response(response=401, description="`No sent token` OR `Invalid token`",

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\AdditionalProperties(type="object",

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

     *                     @OA\Property(property="label", type="string", description="Translated label", example="Summary"),

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

     *                    required={"label", "relationId", "relatedModuleName", "icon", "actions", "viewType", "customView"},

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

     *                     @OA\Property(property="viewType", type="array", @OA\Items(type="string"), description="View types", example={"RelatedTab", "DetailBottom"}),

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

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

     *        title="Base module - Response action related modules list",

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

     *        tags={"BaseModule"},

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\Parameter(name="moduleName", in="path", @OA\Schema(type="string"), description="Module name", required=true, example="Contacts"),

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

     *            @OA\JsonContent(ref="#/components/schemas/BaseModule_Get_RelatedModules_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

     *        @OA\Response(response=405, description="Method Not Allowed",

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

     *        schema="BaseModule_Get_RelatedModules_Response",

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

     *                     @OA\Property(property="label", type="string", description="Translated label", example="Summary"),

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

     *        summary="Related list of modules",

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

     *        @OA\Parameter(name="moduleName", in="path", @OA\Schema(type="string"), description="Module name", required=true, example="Contacts"),

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

     *        ),

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

     *            required={"base", "related"},

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

     *            @OA\Property(property="related", type="object", title="Base list",

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

     *        tags={"BaseModule"},

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="result", type="object", title="List of related records",

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

     *            @OA\Property(property="related", type="object", title="Base list",

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

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

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

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

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

     *        ),

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

     *        title="Base module - Response action related modules list",

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

     *                @OA\AdditionalProperties(type="object",

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

     *                     @OA\Property(property="type", type="string", description="Type", example="Summary"),

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

     *                     @OA\Property(property="label", type="string", description="Translated label", example="Documents"),

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

     *        schema="BaseModule_Get_RelatedModules_Response",

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\AdditionalProperties(type="object",

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

     *                     @OA\Property(property="icon", type="string", description="Icon class", example="yfm-Documents"),

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

     *                     @OA\Property(property="viewType", type="array", @OA\Items(type="string"), description="View types", example={"RelatedTab", "DetailBottom"}),

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

     *        ),

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

     *        ),

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

     *                    required={"type", "label", "icon"},

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

     *        description="Module action related modules list response body",

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

     *                     @OA\Property(property="relatedModuleName", type="string", description="Related module name", example="Documents"),

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

     *        @OA\Response(response=200, description="List of related modules",

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

     *    @OA\Get(

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="type", type="string", description="Type", example="Summary"),

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

     *        path="/webservice/WebservicePremium/{moduleName}/RelatedModules",

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

     *            ),

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

     *        description="Gets a list of related modules",

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

     *                @OA\AdditionalProperties(type="object",

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\Property(property="actions", type="array", @OA\Items(type="string"), description="Actions", example={"add", "select"}),

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

     *            required={"base", "related"},

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

     *                    required={"label", "relationId", "relatedModuleName", "icon", "actions", "viewType", "customView"},

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

     *                     @OA\Property(property="relationId", type="integer", description="Relation ID", example=3),

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

     *                     @OA\Property(property="customView", type="array", @OA\Items(type="string"), description="Custom view", example={"relation", "all"}),

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

    {

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

        return parent::get();

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

     *            ),

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

     *            ),

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

     *                 ),

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

     *                 ),

Line exceeds 120 characters; contains 121 characters
Open

     *                     @OA\Property(property="label", type="string", description="Translated label", example="Summary"),

Line exceeds 120 characters; contains 145 characters
Open

     *        @OA\Parameter(name="moduleName", in="path", @OA\Schema(type="string"), description="Module name", required=true, example="Contacts"),

Line exceeds 120 characters; contains 123 characters
Open

     *                     @OA\Property(property="label", type="string", description="Translated label", example="Documents"),

Line exceeds 120 characters; contains 147 characters
Open

     *                     @OA\Property(property="actions", type="array", @OA\Items(type="string"), description="Actions", example={"add", "select"}),

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

     * Get related modules list method.

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

    /**

Line exceeds 120 characters; contains 164 characters
Open

     *                     @OA\Property(property="viewType", type="array", @OA\Items(type="string"), description="View types", example={"RelatedTab", "DetailBottom"}),

Line exceeds 120 characters; contains 121 characters
Open

     *                     @OA\Property(property="icon", type="string", description="Icon class", example="fas fa-desktop"),

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

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

     * @return array

Line exceeds 120 characters; contains 138 characters
Open

     *                     @OA\Property(property="relatedModuleName", type="string", description="Related module name", example="Documents"),

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

     *

Line exceeds 120 characters; contains 123 characters
Open

     *                    required={"label", "relationId", "relatedModuleName", "icon", "actions", "viewType", "customView"},

Line exceeds 120 characters; contains 156 characters
Open

     *                     @OA\Property(property="customView", type="array", @OA\Items(type="string"), description="Custom view", example={"relation", "all"}),

There are no issues that match your filters.

Category
Status