Completed
Pull Request — master (#168)
by Franco
02:23
created

DMSDocumentSet   D

Complexity

Total Complexity 38

Size/Duplication

Total Lines 401
Duplicated Lines 8.73 %

Coupling/Cohesion

Components 3
Dependencies 33

Importance

Changes 0
Metric Value
wmc 38
lcom 3
cbo 33
dl 35
loc 401
rs 4.1999
c 0
b 0
f 0

15 Methods

Rating   Name   Duplication   Size   Complexity  
A getDocuments() 0 6 1
B getCMSFields() 0 104 6
A addRequirements() 0 12 1
B addQueryFields() 0 62 5
A onBeforeWrite() 0 6 1
B saveLinkedDocuments() 0 21 5
A addEmbargoConditions() 0 12 1
A addQueryBuilderSearchResults() 0 12 2
A getDocumentDisplayFields() 0 7 1
A validate() 0 9 2
A canView() 8 8 2
A canCreate() 8 8 2
A canEdit() 8 8 2
A canDelete() 8 8 2
B getDMSDocumentSetPermissions() 3 15 5

How to fix   Duplicated Code   

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

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 by Robbie Averill
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
    private static $db = array(
0 ignored issues
show
Comprehensibility introduced by Robbie Averill
Consider using a different property name as you override a private property of the parent class.
Loading history...
Unused Code introduced by Robbie Averill
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...
13
        'Title' => 'Varchar(255)',
14
        'KeyValuePairs' => 'Text',
15
        'SortBy' => "Enum('LastEdited,Created,Title')')",
16
        'SortByDirection' => "Enum('DESC,ASC')')",
17
    );
18
19
    private static $has_one = array(
0 ignored issues
show
Comprehensibility introduced by Robbie Averill
Consider using a different property name as you override a private property of the parent class.
Loading history...
Unused Code introduced by Robbie Averill
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...
20
        'Page' => 'SiteTree',
21
    );
22
23
    private static $many_many = array(
0 ignored issues
show
Comprehensibility introduced by Robbie Averill
Consider using a different property name as you override a private property of the parent class.
Loading history...
Unused Code introduced by helpfulrobot
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...
24
        'Documents' => 'DMSDocument',
25
    );
26
27
    private static $many_many_extraFields = array(
0 ignored issues
show
Comprehensibility introduced by helpfulrobot
Consider using a different property name as you override a private property of the parent class.
Loading history...
Unused Code introduced by helpfulrobot
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...
28
        'Documents' => array(
29
            // Flag indicating if a document was added directly to a set - in which case it is set - or added
30
            // via the query-builder.
31
            'ManuallyAdded' => 'Boolean(1)',
32
            'DocumentSort' => 'Int'
33
        ),
34
    );
35
36
    private static $summary_fields = array(
0 ignored issues
show
Comprehensibility introduced by helpfulrobot
Consider using a different property name as you override a private property of the parent class.
Loading history...
Unused Code introduced by Sacha Judd
The property $summary_fields 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...
37
        'Title' => 'Title',
38
        'Documents.Count' => 'No. Documents'
39
    );
40
41
    /**
42
     * Retrieve a list of the documents in this set. An extension hook is provided before the result is returned.
43
     *
44
     * You can attach an extension to this event:
45
     *
46
     * <code>
47
     * public function updateDocuments($document)
48
     * {
49
     *     // do something
50
     * }
51
     * </code>
52
     *
53
     * @return DataList|null
54
     */
55
    public function getDocuments()
56
    {
57
        $documents = $this->Documents();
0 ignored issues
show
Bug introduced by Robbie Averill
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...
58
        $this->extend('updateDocuments', $documents);
59
        return $documents;
60
    }
61
62
    /**
63
     * Put the "documents" list into the main tab instead of its own tab, and replace the default "Add Document" button
64
     * with a customised button for DMS documents
65
     *
66
     * @return FieldList
67
     */
68
    public function getCMSFields()
69
    {
70
        // PHP 5.3 only
71
        $self = $this;
72
        $this->beforeUpdateCMSFields(function (FieldList $fields) use ($self) {
73
            $fields->removeFieldsFromTab(
74
                'Root.Main',
75
                array('KeyValuePairs', 'SortBy', 'SortByDirection')
76
            );
77
            // Don't put the GridField for documents in until the set has been created
78
            if (!$self->isInDB()) {
79
                $fields->addFieldToTab(
80
                    'Root.Main',
81
                    LiteralField::create(
82
                        'GridFieldNotice',
83
                        '<p class="message warning">' . _t(
84
                            'DMSDocumentSet.GRIDFIELD_NOTICE',
85
                            'Managing documents will be available once you have created this document set.'
86
                        ) . '</p>'
87
                    ),
88
                    'Title'
89
                );
90
            } else {
91
                $fields->removeByName('DocumentSetSort');
92
                // Document listing
93
                $gridFieldConfig = GridFieldConfig::create()
94
                    ->addComponents(
95
                        new GridFieldButtonRow('before'),
96
                        new GridFieldToolbarHeader(),
97
                        new GridFieldFilterHeader(),
98
                        new GridFieldSortableHeader(),
99
                        new GridFieldDataColumns(),
100
                        new DMSGridFieldEditButton(),
101
                        // Special delete dialog to handle custom behaviour of unlinking and deleting
102
                        new GridFieldDeleteAction(true),
103
                        new GridFieldDetailForm()
104
                    );
105
106
                if (class_exists('GridFieldPaginatorWithShowAll')) {
107
                    $paginatorComponent = new GridFieldPaginatorWithShowAll(15);
108
                } else {
109
                    $paginatorComponent = new GridFieldPaginator(15);
110
                }
111
                $gridFieldConfig->addComponent($paginatorComponent);
112
113
                if (class_exists('GridFieldSortableRows')) {
114
                    $gridFieldConfig->addComponent(new GridFieldSortableRows('DocumentSort'));
115
                }
116
117
                // Don't show which page this is if we're already editing within a page context
118
                if (Controller::curr() instanceof CMSPageEditController) {
119
                    $fields->removeByName('PageID');
120
                } else {
121
                    $fields->fieldByName('Root.Main.PageID')->setTitle(_t('DMSDocumentSet.SHOWONPAGE', 'Show on page'));
122
                }
123
124
                $gridFieldConfig->getComponentByType('GridFieldDataColumns')
0 ignored issues
show
Bug introduced by helpfulrobot
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

  1. Change the type-hint for the parameter:

    class AuthSystem
    {
        public function authenticate(MyUser $user) { /* ... */ }
    }
    
  2. 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.
  1. Add the method to the interface:

    interface User
    {
        /** @return string */
        public function getPassword();
    
        /** @return string */
        public function getDisplayName();
    }
    
Loading history...
125
                    ->setDisplayFields($self->getDocumentDisplayFields())
126
                    ->setFieldCasting(array('LastEdited' => 'Datetime->Ago'))
127
                    ->setFieldFormatting(
128
                        array(
129
                            'FilenameWithoutID' => '<a target=\'_blank\' class=\'file-url\''
130
                                . ' href=\'$Link\'>$FilenameWithoutID</a>',
131
                            'ManuallyAdded' => function ($value) {
132
                                if ($value) {
133
                                    return _t('DMSDocumentSet.MANUAL', 'Manually');
134
                                }
135
                                return _t('DMSDocumentSet.QUERYBUILDER', 'Query Builder');
136
                            }
137
                        )
138
                    );
139
140
                // Override delete functionality with this class
141
                $gridFieldConfig->getComponentByType('GridFieldDetailForm')
0 ignored issues
show
Bug introduced by Robbie Averill
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

  1. Change the type-hint for the parameter:

    class AuthSystem
    {
        public function authenticate(MyUser $user) { /* ... */ }
    }
    
  2. 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.
  1. Add the method to the interface:

    interface User
    {
        /** @return string */
        public function getPassword();
    
        /** @return string */
        public function getDisplayName();
    }
    
Loading history...
142
                    ->setItemRequestClass('DMSGridFieldDetailForm_ItemRequest');
143
                $gridField = GridField::create(
144
                    'Documents',
145
                    false,
146
                    $self->Documents(),
0 ignored issues
show
Bug introduced by Franco Springveldt
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...
147
                    $gridFieldConfig
148
                );
149
                $gridField->setModelClass('DMSDocument');
150
                $gridField->addExtraClass('documents');
151
152
                $gridFieldConfig->addComponent(
153
                    $addNewButton = new DMSGridFieldAddNewButton('buttons-before-left'),
154
                    'GridFieldExportButton'
155
                );
156
                $addNewButton->setDocumentSetId($self->ID);
157
158
                $fields->removeByName('Documents');
159
                $fields->addFieldsToTab(
160
                    'Root.Main',
161
                    array(
162
                        $gridField,
163
                        HiddenField::create('DMSShortcodeHandlerKey', false, DMS::inst()->getShortcodeHandlerKey())
164
                    )
165
                );
166
                $self->addQueryFields($fields);
167
            }
168
        });
169
        $this->addRequirements();
170
        return parent::getCMSFields();
171
    }
172
173
    /**
174
     * Add required CSS and Javascript requirements for managing documents
175
     *
176
     * @return $this
177
     */
178
    protected function addRequirements()
179
    {
180
        // Javascript to customize the grid field for the DMS document (overriding entwine
181
        // in FRAMEWORK_DIR.'/javascript/GridField.js'
182
        Requirements::javascript(DMS_DIR . '/javascript/DMSGridField.js');
183
        Requirements::css(DMS_DIR . '/dist/css/dmsbundle.css');
184
185
        // Javascript for the link editor pop-up in TinyMCE
186
        Requirements::javascript(DMS_DIR . '/javascript/DocumentHtmlEditorFieldToolbar.js');
187
188
        return $this;
189
    }
190
191
    /**
192
     * Adds the query fields to build the document logic to the DMSDocumentSet.
193
     *
194
     * @param FieldList $fields
195
     */
196
    public function addQueryFields($fields)
197
    {
198
        /** @var DMSDocument $doc */
199
        $doc = singleton('DMSDocument');
200
        /** @var FormField $field */
201
        $dmsDocFields = $doc->scaffoldSearchFields(array('fieldClasses' => true));
202
        $membersMap = Member::get()->map('ID', 'Name')->toArray();
203
        asort($membersMap);
204
205
        foreach ($dmsDocFields as $field) {
206
            if ($field instanceof ListboxField) {
207
                $map = ($field->getName() === 'Tags__ID') ? $doc->getAllTagsMap() : $membersMap;
0 ignored issues
show
Documentation Bug introduced by Robbie Averill
The method getAllTagsMap does not exist on object<DMSDocument>? Since you implemented __call, maybe consider adding a @method annotation.

If you implement __call and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class.

This is often the case, when __call is implemented by a parent class and only the child class knows which methods exist:

class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
Loading history...
208
                $field->setMultiple(true)->setSource($map);
209
210
                if ($field->getName() === 'Tags__ID') {
211
                    $field->setRightTitle(
212
                        _t(
213
                            'DMSDocumentSet.TAGS_RIGHT_TITLE',
214
                            'Tags can be set in the taxonomy area, and can be assigned when editing a document.'
215
                        )
216
                    );
217
                }
218
            }
219
        }
220
        $keyValPairs = DMSJsonField::create('KeyValuePairs', $dmsDocFields->toArray());
221
222
        // Now lastly add the sort fields
223
        $sortedBy = FieldGroup::create('SortedBy', array(
224
            DropdownField::create('SortBy', '', array(
225
                'LastEdited'  => 'Last changed',
226
                'Created'     => 'Created',
227
                'Title'       => 'Document title',
228
            ), 'LastEdited'),
229
            DropdownField::create(
230
                'SortByDirection',
231
                '',
232
                array(
233
                    'DESC' => _t('DMSDocumentSet.DIRECTION_DESCENDING', 'Descending'),
234
                    'ASC' => _t('DMSDocumentSet.DIRECTION_ASCENDING', 'Ascending')
235
                ),
236
                'DESC'
237
            ),
238
        ));
239
240
        $sortedBy->setTitle(_t('DMSDocumentSet.SORTED_BY', 'Sort the document set by:'));
241
        $fields->addFieldsToTab(
242
            'Root.QueryBuilder',
243
            array(
244
                LiteralField::create(
245
                    'GridFieldNotice',
246
                    '<p class="message warning">' . _t(
247
                        'DMSDocumentSet.QUERY_BUILDER_NOTICE',
248
                        'The query builder provides the ability to add documents to a document set based on the ' .
249
                        'filters below. Please note that the set will be built using this criteria when you save the ' .
250
                        'form. This set will not be dynamically updated (see the documentation for more information).'
251
                    ) . '</p>'
252
                ),
253
                $keyValPairs,
254
                $sortedBy
255
            )
256
        );
257
    }
258
259
    public function onBeforeWrite()
260
    {
261
        parent::onBeforeWrite();
262
263
        $this->saveLinkedDocuments();
264
    }
265
266
    /**
267
     * Retrieve a list of the documents in this set. An extension hook is provided before the result is returned.
268
     */
269
    public function saveLinkedDocuments()
270
    {
271
        if (empty($this->KeyValuePairs) || !$this->isChanged('KeyValuePairs')) {
272
            return;
273
        }
274
275
        $keyValuesPair = Convert::json2array($this->KeyValuePairs);
276
277
        /** @var DMSDocument $dmsDoc */
278
        $dmsDoc = singleton('DMSDocument');
279
        $context = $dmsDoc->getDefaultSearchContext();
280
281
        $sortBy = $this->SortBy ? $this->SortBy : 'LastEdited';
282
        $sortByDirection = $this->SortByDirection ? $this->SortByDirection : 'DESC';
283
        $sortedBy = sprintf('%s %s', $sortBy, $sortByDirection);
284
285
        /** @var DataList $documents */
286
        $documents = $context->getResults($keyValuesPair, $sortedBy);
0 ignored issues
show
Bug introduced by Franco Springveldt
It seems like $keyValuesPair defined by \Convert::json2array($this->KeyValuePairs) on line 275 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...
287
        $documents = $this->addEmbargoConditions($documents);
288
        $documents = $this->addQueryBuilderSearchResults($documents);
0 ignored issues
show
Unused Code introduced by Robbie Averill
$documents is not used, you could remove the assignment.

This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently.

$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

Both the $myVar assignment in line 1 and the $higher assignment in line 2 are dead. The first because $myVar is never used and the second because $higher is always overwritten for every possible time line.

Loading history...
289
    }
290
291
    /**
292
     * Add embargo date conditions to a search query
293
     *
294
     * @param  DataList $documents
295
     * @return DataList
296
     */
297
    protected function addEmbargoConditions(DataList $documents)
298
    {
299
        $now = SS_Datetime::now()->Rfc2822();
300
301
        return $documents->where(
302
            "\"EmbargoedIndefinitely\" = 0 AND "
303
            . " \"EmbargoedUntilPublished\" = 0 AND "
304
            . "(\"EmbargoedUntilDate\" IS NULL OR "
305
            . "(\"EmbargoedUntilDate\" IS NOT NULL AND '{$now}' >= \"EmbargoedUntilDate\")) AND "
306
            . "\"ExpireAtDate\" IS NULL OR (\"ExpireAtDate\" IS NOT NULL AND '{$now}' < \"ExpireAtDate\")"
307
        );
308
    }
309
310
    /**
311
     * Remove all ManuallyAdded = 0 original results and add in the new documents returned by the search context
312
     *
313
     * @param  DataList $documents
314
     * @return DataList
315
     */
316
    protected function addQueryBuilderSearchResults(DataList $documents)
317
    {
318
        /** @var ManyManyList $originals Documents that belong to just this set. */
319
        $originals = $this->Documents();
0 ignored issues
show
Bug introduced by Franco Springveldt
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...
320
        $originals->removeByFilter('"ManuallyAdded" = 0');
321
322
        foreach ($documents as $document) {
323
            $originals->add($document, array('ManuallyAdded' => 0));
324
        }
325
326
        return $originals;
327
    }
328
329
    /**
330
     * Customise the display fields for the documents GridField
331
     *
332
     * @return array
333
     */
334
    public function getDocumentDisplayFields()
335
    {
336
        return array_merge(
337
            (array) DMSDocument::create()->config()->get('display_fields'),
338
            array('ManuallyAdded' => _t('DMSDocumentSet.ADDEDMETHOD', 'Added'))
339
        );
340
    }
341
342
    protected function validate()
343
    {
344
        $result = parent::validate();
345
346
        if (!$this->getTitle()) {
347
            $result->error(_t('DMSDocumentSet.VALIDATION_NO_TITLE', '\'Title\' is required.'));
348
        }
349
        return $result;
350
    }
351
352 View Code Duplication
    public function canView($member = null)
0 ignored issues
show
Duplication introduced by helpfulrobot
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
353
    {
354
        $extended = $this->extendedCan(__FUNCTION__, $member);
355
        if ($extended !== null) {
356
            return $extended;
357
        }
358
        return $this->getDMSDocumentSetPermissions($member);
359
    }
360
361 View Code Duplication
    public function canCreate($member = null)
0 ignored issues
show
Duplication introduced by helpfulrobot
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
362
    {
363
        $extended = $this->extendedCan(__FUNCTION__, $member);
364
        if ($extended !== null) {
365
            return $extended;
366
        }
367
        return  $this->getDMSDocumentSetPermissions($member);
368
    }
369
370 View Code Duplication
    public function canEdit($member = null)
0 ignored issues
show
Duplication introduced by helpfulrobot
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
371
    {
372
        $extended = $this->extendedCan(__FUNCTION__, $member);
373
        if ($extended !== null) {
374
            return $extended;
375
        }
376
        return $this->getDMSDocumentSetPermissions($member);
377
    }
378
379 View Code Duplication
    public function canDelete($member = null)
0 ignored issues
show
Duplication introduced by Franco Springveldt
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
380
    {
381
        $extended = $this->extendedCan(__FUNCTION__, $member);
382
        if ($extended !== null) {
383
            return $extended;
384
        }
385
        return $this->getDMSDocumentSetPermissions($member);
386
    }
387
388
    /**
389
     * Checks if a then given (or logged in) member is either an ADMIN, SITETREE_EDIT_ALL or has access
390
     * to the DMSDocumentAdmin module, in which case permissions is granted.
391
     *
392
     * @param Member $member
0 ignored issues
show
Documentation introduced by Franco Springveldt
Should the type for parameter $member not be null|Member?

This check looks for @param annotations where the type inferred by our type inference engine differs from the declared type.

It makes a suggestion as to what type it considers more descriptive.

Most often this is a case of a parameter that can be null in addition to its declared types.

Loading history...
393
     * @return bool
394
     */
395
    public function getDMSDocumentSetPermissions(Member $member = null)
396
    {
397 View Code Duplication
        if (!$member || !(is_a($member, 'Member')) || is_numeric($member)) {
0 ignored issues
show
Duplication introduced by Franco Springveldt
This code seems to be duplicated across your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
398
            $member = Member::currentUser();
399
        }
400
401
        $result = ($member &&
402
            Permission::checkMember(
403
                $member,
404
                array('ADMIN', 'SITETREE_EDIT_ALL', 'CMS_ACCESS_DMSDocumentAdmin')
405
            )
406
        );
407
408
        return (bool) $result;
409
    }
410
}
411