DMSGridFieldAddNewButton::getHTMLFragments() - Code Metrics - Inspection of "Merge pull request #182 from creative-commoners/pu..." - silverstripe/silverstripe-dms - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( b4e5c2...6db701 )

by Daniel

created 2017-06-20 14:19 UTC

DMSGridFieldAddNewButton::getHTMLFragments() C

↳ Parent: DMSGridFieldAddNewButton

Complexity

Conditions	8
Paths	7

Size

Total Lines	36
Code Lines	19

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	36
rs	5.3846
c	0
b	0
f	0
cc	8
eloc	19
nc	7
nop	1

<?php

class DMSGridFieldAddNewButton extends GridFieldAddNewButton implements GridField_HTMLProvider
namespace YourVendor;

class YourClass { }
{
    /**
     * The document set ID that the document should be attached to
     *
     * @var int
     */
    protected $documentSetId;

    /**
     * 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->getDocumentSetId()) {
            $link = Controller::join_links($link, '?dsid=' . $this->getDocumentSetId());

            // Look for an associated page, but only share it if we're editing in a page context
            $set = DMSDocumentSet::get()->byId($this->getDocumentSetId());
            if ($set && $set->exists() && $set->Page()->exists()
                && Controller::curr() instanceof CMSPageEditController
            ) {
                $link = Controller::join_links($link, '?page_id=' . $set->Page()->ID);
            }
        }

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

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

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

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


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 document set ID that the document should be attached to
7			*
8			* @var int
9			*/
10			protected $documentSetId;
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->getDocumentSetId()) {
34			$link = Controller::join_links($link, '?dsid=' . $this->getDocumentSetId());
35
36			// Look for an associated page, but only share it if we're editing in a page context
37			$set = DMSDocumentSet::get()->byId($this->getDocumentSetId());
38			if ($set && $set->exists() && $set->Page()->exists()
39			&& Controller::curr() instanceof CMSPageEditController
40			) {
41			$link = Controller::join_links($link, '?page_id=' . $set->Page()->ID);
42			}
43			}
44
45			$data = new ArrayData(array(
46			'NewLink' => $link,
47			'ButtonName' => $this->buttonName,
48			));
49
50			return array(
51			$this->targetFragment => $data->renderWith('DMSGridFieldAddNewButton'),
52			);
53			}
54
55			/**
56			* Set the document set ID that this document should be attached to
57			*
58			* @param int $id
59			* @return $this
60			*/
61			public function setDocumentSetId($id)
62			{
63			$this->documentSetId = $id;
64			return $this;
65			}
66
67			/**
68			* Get the document set ID that this document should be attached to
69			*
70			* @return int
71			*/
72			public function getDocumentSetId()
73			{
74			return $this->documentSetId;
75			}
76			}
77

silverstripe / silverstripe-dms

Push — master ( b4e5c2...6db701 )

DMSGridFieldAddNewButton::getHTMLFragments() C

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like