DMSDocumentSet::getCMSFields() - Code Metrics - Inspection of "Added Query Builder functionality to Document Sets" - silverstripe/silverstripe-dms - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#119)

by Franco

created 2017-05-10 10:21 UTC

DMSDocumentSet::getCMSFields() B

↳ Parent: DMSDocumentSet

Complexity

Conditions	5
Paths	1

Size

Total Lines	87
Code Lines	58

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	87
rs	8.3103
c	0
b	0
f	0
cc	5
eloc	58
nc	1
nop	0

How to fix Long Method

<?php
/**
 * A document set is attached to Pages, and contains many DMSDocuments
 *
 * @property Varchar Title
 * @property  Text KeyValuePairs
 * @property  Enum SortBy
 * @property Enum SortByDirection
 */
class DMSDocumentSet extends DataObject
namespace YourVendor;

class YourClass { }
{

    private static $db = array(

        'Title' => 'Varchar(255)',
        'KeyValuePairs' => 'Text',
        'SortBy' => "Enum('LastEdited,Created,Title')')",
        'SortByDirection' => "Enum('DESC,ASC')')",
    );

    private static $has_one = array(

        'Page' => 'SiteTree',
    );

    private static $many_many = array(

        'Documents' => 'DMSDocument',
    );

    private static $many_many_extraFields = array(

        'Documents' => array(
            'BelongsToSet' => 'Boolean(1)',// Whether or not this is a set or a Query Builder document
        ),
    );

    /**
     * Retrieve a list of the documents in this set. An extension hook is provided before the result is returned.
     *
     * You can attach an extension to this event:
     *
     * <code>
     * public function updateDocuments($document)
     * {
     *     // do something
     * }
     * </code>
     *
     * @return DataList|null
     */
    public function getDocuments()
    {
        $documents = $this->Documents();

        $this->extend('updateDocuments', $documents);
        return $documents;
    }

    /**
     * Put the "documents" list into the main tab instead of its own tab, and replace the default "Add Document" button
     * with a customised button for DMS documents
     *
     * @return FieldList
     */
    public function getCMSFields()
    {
        // PHP 5.3 only
        $self = $this;
        $this->beforeUpdateCMSFields(function (FieldList $fields) use ($self) {
            // Don't put the GridField for documents in until the set has been created
            if (!$self->isInDB()) {
                $fields->addFieldToTab(
                    'Root.Main',
                    LiteralField::create(
                        'GridFieldNotice',
                        '<p class="message warning">' . _t(
                            'DMSDocumentSet.GRIDFIELD_NOTICE',
                            'Managing documents will be available once you have created this document set.'
                        ) . '</p>'
                    ),
                    'Title'
                );
                return;
            }

            // Document listing
            $gridFieldConfig = GridFieldConfig::create()
                ->addComponents(
                    new GridFieldToolbarHeader(),
                    new GridFieldFilterHeader(),
                    new GridFieldSortableHeader(),
                    // new GridFieldOrderableRows('DocumentSort'),

                    new GridFieldDataColumns(),
                    new GridFieldEditButton(),
                    // Special delete dialog to handle custom behaviour of unlinking and deleting
                    new DMSGridFieldDeleteAction(),
                    new GridFieldDetailForm()
                );

            if (class_exists('GridFieldPaginatorWithShowAll')) {
                $paginatorComponent = new GridFieldPaginatorWithShowAll(15);
            } else {
                $paginatorComponent = new GridFieldPaginator(15);
            }
            $gridFieldConfig->addComponent($paginatorComponent);

            if (class_exists('GridFieldSortableRows')) {
                $sortableComponent = new GridFieldSortableRows('DocumentSort');
                // setUsePagenation method removed from newer version of SortableGridField.
                if (method_exists($sortableComponent, 'setUsePagination')) {
                    $sortableComponent->setUsePagination(false)->setForceRedraw(true);
                }
                $gridFieldConfig->addComponent($sortableComponent);
            }

            // HACK: Create a singleton of DMSDocument to ensure extensions are applied before we try to get display fields.
            singleton('DMSDocument');
            $gridFieldConfig->getComponentByType('GridFieldDataColumns')
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
                ->setDisplayFields(Config::inst()->get('DMSDocument', 'display_fields'))
                ->setFieldCasting(array('LastEdited' => 'Datetime->Ago'))
                ->setFieldFormatting(
                    array(
                        'FilenameWithoutID' => '<a target=\'_blank\' class=\'file-url\' href=\'$Link\'>$FilenameWithoutID</a>',
                    )
                );

            // Override delete functionality with this class
            $gridFieldConfig->getComponentByType('GridFieldDetailForm')
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
                ->setItemRequestClass('DMSGridFieldDetailForm_ItemRequest');
            $gridField = GridField::create(
                'Documents',
                false,
                $self->Documents(),

                $gridFieldConfig
            );
            $gridField->setModelClass('DMSDocument');
            $gridField->addExtraClass('documents');

            $gridFieldConfig->addComponent(
                $addNewButton = new DMSGridFieldAddNewButton,
                'GridFieldExportButton'
            );
            $addNewButton->setDocumentSetId($self->ID);

            $fields->removeByName('Documents');
            $fields->addFieldToTab('Root.Main', $gridField);
            $self->addQueryFields($fields);
        });
        $this->addRequirements();
        return parent::getCMSFields();
    }

