api/webservice/WebservicePremium/BaseModule/Pdf.php
Method get has 34 lines of code (exceeds 25 allowed). Consider refactoring. Open
Open
public function get(): array
{
$file = $pdfFiles = $increment = [];
$recordId = $this->controller->request->getInteger('record');
foreach ($this->controller->request->getArray('templates', 'Integer') as $templateId) {Function get has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring. Open
Open
public function get(): array
{
$file = $pdfFiles = $increment = [];
$recordId = $this->controller->request->getInteger('record');
foreach ($this->controller->request->getArray('templates', 'Integer') as $templateId) {- Read upRead up
Cognitive Complexity
Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.
A method's cognitive complexity is based on a few simple rules:
- Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
- Code is considered more complex for each "break in the linear flow of the code"
- Code is considered more complex when "flow breaking structures are nested"
Further reading
The method get() has a Cyclomatic Complexity of 12. The configured cyclomatic complexity threshold is 10. Open
Open
public function get(): array
{
$file = $pdfFiles = $increment = [];
$recordId = $this->controller->request->getInteger('record');
foreach ($this->controller->request->getArray('templates', 'Integer') as $templateId) {- Read upRead up
- Exclude checks
CyclomaticComplexity
Since: 0.1
Complexity is determined by the number of decision points in a method plus one for the method entry. The decision points are 'if', 'while', 'for', and 'case labels'. Generally, 1-4 is low complexity, 5-7 indicates moderate complexity, 8-10 is high complexity, and 11+ is very high complexity.
Example
// Cyclomatic Complexity = 11
class Foo {
1 public function example() {
2 if ($a == $b) {
3 if ($a1 == $b1) {
fiddle();
4 } elseif ($a2 == $b2) {
fiddle();
} else {
fiddle();
}
5 } elseif ($c == $d) {
6 while ($c == $d) {
fiddle();
}
7 } elseif ($e == $f) {
8 for ($n = 0; $n < $h; $n++) {
fiddle();
}
} else {
switch ($z) {
9 case 1:
fiddle();
break;
10 case 2:
fiddle();
break;
11 case 3:
fiddle();
break;
default:
fiddle();
break;
}
}
}
}Source https://phpmd.org/rules/codesize.html#cyclomaticcomplexity
Missing class import via use statement (line '41', column '14'). Open
Open
throw new \Api\Core\Exception('No permissions to view record', 403);- Read upRead up
- Exclude checks
MissingImport
Since: 2.7.0
Importing all external classes in a file through use statements makes them clearly visible.
Example
function make() {
return new \stdClass();
}Source http://phpmd.org/rules/cleancode.html#MissingImport
Missing class import via use statement (line '34', column '14'). Open
Open
throw new \Api\Core\Exception('Record doesn\'t exist', 404);- Read upRead up
- Exclude checks
MissingImport
Since: 2.7.0
Importing all external classes in a file through use statements makes them clearly visible.
Example
function make() {
return new \stdClass();
}Source http://phpmd.org/rules/cleancode.html#MissingImport
Missing class import via use statement (line '30', column '14'). Open
Open
throw new \Api\Core\Exception('No record id', 404);- Read upRead up
- Exclude checks
MissingImport
Since: 2.7.0
Importing all external classes in a file through use statements makes them clearly visible.
Example
function make() {
return new \stdClass();
}Source http://phpmd.org/rules/cleancode.html#MissingImport
Missing class import via use statement (line '37', column '14'). Open
Open
throw new \Api\Core\Exception("No permissions for action ExportPdf in {$moduleName} module", 405);- Read upRead up
- Exclude checks
MissingImport
Since: 2.7.0
Importing all external classes in a file through use statements makes them clearly visible.
Example
function make() {
return new \stdClass();
}Source http://phpmd.org/rules/cleancode.html#MissingImport
Avoid using static access to class '\App\Record' in method 'checkPermission'. Open
Open
if (!\App\Record::isExists($this->controller->request->getInteger('record'), $moduleName)) {- Read upRead up
- Exclude checks
StaticAccess
Since: 1.4.0
Static access causes unexchangeable dependencies to other classes and leads to hard to test code. Avoid using static access at all costs and instead inject dependencies through the constructor. The only case when static access is acceptable is when used for factory methods.
Example
class Foo
{
public function bar()
{
Bar::baz();
}
}Source https://phpmd.org/rules/cleancode.html#staticaccess
Avoid using static access to class '\App\Pdf\Pdf' in method 'get'. Open
Open
$pdf = \App\Pdf\Pdf::getInstanceByTemplateId($templateId);- Read upRead up
- Exclude checks
StaticAccess
Since: 1.4.0
Static access causes unexchangeable dependencies to other classes and leads to hard to test code. Avoid using static access at all costs and instead inject dependencies through the constructor. The only case when static access is acceptable is when used for factory methods.
Example
class Foo
{
public function bar()
{
Bar::baz();
}
}Source https://phpmd.org/rules/cleancode.html#staticaccess
Avoid using static access to class '\Vtiger_Record_Model' in method 'checkPermission'. Open
Open
$recordModel = \Vtiger_Record_Model::getInstanceById($this->controller->request->getInteger('record'), $moduleName);- Read upRead up
- Exclude checks
StaticAccess
Since: 1.4.0
Static access causes unexchangeable dependencies to other classes and leads to hard to test code. Avoid using static access at all costs and instead inject dependencies through the constructor. The only case when static access is acceptable is when used for factory methods.
Example
class Foo
{
public function bar()
{
Bar::baz();
}
}Source https://phpmd.org/rules/cleancode.html#staticaccess
Avoid using static access to class '\App\Zip' in method 'get'. Open
Open
$zip = \App\Zip::createFile($zipPath);- Read upRead up
- Exclude checks
StaticAccess
Since: 1.4.0
Static access causes unexchangeable dependencies to other classes and leads to hard to test code. Avoid using static access at all costs and instead inject dependencies through the constructor. The only case when static access is acceptable is when used for factory methods.
Example
class Foo
{
public function bar()
{
Bar::baz();
}
}Source https://phpmd.org/rules/cleancode.html#staticaccess
Avoid using static access to class '\Api\WebservicePremium\Privilege' in method 'checkPermission'. Open
Open
if (!\Api\WebservicePremium\Privilege::isPermitted($moduleName, 'ExportPdf')) {- Read upRead up
- Exclude checks
StaticAccess
Since: 1.4.0
Static access causes unexchangeable dependencies to other classes and leads to hard to test code. Avoid using static access at all costs and instead inject dependencies through the constructor. The only case when static access is acceptable is when used for factory methods.
Example
class Foo
{
public function bar()
{
Bar::baz();
}
}Source https://phpmd.org/rules/cleancode.html#staticaccess
Define a constant instead of duplicating this literal "record" 4 times. Open
Open
if ($this->controller->request->isEmpty('record')) {- Read upRead up
- Exclude checks
Duplicated string literals make the process of refactoring error-prone, since you must be sure to update all occurrences.
On the other hand, constants can be referenced from many places, but only need to be updated in a single place.
Noncompliant Code Example
With the default threshold of 3:
function run() {
prepare('action1'); // Non-Compliant - 'action1' is duplicated 3 times
execute('action1');
release('action1');
}
Compliant Solution
ACTION_1 = 'action1';
function run() {
prepare(ACTION_1);
execute(ACTION_1);
release(ACTION_1);
}
Exceptions
To prevent generating some false-positives, literals having less than 5 characters are excluded.
Possibly zero references to use statement for classlike/namespace OA (\OpenApi\Annotations) Open
Open
use OpenApi\Annotations as OA;- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* ),- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* response=200,- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Parameter(name="recordId", in="path", @OA\Schema(type="integer"), description="Record id", required=true, example=116),- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Parameter(name="templates", in="query", description="Pdf templates ids", required=true,- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\JsonContent(type="integer", description="Pdf templates ids"),- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* path="/webservice/WebservicePremium/{moduleName}/Pdf/{recordId}",- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* ),- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* description="Get PDF file by template",- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* security={{"basicAuth" : {}, "ApiKeyAuth" : {}, "token" : {}}},- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Parameter(name="recordId", in="path", @OA\Schema(type="integer"), description="Record id", required=true, example=116),- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* tags={"BaseModule"},- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Parameter(name="moduleName", in="path", @OA\Schema(type="string"), description="Module name", required=true, example="Accounts"),- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Parameter(name="X-ENCRYPTED", in="header", @OA\Schema(ref="#/components/schemas/Header-Encrypted"), required=true),- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* summary="Generates and downloads a PDF file from a template",- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* security={{"basicAuth" : {}, "ApiKeyAuth" : {}, "token" : {}}},- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Parameter(name="moduleName", in="path", @OA\Schema(type="string"), description="Module name", required=true, example="Accounts"),- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* response=200,- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Parameter(name="templates", in="query", description="Pdf templates ids", required=true,- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* tags={"BaseModule"},- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Parameter(name="X-ENCRYPTED", in="header", @OA\Schema(ref="#/components/schemas/Header-Encrypted"), required=true),- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* description="Get PDF file by template",- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* response=403,- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\XmlContent(ref="#/components/schemas/Exception"),- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* ),- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Property(property="name", type="string", example="order.pdf"),- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
{- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
$pdf = \App\Pdf\Pdf::getInstanceByTemplateId($templateId);- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
}- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
$pdf->loadTemplateData();- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
$zipPath = $template->getPath('APIZIP');- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
$file = ['name' => 'PdfZipFile_' . time() . '.zip', 'data' => base64_encode(file_get_contents($zipPath))];- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\JsonContent(type="integer", description="Pdf templates ids"),- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\JsonContent(ref="#/components/schemas/BaseModule_Get_Pdf_Response"),- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* response=403,- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\JsonContent(ref="#/components/schemas/Exception"),- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\XmlContent(ref="#/components/schemas/Exception"),- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\XmlContent(ref="#/components/schemas/Exception"),- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* response=405,- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* title="Base module - Generate PDF response schema",- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* type="object",- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
return $file;- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* summary="Generates and downloads a PDF file from a template",- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Response(- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\JsonContent(ref="#/components/schemas/BaseModule_Get_Pdf_Response"),- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Response(- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* response=405,- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* ),- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* title="Pdf",- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
*/- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Response(- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* description="No permissions to view record",- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\JsonContent(ref="#/components/schemas/Exception"),- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\XmlContent(ref="#/components/schemas/Exception"),- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
$recordId = $this->controller->request->getInteger('record');- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
if (!$template || !$template->isVisible('Detail') || !$template->checkFiltersForRecord($recordId) || !$template->checkUserPermissions()) {- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
$increment[$fileName] = $increment[$fileName] ?? 0;- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
unlink($zipPath);- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Response(- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* description="No permissions to view record",- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* ),- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Property(property="name", type="string", example="order.pdf"),- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
$zip = \App\Zip::createFile($zipPath);- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
foreach ($pdfFiles as $pdfFile) {- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\XmlContent(ref="#/components/schemas/BaseModule_Get_Pdf_Response"),- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* property="result",- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* type="object",- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\AdditionalProperties(- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
continue;- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
}- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
unlink($pdfFile['path']);- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* description="No permissions for action ExportPdf in {moduleName} module",- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
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"),- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* type="object",- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* ),- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
$filePath = $template->getPath();- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* description="Generate PDF",- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\JsonContent(ref="#/components/schemas/Exception"),- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* ),- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\JsonContent(ref="#/components/schemas/Exception"),- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\XmlContent(ref="#/components/schemas/Exception"),- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\XmlContent(ref="#/components/schemas/Exception"),- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Property(- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Property(property="data", type="string", format="binary"),- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Property(property="data", type="string", format="binary"),- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* ),- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
$pdfFiles[] = ['path' => $filePath, 'name' => $fileName];- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* response=404,- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* description="No record id",- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* ),- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
$pdf->output($filePath, 'F');- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
} elseif ($pdfFiles) {- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Response(- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\JsonContent(ref="#/components/schemas/Exception"),- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* title="Base module - Generate PDF response schema",- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Property(- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* property="result",- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* ),- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* ),- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
$fileName = ($pdf->getFileName() ?: time());- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
foreach ($pdfFiles as $file) {- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
$file = ['name' => $file['name'], 'data' => base64_encode(file_get_contents($file['path']))];- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Response(- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* description="No permissions for action ExportPdf in {moduleName} module",- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* type="object",- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* ),- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
$file = $pdfFiles = $increment = [];- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
foreach ($this->controller->request->getArray('templates', 'Integer') as $templateId) {- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
}- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Schema(- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* schema="BaseModule_Get_Pdf_Response",- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\AdditionalProperties(- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
$file = current($pdfFiles);- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* description="No record id",- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* ),- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\JsonContent(ref="#/components/schemas/Exception"),- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* type="object",- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* type="object",- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
public function get(): array- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
$template->setVariable('recordId', $recordId);- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
}- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
}- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\XmlContent(ref="#/components/schemas/BaseModule_Get_Pdf_Response"),- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* title="Pdf detail",- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
$fileName .= ($increment[$fileName]++ > 0 ? '_' . $increment[$fileName] : '') . '.pdf';- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* ),- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Response(- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* response=404,- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Response(- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* schema="BaseModule_Get_Pdf_Response",- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
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"),- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
$template = $pdf->getTemplate();- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
$zip->addFile($file['path'], $file['name']);- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
}- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* description="Generate PDF",- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* ),- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* ),- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* title="Pdf",- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* title="Pdf detail",- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* ),- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
$pdfFiles[] = ['path' => $filePath, 'name' => $fileName];- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
if (\count($pdfFiles) > 1) {- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
$zip->close();- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
/** {@inheritdoc} */- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
* Get method - Generates and downloads a PDF file from a template.- Exclude checks
Line exceeds 120 characters; contains 135 characters Open
Open
* @OA\Parameter(name="recordId", in="path", @OA\Schema(type="integer"), description="Record id", required=true, example=116),- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
$moduleName = $this->controller->request->getModule();- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
if (!$recordModel->isViewable()) {- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
}- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
* @OA\Get(- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
* path="/webservice/WebservicePremium/{moduleName}/Pdf/{recordId}",- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
$recordModel = \Vtiger_Record_Model::getInstanceById($this->controller->request->getInteger('record'), $moduleName);- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
* @return array- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
if ($this->controller->request->isEmpty('record')) {- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
*- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
*- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
protected function checkPermission(): void- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
if (!\Api\WebservicePremium\Privilege::isPermitted($moduleName, 'ExportPdf')) {- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
}- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
/** {@inheritdoc} */- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
{- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
throw new \Api\Core\Exception('No record id', 404);- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
parent::checkPermission();- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
throw new \Api\Core\Exception('Record doesn\'t exist', 404);- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
throw new \Api\Core\Exception("No permissions for action ExportPdf in {$moduleName} module", 405);- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
public $allowedMethod = ['GET'];- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
}- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
/**- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
}- Exclude checks
Line exceeds 120 characters; contains 145 characters Open
Open
* @OA\Parameter(name="moduleName", in="path", @OA\Schema(type="string"), description="Module name", required=true, example="Accounts"),- Exclude checks
Line exceeds 120 characters; contains 131 characters Open
Open
* @OA\Parameter(name="X-ENCRYPTED", in="header", @OA\Schema(ref="#/components/schemas/Header-Encrypted"), required=true),- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
}- Exclude checks
Line exceeds 120 characters; contains 124 characters Open
Open
$recordModel = \Vtiger_Record_Model::getInstanceById($this->controller->request->getInteger('record'), $moduleName);- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
if (!\App\Record::isExists($this->controller->request->getInteger('record'), $moduleName)) {- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
throw new \Api\Core\Exception('No permissions to view record', 403);- Exclude checks
Line exceeds 120 characters; contains 150 characters Open
Open
if (!$template || !$template->isVisible('Detail') || !$template->checkFiltersForRecord($recordId) || !$template->checkUserPermissions()) {- Exclude checks
Line exceeds 120 characters; contains 189 characters Open
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"),- Exclude checks