DMSGridFieldAddNewButton::getHTMLFragments() - Code Metrics - Inspection of "Merge pull request #111 from sachajudd/feature/mod..." - silverstripe/silverstripe-dms - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 1f0706...385015 )

by Franco

created 2017-05-04 01:27 UTC

DMSGridFieldAddNewButton::getHTMLFragments() B

↳ Parent: DMSGridFieldAddNewButton

Complexity

Conditions	4
Paths	5

Size

Total Lines	28
Code Lines	15

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	28
rs	8.5806
c	0
b	0
f	0
cc	4
eloc	15
nc	5
nop	1

<?php

class DMSGridFieldAddNewButton extends GridFieldAddNewButton implements GridField_HTMLProvider
namespace YourVendor;

class YourClass { }
{
    /**
     * The page ID that the document should be attached to. Used in the GridField for Documents in a Page.
     *
     * @var int
     */
    protected $pageId;

    /**
     * Overriding the parent method to change the template that the DMS add button will be rendered with
     *
     * @param  GridField $gridField
     * @return array
     */
    public function getHTMLFragments($gridField)
    {
        $singleton = singleton($gridField->getModelClass());

        if (!$singleton->canCreate()) {
            return array();
        }

        if (!$this->buttonName) {
            // provide a default button name, can be changed by calling {@link setButtonName()} on this component
            $objectName = $singleton->i18n_singular_name();
            $this->buttonName = _t('GridField.Add', 'Add {name}', array('name' => $objectName));
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        }

        $link = singleton('DMSDocumentAddController')->Link();
        if ($this->getPageId()) {
            $link = Controller::join_links($link, '?ID=' . $this->getPageId());
        }

        $data = new ArrayData(array(
            'NewLink' => $link,
            'ButtonName' => $this->buttonName,
        ));

        return array(
            $this->targetFragment => $data->renderWith('DMSGridFieldAddNewButton'),
        );
    }

    /**
     * Set the page ID that this document should be attached to
     *
     * @param  int $id
     * @return $this
     */
    public function setPageId($id)
    {
        $this->pageId = $id;
        return $this;
    }

    /**
     * Get the page ID that this document should be attached to
     *
     * @return int
     */
    public function getPageId()
    {
        return $this->pageId;
    }
}


1			<?php
2
3			class DMSGridFieldAddNewButton extends GridFieldAddNewButton implements GridField_HTMLProvider
			0 ignored issues – show Coding Style Compatibility introduced 2017-05-03 21:42 UTC by Report Bug Copy Issue Report PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions. You can fix this by adding a namespace to your class: namespace YourVendor; class YourClass { } When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries. Loading history...
4			{
5			/**
6			* The page ID that the document should be attached to. Used in the GridField for Documents in a Page.
7			*
8			* @var int
9			*/
10			protected $pageId;
11
12			/**
13			* Overriding the parent method to change the template that the DMS add button will be rendered with
14			*
15			* @param GridField $gridField
16			* @return array
17			*/
18			public function getHTMLFragments($gridField)
19			{
20			$singleton = singleton($gridField->getModelClass());
21
22			if (!$singleton->canCreate()) {
23			return array();
24			}
25
26			if (!$this->buttonName) {
27			// provide a default button name, can be changed by calling {@link setButtonName()} on this component
28			$objectName = $singleton->i18n_singular_name();
29			$this->buttonName = _t('GridField.Add', 'Add {name}', array('name' => $objectName));
			0 ignored issues – show Documentation introduced 2017-05-03 21:42 UTC by Report Bug Copy Issue Report `array('name' => $objectName)` is of type `array<string,?,{"name":"?"}>`, but the function expects a `string`. 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...
30			}
31
32			$link = singleton('DMSDocumentAddController')->Link();
33			if ($this->getPageId()) {
34			$link = Controller::join_links($link, '?ID=' . $this->getPageId());
35			}
36
37			$data = new ArrayData(array(
38			'NewLink' => $link,
39			'ButtonName' => $this->buttonName,
40			));
41
42			return array(
43			$this->targetFragment => $data->renderWith('DMSGridFieldAddNewButton'),
44			);
45			}
46
47			/**
48			* Set the page ID that this document should be attached to
49			*
50			* @param int $id
51			* @return $this
52			*/
53			public function setPageId($id)
54			{
55			$this->pageId = $id;
56			return $this;
57			}
58
59			/**
60			* Get the page ID that this document should be attached to
61			*
62			* @return int
63			*/
64			public function getPageId()
65			{
66			return $this->pageId;
67			}
68			}
69

silverstripe / silverstripe-dms

Push — master ( 1f0706...385015 )

DMSGridFieldAddNewButton::getHTMLFragments() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like