    /**
     * Add required CSS and Javascript requirements for managing documents
     *
     * @return $this
     */
    protected function addRequirements()
    {
        // Javascript to customize the grid field for the DMS document (overriding entwine
        // in FRAMEWORK_DIR.'/javascript/GridField.js'
        Requirements::javascript(DMS_DIR . '/javascript/DMSGridField.js');
        Requirements::css(DMS_DIR . '/dist/css/dmsbundle.css');

        // Javascript for the link editor pop-up in TinyMCE
        Requirements::javascript(DMS_DIR . '/javascript/DocumentHtmlEditorFieldToolbar.js');

        return $this;
    }

    /**
     * Adds the query fields to build the document logic to the DMSDocumentSet.
     *
     * To extend use the following from within an Extension subclass:
     *
     * <code>
     * public function updateQueryFields($result)
     * {
     *     // Do something here
     * }
     * </code>
     *
     * @param FieldList $fields
     */
    public function addQueryFields($fields)
    {
        /** @var DMSDocument $doc */
        $doc = singleton('DMSDocument');
        $fields->removeByName(array('SortByDirection', 'SortBy'));
        /** @var FormField $field */
        $dmsDocFields = $doc->scaffoldSearchFields(array('fieldClasses' => true));
        $membersMap = Member::get()->map('ID', 'Name')->toArray();
        asort($membersMap);
        foreach ($dmsDocFields as $field) {
            // Apply field customisations where necessary
            if (in_array($field->getName(), array('CreatedByID', 'LastEditedByID', 'LastEditedByID'))) {
                /** @var ListboxField $field */
                $field->setMultiple(true)->setSource($membersMap);
            }
        }
        $keyValPairs = new JsonField('KeyValuePairs', $dmsDocFields->toArray());

        // Now lastly add the sort fields
        $sortedBy = new FieldGroup('SortedBy', array(
                new DropdownField('SortBy', '', array(
                    'LastEdited'  => 'Last changed',
                    'Created'     => 'Created',
                    'Title'       => 'Document title',
                ), 'LastEdited'),
                new DropdownField('SortByDirection', '', $this->dbObject('SortByDirection')->enumValues(), 'DESC'),
            ));

        $sortedBy->setTitle("Sort the document set by:");
        $fields->addFieldsToTab('Root.QueryBuilder', $keyValPairs);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        $fields->addFieldToTab('Root.QueryBuilder', $sortedBy);
        $this->extend('updateQueryFields', $fields);
    }

    public function onBeforeWrite(){
        parent::onBeforeWrite();

        $this->saveLinkedDocuments();
    }

    /**
     * Retrieve a list of the documents in this set. An extension hook is provided before the result is returned.
     *
     * @return ArrayList|null
     */
    public function saveLinkedDocuments()
    {
        // Documents that belong to just this set.
        /** @var ManyManyList $originals */
        $originals = $this->Documents();

        if (!(empty($this->KeyValuePairs)) && $this->isChanged('KeyValuePairs')) {

            $keyValuesPair = Convert::json2array($this->KeyValuePairs);
            /** @var DMSDocument $dmsDoc */
            $dmsDoc = singleton('DMSDocument');
            $context = $dmsDoc->getDefaultSearchContext();

            $sortBy = $this->SortBy ? $this->SortBy : 'LastEdited';
            $sortByDirection = $this->SortByDirection ? $this->SortByDirection : 'DESC';
            $sortedBy = sprintf('%s %s', $sortBy, $sortByDirection);
            /** @var DataList $documents */
            $documents = $context->getResults($keyValuesPair, $sortedBy);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
            $now = SS_Datetime::now()->Rfc2822();
            $documents = $documents->where(
                "\"EmbargoedIndefinitely\" = 0 AND ".
                " \"EmbargoedUntilPublished\" = 0 AND ".
                "(\"EmbargoedUntilDate\" IS NULL OR " .
                "(\"EmbargoedUntilDate\" IS NOT NULL AND '{$now}' >= \"EmbargoedUntilDate\")) AND " .
                "\"ExpireAtDate\" IS NULL OR (\"ExpireAtDate\" IS NOT NULL AND '{$now}' < \"ExpireAtDate\")");

            // Remove all BelongsToSet as the rules have changed
            $originals->removeByFilter('"BelongsToSet" = 0');
            foreach ($documents as $document) {
                $originals->add($document, array('BelongsToSet' => 0));
            }
        }
    }
}


