DMSUploadField_ItemHandler::getItem() - Code Metrics - silverstripe/silverstripe-dms - Measure and Improve Code Quality continuously with Scrutinizer

DMSUploadField_ItemHandler::getItem() A
last analyzed 2021-03-31 04:32 UTC

↳ Parent: DMSUploadField_ItemHandler

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	0

<?php

class DMSUploadField_ItemHandler extends UploadField_ItemHandler
{
    private static $allowed_actions = array(

        'delete',
        'edit',
        'EditForm',
    );

    /**
     * Gets a DMS document by its ID
     *
     * @return DMSDocument

     */
    public function getItem()
    {
        return DMSDocument::get()->byId($this->itemID);
    }

    /**
     * @return Form
     */
    public function EditForm()
    {
        $file = $this->getItem();

        // Get form components
        $fields = $this->parent->getDMSFileEditFields($file);

        $actions = $this->parent->getDMSFileEditActions($file);

        $validator = $this->parent->getDMSFileEditValidator($file);

        $form = new Form(
            $this,
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            __FUNCTION__,
            $fields,
            $actions,
            $validator
        );
        $form->loadDataFrom($file);
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}

        return $form;
    }
}


1			<?php
2
3			class DMSUploadField_ItemHandler extends UploadField_ItemHandler
4			{
5			private static $allowed_actions = array(
			0 ignored issues – show Comprehensibility introduced 2017-05-01 04:05 UTC by Report Bug Copy Issue Report Consider using a different property name as you override a private property of the parent class. Loading history...
6			'delete',
7			'edit',
8			'EditForm',
9			);
10
11			/**
12			* Gets a DMS document by its ID
13			*
14			* @return DMSDocument
			0 ignored issues – show Documentation introduced 2017-05-05 01:36 UTC by Report Bug Copy Issue Report Should the return type not be `DMSDocument\|null`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
15			*/
16			public function getItem()
17			{
18			return DMSDocument::get()->byId($this->itemID);
19			}
20
21			/**
22			* @return Form
23			*/
24			public function EditForm()
25			{
26			$file = $this->getItem();
27
28			// Get form components
29			$fields = $this->parent->getDMSFileEditFields($file);
			0 ignored issues – show Bug introduced 2017-05-01 04:05 UTC by Report Bug Copy Issue Report The method `getDMSFileEditFields()` does not exist on `UploadField`. Did you maybe mean `getFileEditFields()`? This check marks calls to methods that do not seem to exist on an object. This is most likely the result of a method being renamed without all references to it being renamed likewise. Loading history...
30			$actions = $this->parent->getDMSFileEditActions($file);
			0 ignored issues – show Bug introduced 2017-05-01 04:05 UTC by Report Bug Copy Issue Report The method `getDMSFileEditActions()` does not exist on `UploadField`. Did you maybe mean `getFileEditActions()`? This check marks calls to methods that do not seem to exist on an object. This is most likely the result of a method being renamed without all references to it being renamed likewise. Loading history...
31			$validator = $this->parent->getDMSFileEditValidator($file);
			0 ignored issues – show Bug introduced 2017-05-01 04:05 UTC by Report Bug Copy Issue Report The method `getDMSFileEditValidator()` does not exist on `UploadField`. Did you maybe mean `getFileEditValidator()`? This check marks calls to methods that do not seem to exist on an object. This is most likely the result of a method being renamed without all references to it being renamed likewise. Loading history...
32			$form = new Form(
33			$this,
			0 ignored issues – show Documentation introduced 2017-05-01 04:05 UTC by Report Bug Copy Issue Report `$this` is of type `this<DMSUploadField_ItemHandler>`, but the function expects a `object<Controller>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
34			__FUNCTION__,
35			$fields,
36			$actions,
37			$validator
38			);
39			$form->loadDataFrom($file);
			0 ignored issues – show Bug introduced 2017-05-22 02:20 UTC by Report Bug Copy Issue Report It seems like `$file` defined by `$this->getItem()` on line `26` can be `null`; however, `Form::loadDataFrom()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
40
41			return $form;
42			}
43			}
44

silverstripe / silverstripe-dms

DMSUploadField_ItemHandler::getItem() A last analyzed 2021-03-31 04:32 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

DMSUploadField_ItemHandler::getItem() A
last analyzed 2021-03-31 04:32 UTC