Pull Request — master (#119)

DMSDocumentSet::getCMSFields() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Available Fixes

Available Fixes

1			<?php
2			/**
3			* A document set is attached to Pages, and contains many DMSDocuments
4			*
5			* @property Varchar Title
6			* @property Text KeyValuePairs
7			* @property Enum SortBy
8			* @property Enum SortByDirection
9			*/
10			class DMSDocumentSet extends DataObject
			0 ignored issues – show Coding Style Compatibility introduced 2017-05-05 01:36 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...
11			{
12
13			private static $db = array(
			0 ignored issues – show Comprehensibility introduced 2017-05-09 22:22 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... Unused Code introduced 2017-05-09 22:22 UTC by Report Bug Copy Issue Report The property `$db` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
14			'Title' => 'Varchar(255)',
15			'KeyValuePairs' => 'Text',
16			'SortBy' => "Enum('LastEdited,Created,Title')')",
17			'SortByDirection' => "Enum('DESC,ASC')')",
18			);
19
20			private static $has_one = array(
			0 ignored issues – show Comprehensibility introduced 2017-05-05 01:36 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... Unused Code introduced 2017-05-05 01:36 UTC by Report Bug Copy Issue Report The property `$has_one` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
21			'Page' => 'SiteTree',
22			);
23
24			private static $many_many = array(
			0 ignored issues – show Comprehensibility introduced 2017-05-05 01:36 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... Unused Code introduced 2017-05-01 04:05 UTC by Report Bug Copy Issue Report The property `$many_many` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
25			'Documents' => 'DMSDocument',
26			);
27
28			private static $many_many_extraFields = 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... Unused Code introduced 2017-05-01 04:05 UTC by Report Bug Copy Issue Report The property `$many_many_extraFields` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
29			'Documents' => array(
30			'BelongsToSet' => 'Boolean(1)',// Whether or not this is a set or a Query Builder document
31			),
32			);
33
34			/**
35			* Retrieve a list of the documents in this set. An extension hook is provided before the result is returned.
36			*
37			* You can attach an extension to this event:
38			*
39			* <code>
40			* public function updateDocuments($document)
41			* {
42			* // do something
43			* }
44			* </code>
45			*
46			* @return DataList\|null
47			*/
48			public function getDocuments()
49			{
50			$documents = $this->Documents();
			0 ignored issues – show Bug introduced 2017-05-05 01:36 UTC by Report Bug Copy Issue Report The method `Documents()` does not exist on `DMSDocumentSet`. Did you maybe mean `getDocuments()`? 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...
51			$this->extend('updateDocuments', $documents);
52			return $documents;
53			}
54
55			/**
56			* Put the "documents" list into the main tab instead of its own tab, and replace the default "Add Document" button
57			* with a customised button for DMS documents
58			*
59			* @return FieldList
60			*/
61			public function getCMSFields()
62			{
63			// PHP 5.3 only
64			$self = $this;
65			$this->beforeUpdateCMSFields(function (FieldList $fields) use ($self) {
66			// Don't put the GridField for documents in until the set has been created
67			if (!$self->isInDB()) {
68			$fields->addFieldToTab(
69			'Root.Main',
70			LiteralField::create(
71			'GridFieldNotice',
72			'<p class="message warning">' . _t(
73			'DMSDocumentSet.GRIDFIELD_NOTICE',
74			'Managing documents will be available once you have created this document set.'
75			) . '</p>'
76			),
77			'Title'
78			);
79			return;
80			}
81
82			// Document listing
83			$gridFieldConfig = GridFieldConfig::create()
84			->addComponents(
85			new GridFieldToolbarHeader(),
86			new GridFieldFilterHeader(),
87			new GridFieldSortableHeader(),
88			// new GridFieldOrderableRows('DocumentSort'),
			0 ignored issues – show Unused Code Comprehensibility introduced 2017-05-05 01:36 UTC by Report Bug Copy Issue Report `63%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
89			new GridFieldDataColumns(),
90			new GridFieldEditButton(),
91			// Special delete dialog to handle custom behaviour of unlinking and deleting
92			new DMSGridFieldDeleteAction(),
93			new GridFieldDetailForm()
94			);
95
96			if (class_exists('GridFieldPaginatorWithShowAll')) {
97			$paginatorComponent = new GridFieldPaginatorWithShowAll(15);
98			} else {
99			$paginatorComponent = new GridFieldPaginator(15);
100			}
101			$gridFieldConfig->addComponent($paginatorComponent);
102
103			if (class_exists('GridFieldSortableRows')) {
104			$sortableComponent = new GridFieldSortableRows('DocumentSort');
105			// setUsePagenation method removed from newer version of SortableGridField.
106			if (method_exists($sortableComponent, 'setUsePagination')) {
107			$sortableComponent->setUsePagination(false)->setForceRedraw(true);
108			}
109			$gridFieldConfig->addComponent($sortableComponent);
110			}
111
112			// HACK: Create a singleton of DMSDocument to ensure extensions are applied before we try to get display fields.
113			singleton('DMSDocument');
114			$gridFieldConfig->getComponentByType('GridFieldDataColumns')
			0 ignored issues – show Bug introduced 2017-05-01 04:05 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `GridFieldComponent` as the method `setDisplayFields()` does only exist in the following implementations of said interface: `GridFieldDataColumns`, `GridFieldEditableColumns`, `GridFieldExternalLink`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
115			->setDisplayFields(Config::inst()->get('DMSDocument', 'display_fields'))
116			->setFieldCasting(array('LastEdited' => 'Datetime->Ago'))
117			->setFieldFormatting(
118			array(
119			'FilenameWithoutID' => '<a target=\'_blank\' class=\'file-url\' href=\'$Link\'>$FilenameWithoutID</a>',
120			)
121			);
122
123			// Override delete functionality with this class
124			$gridFieldConfig->getComponentByType('GridFieldDetailForm')
			0 ignored issues – show Bug introduced 2017-05-01 21:16 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `GridFieldComponent` as the method `setItemRequestClass()` does only exist in the following implementations of said interface: `GridFieldAddNewMultiClass`, `GridFieldDetailForm`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
125			->setItemRequestClass('DMSGridFieldDetailForm_ItemRequest');
126			$gridField = GridField::create(
127			'Documents',
128			false,
129			$self->Documents(),
			0 ignored issues – show Bug introduced 2017-05-09 13:40 UTC by Report Bug Copy Issue Report The method `Documents()` does not exist on `DMSDocumentSet`. Did you maybe mean `getDocuments()`? 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...
130			$gridFieldConfig
131			);
132			$gridField->setModelClass('DMSDocument');
133			$gridField->addExtraClass('documents');
134
135			$gridFieldConfig->addComponent(
136			$addNewButton = new DMSGridFieldAddNewButton,
137			'GridFieldExportButton'
138			);
139			$addNewButton->setDocumentSetId($self->ID);
140
141			$fields->removeByName('Documents');
142			$fields->addFieldToTab('Root.Main', $gridField);
143			$self->addQueryFields($fields);
144			});
145			$this->addRequirements();
146			return parent::getCMSFields();
147			}
148
149			/**
150			* Add required CSS and Javascript requirements for managing documents
151			*
152			* @return $this
153			*/
154			protected function addRequirements()
155			{
156			// Javascript to customize the grid field for the DMS document (overriding entwine
157			// in FRAMEWORK_DIR.'/javascript/GridField.js'
158			Requirements::javascript(DMS_DIR . '/javascript/DMSGridField.js');
159			Requirements::css(DMS_DIR . '/dist/css/dmsbundle.css');
160
161			// Javascript for the link editor pop-up in TinyMCE
162			Requirements::javascript(DMS_DIR . '/javascript/DocumentHtmlEditorFieldToolbar.js');
163
164			return $this;
165			}
166
167			/**
168			* Adds the query fields to build the document logic to the DMSDocumentSet.
169			*
170			* To extend use the following from within an Extension subclass:
171			*
172			* <code>
173			* public function updateQueryFields($result)
174			* {
175			* // Do something here
176			* }
177			* </code>
178			*
179			* @param FieldList $fields
180			*/
181			public function addQueryFields($fields)
182			{
183			/** @var DMSDocument $doc */
184			$doc = singleton('DMSDocument');
185			$fields->removeByName(array('SortByDirection', 'SortBy'));
186			/** @var FormField $field */
187			$dmsDocFields = $doc->scaffoldSearchFields(array('fieldClasses' => true));
188			$membersMap = Member::get()->map('ID', 'Name')->toArray();
189			asort($membersMap);
190			foreach ($dmsDocFields as $field) {
191			// Apply field customisations where necessary
192			if (in_array($field->getName(), array('CreatedByID', 'LastEditedByID', 'LastEditedByID'))) {
193			/** @var ListboxField $field */
194			$field->setMultiple(true)->setSource($membersMap);
195			}
196			}
197			$keyValPairs = new JsonField('KeyValuePairs', $dmsDocFields->toArray());
198
199			// Now lastly add the sort fields
200			$sortedBy = new FieldGroup('SortedBy', array(
201			new DropdownField('SortBy', '', array(
202			'LastEdited' => 'Last changed',
203			'Created' => 'Created',
204			'Title' => 'Document title',
205			), 'LastEdited'),
206			new DropdownField('SortByDirection', '', $this->dbObject('SortByDirection')->enumValues(), 'DESC'),
207			));
208
209			$sortedBy->setTitle("Sort the document set by:");
210			$fields->addFieldsToTab('Root.QueryBuilder', $keyValPairs);
			0 ignored issues – show Documentation introduced 2017-05-09 13:40 UTC by Report Bug Copy Issue Report `$keyValPairs` is of type `object<JsonField>`, but the function expects a `array`. 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...
211			$fields->addFieldToTab('Root.QueryBuilder', $sortedBy);
212			$this->extend('updateQueryFields', $fields);
213			}
214
215			public function onBeforeWrite(){
216			parent::onBeforeWrite();
217
218			$this->saveLinkedDocuments();
219			}
220
221			/**
222			* Retrieve a list of the documents in this set. An extension hook is provided before the result is returned.
223			*
224			* @return ArrayList\|null
225			*/
226			public function saveLinkedDocuments()
227			{
228			// Documents that belong to just this set.
229			/** @var ManyManyList $originals */
230			$originals = $this->Documents();
			0 ignored issues – show Bug introduced 2017-05-09 13:40 UTC by Report Bug Copy Issue Report The method `Documents()` does not exist on `DMSDocumentSet`. Did you maybe mean `getDocuments()`? 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...
231			if (!(empty($this->KeyValuePairs)) && $this->isChanged('KeyValuePairs')) {
232
233			$keyValuesPair = Convert::json2array($this->KeyValuePairs);
234			/** @var DMSDocument $dmsDoc */
235			$dmsDoc = singleton('DMSDocument');
236			$context = $dmsDoc->getDefaultSearchContext();
237
238			$sortBy = $this->SortBy ? $this->SortBy : 'LastEdited';
239			$sortByDirection = $this->SortByDirection ? $this->SortByDirection : 'DESC';
240			$sortedBy = sprintf('%s %s', $sortBy, $sortByDirection);
241			/** @var DataList $documents */
242			$documents = $context->getResults($keyValuesPair, $sortedBy);
			0 ignored issues – show Bug introduced 2017-05-09 13:40 UTC by Report Bug Copy Issue Report It seems like `$keyValuesPair` defined by `\Convert::json2array($this->KeyValuePairs)` on line `233` can also be of type `boolean`; however, `SearchContext::getResults()` does only seem to accept `array`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
243			$now = SS_Datetime::now()->Rfc2822();
244			$documents = $documents->where(
245			"\"EmbargoedIndefinitely\" = 0 AND ".
246			" \"EmbargoedUntilPublished\" = 0 AND ".
247			"(\"EmbargoedUntilDate\" IS NULL OR " .
248			"(\"EmbargoedUntilDate\" IS NOT NULL AND '{$now}' >= \"EmbargoedUntilDate\")) AND " .
249			"\"ExpireAtDate\" IS NULL OR (\"ExpireAtDate\" IS NOT NULL AND '{$now}' < \"ExpireAtDate\")");
250
251			// Remove all BelongsToSet as the rules have changed
252			$originals->removeByFilter('"BelongsToSet" = 0');
253			foreach ($documents as $document) {
254			$originals->add($document, array('BelongsToSet' => 0));
255			}
256			}
257			}
258			}
259

silverstripe / silverstripe-dms

Pull Request — master (#119)

DMSDocumentSet::getCMSFields() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like