Issues (150)

Security Analysis    no request data  

This project does not seem to handle request data directly as such no vulnerable execution paths were found.

  Cross-Site Scripting
Cross-Site Scripting enables an attacker to inject code into the response of a web-request that is viewed by other users. It can for example be used to bypass access controls, or even to take over other users' accounts.
  File Exposure
File Exposure allows an attacker to gain access to local files that he should not be able to access. These files can for example include database credentials, or other configuration files.
  File Manipulation
File Manipulation enables an attacker to write custom data to files. This potentially leads to injection of arbitrary code on the server.
  Object Injection
Object Injection enables an attacker to inject an object into PHP code, and can lead to arbitrary code execution, file exposure, or file manipulation attacks.
  Code Injection
Code Injection enables an attacker to execute arbitrary code on the server.
  Response Splitting
Response Splitting can be used to send arbitrary responses.
  File Inclusion
File Inclusion enables an attacker to inject custom files into PHP's file loading mechanism, either explicitly passed to include, or for example via PHP's auto-loading mechanism.
  Command Injection
Command Injection enables an attacker to inject a shell command that is execute with the privileges of the web-server. This can be used to expose sensitive data, or gain access of your server.
  SQL Injection
SQL Injection enables an attacker to execute arbitrary SQL code on your database server gaining access to user data, or manipulating user data.
  XPath Injection
XPath Injection enables an attacker to modify the parts of XML document that are read. If that XML document is for example used for authentication, this can lead to further vulnerabilities similar to SQL Injection.
  LDAP Injection
LDAP Injection enables an attacker to inject LDAP statements potentially granting permission to run unauthorized queries, or modify content inside the LDAP tree.
  Header Injection
  Other Vulnerability
This category comprises other attack vectors such as manipulating the PHP runtime, loading custom extensions, freezing the runtime, or similar.
  Regex Injection
Regex Injection enables an attacker to execute arbitrary code in your PHP process.
  XML Injection
XML Injection enables an attacker to read files on your local filesystem including configuration files, or can be abused to freeze your web-server process.
  Variable Injection
Variable Injection enables an attacker to overwrite program variables with custom data, and can lead to further vulnerabilities.
Unfortunately, the security analysis is currently not available for your project. If you are a non-commercial open-source project, please contact support to gain access.

code/model/ImagesWithStyleSelection.php (37 issues)

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

1
<?php
2
3
4
5
class ImagesWithStyleSelection extends DataObject
0 ignored issues
show
Coding Style Compatibility introduced by
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...
6
{
7
8
9
    #######################
10
    ### Names Section
11
    #######################
12
13
    private static $singular_name = 'Selection of Images';
0 ignored issues
show
Comprehensibility introduced by
Consider using a different property name as you override a private property of the parent class.
Loading history...
The property $singular_name 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
15
    public function i18n_singular_name()
16
    {
17
        return _t('ImagesWithStyleSelection.SINGULAR_NAME', 'Selection of Images');
18
    }
19
20
    private static $plural_name = 'Selections of Images';
0 ignored issues
show
Comprehensibility introduced by
Consider using a different property name as you override a private property of the parent class.
Loading history...
The property $plural_name 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
22
    public function i18n_plural_name()
23
    {
24
        return _t('ImagesWithStyleSelection.PLURAL_NAME', 'Selections of Images');
25
    }
26
27
28
    #######################
29
    ### Model Section
30
    #######################
31
32
    private static $db = [
0 ignored issues
show
Comprehensibility introduced by
Consider using a different property name as you override a private property of the parent class.
Loading history...
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...
33
        'Title' => 'Varchar(255)', // this needs to be lengthy to avoid the same names ...
34
        'Description' => 'Text'
35
    ];
36
37
    private static $has_one = [
0 ignored issues
show
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...
Comprehensibility introduced by
Consider using a different property name as you override a private property of the parent class.
Loading history...
38
        'PlaceToStoreImages' => 'Folder'
39
    ];
40
41
    private static $many_many = [
0 ignored issues
show
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...
Comprehensibility introduced by
Consider using a different property name as you override a private property of the parent class.
Loading history...
42
        'StyledImages' => 'ImageWithStyle'
43
    ];
44
45
    private static $many_many_extraFields = [
0 ignored issues
show
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...
Comprehensibility introduced by
Consider using a different property name as you override a private property of the parent class.
Loading history...
46
        'StyledImages' => [
47
            'SortOrder' => 'Int',
48
        ]
49
    ];
50
51
    public function StyledImages()
52
    {
53
        return $this->getManyManyComponents('StyledImages')->sort('SortOrder');
54
    }
55
56
    #######################
57
    ### Further DB Field Details
58
    #######################
59
60
    private static $indexes = [
0 ignored issues
show
Comprehensibility introduced by
Consider using a different property name as you override a private property of the parent class.
Loading history...
The property $indexes 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...
61
        'Created' => true,
62
        'Title' => 'unique("Title")'
63
    ];
64
65
    private static $defaults = [
0 ignored issues
show
Comprehensibility introduced by
Consider using a different property name as you override a private property of the parent class.
Loading history...
The property $defaults 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...
66
        'Title' => ''
67
    ];
68
69
    private static $default_sort = [
0 ignored issues
show
Comprehensibility introduced by
Consider using a different property name as you override a private property of the parent class.
Loading history...
The property $default_sort 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...
70
        'Created' => 'DESC'
71
    ];
72
73
    private static $required_fields = [
0 ignored issues
show
The property $required_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...
74
        'Title'
75
    ];
76
77
    private static $searchable_fields = [
0 ignored issues
show
Comprehensibility introduced by
Consider using a different property name as you override a private property of the parent class.
Loading history...
The property $searchable_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...
78
        'Title' => 'PartialMatchFilter'
79
    ];
80
81
82
    #######################
83
    ### Field Names and Presentation Section
84
    #######################
85
86
    private static $field_labels = [
0 ignored issues
show
Comprehensibility introduced by
Consider using a different property name as you override a private property of the parent class.
Loading history...
The property $field_labels 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...
87
        'StyledImages' => 'Images to be included'
88
    ];
89
90
    private static $field_labels_right = [
0 ignored issues
show
The property $field_labels_right 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...
91
        'StyledImages' => 'Select as many as you like and sort them in the right order'
92
    ];
93
94
    private static $summary_fields = [
0 ignored issues
show
Comprehensibility introduced by
Consider using a different property name as you override a private property of the parent class.
Loading history...
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...
95
        'Title' => 'Name',
96
        'StyledImages.Count' => 'Number of Images'
97
    ];
98
99
100
    #######################
101
    ### Casting Section
102
    #######################
103
104
105
    #######################
106
    ### can Section
107
    #######################
108
109
110
111
    #######################
112
    ### write Section
113
    #######################
114
115
116
117
118 View Code Duplication
    public function validate()
0 ignored issues
show
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...
119
    {
120
        $result = parent::validate();
121
        $fieldLabels = $this->FieldLabels();
122
        $indexes = $this->Config()->get('indexes');
123
        $requiredFields = $this->Config()->get('required_fields');
124
        if (is_array($requiredFields)) {
125
            foreach ($requiredFields as $field) {
126
                $value = $this->$field;
127
                if (! $value) {
128
                    $fieldWithoutID = $field;
129
                    if (substr($fieldWithoutID, -2) === 'ID') {
130
                        $fieldWithoutID = substr($fieldWithoutID, 0, -2);
131
                    }
132
                    $myName = isset($fieldLabels[$fieldWithoutID]) ? $fieldLabels[$fieldWithoutID] : $fieldWithoutID;
133
                    $result->error(
134
                        _t(
135
                            'ImagesWithStyleSelection.'.$field.'_REQUIRED',
136
                            $myName.' is required'
137
                        ),
138
                        'REQUIRED_ImagesWithStyleSelection_'.$field
139
                    );
140
                }
141
                if (isset($indexes[$field]) && isset($indexes[$field]['type']) && $indexes[$field]['type'] === 'unique') {
142
                    $id = (empty($this->ID) ? 0 : $this->ID);
143
                    $count = ImagesWithStyleSelection::get()
144
                        ->filter(array($field => $value))
145
                        ->exclude(array('ID' => $id))
146
                        ->count();
147
                    if ($count > 0) {
148
                        $myName = $fieldLabels['$field'];
149
                        $result->error(
150
                            _t(
151
                                'ImagesWithStyleSelection.'.$field.'_UNIQUE',
152
                                $myName.' needs to be unique'
153
                            ),
154
                            'UNIQUE_ImagesWithStyleSelection_'.$field
155
                        );
156
                    }
157
                }
158
            }
159
        }
160
161
        return $result;
162
    }
163
164
165
    public function onBeforeWrite()
166
    {
167
        parent::onBeforeWrite();
168
        if ($this->exists() && $this->PlaceToStoreImagesID) {
0 ignored issues
show
The property PlaceToStoreImagesID does not exist on object<ImagesWithStyleSelection>. Since you implemented __get, maybe consider adding a @property annotation.

Since your code implements the magic getter _get, this function will be called for any read access on an undefined variable. You can add the @property annotation to your class or interface to document the existence of this variable.

<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

If the property has read access only, you can use the @property-read annotation instead.

Of course, you may also just have mistyped another name, in which case you should fix the error.

See also the PhpDoc documentation for @property.

Loading history...
169
            $allImages = Image::get()->filter(['ParentID' => $this->PlaceToStoreImagesID])->column('ID');
0 ignored issues
show
The property PlaceToStoreImagesID does not exist on object<ImagesWithStyleSelection>. Since you implemented __get, maybe consider adding a @property annotation.

Since your code implements the magic getter _get, this function will be called for any read access on an undefined variable. You can add the @property annotation to your class or interface to document the existence of this variable.

<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

If the property has read access only, you can use the @property-read annotation instead.

Of course, you may also just have mistyped another name, in which case you should fix the error.

See also the PhpDoc documentation for @property.

Loading history...
170
            $existingImages = $this->RawImages()->column('ID');
171
            $difference = array_diff($allImages, $existingImages);
172
            $list = $this->StyledImages();
173
            if (count($difference)) {
174
                foreach ($difference as $imageID) {
175
                    $image = Image::get()->byID($imageID);
176
                    if ($image) {
177
                        $styledImage = ImageWithStyle::create();
178
                        $styledImage->Title = $image->Name;
0 ignored issues
show
The property Title does not exist on object<ImageWithStyle>. Since you implemented __set, maybe consider adding a @property annotation.

Since your code implements the magic setter _set, this function will be called for any write access on an undefined variable. You can add the @property annotation to your class or interface to document the existence of this variable.

<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

Since the property has write access only, you can use the @property-write annotation instead.

Of course, you may also just have mistyped another name, in which case you should fix the error.

See also the PhpDoc documentation for @property.

Loading history...
179
                        $styledImage->ImageID = $imageID;
0 ignored issues
show
The property ImageID does not exist on object<ImageWithStyle>. Since you implemented __set, maybe consider adding a @property annotation.

Since your code implements the magic setter _set, this function will be called for any write access on an undefined variable. You can add the @property annotation to your class or interface to document the existence of this variable.

<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

Since the property has write access only, you can use the @property-write annotation instead.

Of course, you may also just have mistyped another name, in which case you should fix the error.

See also the PhpDoc documentation for @property.

Loading history...
180
                        $styledImage->StyleID = ImageStyle::get_default_style()->ID;
0 ignored issues
show
The property StyleID does not exist on object<ImageWithStyle>. Since you implemented __set, maybe consider adding a @property annotation.

Since your code implements the magic setter _set, this function will be called for any write access on an undefined variable. You can add the @property annotation to your class or interface to document the existence of this variable.

<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

Since the property has write access only, you can use the @property-write annotation instead.

Of course, you may also just have mistyped another name, in which case you should fix the error.

See also the PhpDoc documentation for @property.

Loading history...
181
                        $styledImage->write();
182
                        $list->add($styledImage);
183
                    }
184
                }
185
            }
186
        }
187
        //...
188
    }
189
190
    public function requireDefaultRecords()
191
    {
192
        parent::requireDefaultRecords();
193
        //...
194
    }
195
196
197
    #######################
198
    ### Import / Export Section
199
    #######################
200
201
    public function getExportFields()
0 ignored issues
show
The return type could not be reliably inferred; please add a @return annotation.

Our type inference engine in quite powerful, but sometimes the code does not provide enough clues to go by. In these cases we request you to add a @return annotation as described here.

Loading history...
202
    {
203
        //..
204
        return parent::getExportFields();
0 ignored issues
show
It seems like you code against a specific sub-type and not the parent class DataObject as the method getExportFields() does only exist in the following sub-classes of DataObject: ImageStyle, ImageWithStyle, ImagesWithStyleSelection. Maybe you want to instanceof check for one of these explicitly?

Let’s take a look at an example:

abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends 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 sub-classes 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 parent class:

    abstract class User
    {
        /** @return string */
        abstract public function getPassword();
    
        /** @return string */
        abstract public function getDisplayName();
    }
    
Loading history...
205
    }
206
207
208
209
    #######################
210
    ### CMS Edit Section
211
    #######################
212
213
214
    public function CMSEditLink()
215
    {
216
        $controller = singleton("ImageWithStyleAdmin");
217
218
        return $controller->Link().$this->ClassName."/EditForm/field/".$this->ClassName."/item/".$this->ID."/edit";
219
    }
220
221
    public function CMSAddLink()
222
    {
223
        $controller = singleton("ImageWithStyleAdmin");
224
225
        return $controller->Link().$this->ClassName."/EditForm/field/".$this->ClassName."/item/new";
226
    }
227
228
229
    public function getCMSFields()
230
    {
231
        $fields = parent::getCMSFields();
232
        $fields->removeByName('PlaceToStoreImages');
233
        $fields->addFieldToTab(
234
            'Root.Main',
235
            $treeField = TreeDropdownField::create(
236
                'PlaceToStoreImagesID',
237
                'Image Folder',
238
                'Folder'
239
            )->setRightTitle('Optional - set folder ... all images in this folder will automatically be added.')
240
        );
241
242
        //do first??
243
        $rightFieldDescriptions = $this->Config()->get('field_labels_right');
244 View Code Duplication
        foreach ($rightFieldDescriptions as $field => $desc) {
0 ignored issues
show
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...
245
            $formField = $fields->DataFieldByName($field);
246
            if (! $formField) {
247
                $formField = $fields->DataFieldByName($field.'ID');
248
            }
249
            if ($formField) {
250
                $formField->setDescription($desc);
251
            }
252
        }
253
        //...
254
255
        ImagesWithStyleCMSAPI::add_links_to_folder_field($treeField, $this);
256
257
        if ($this->exists()) {
258
            $config = GridFieldConfig_RelationEditor::create();
259
            $config->addComponent(new GridFieldSortableRows('SortOrder'));
260
            $fields->removeByName('StyledImages');
261
            $fields->addFieldToTab(
262
                    'Root.Images',
263
                    GridField::create(
264
                        'StyledImages',
265
                        'Images',
266
                        $this->StyledImages(),
267
                        $config
268
                    )
269
                );
270
        }
271
        return $fields;
272
    }
273
274
275
    /**
276
     * @return Int
277
     */
278
    public function ImageCount()
279
    {
280
        return $this->StyledImages()->count();
281
    }
282
283
    /**
284
     * @return DataList
285
     */
286
    public function RawImages()
287
    {
288
        $array = [];
289
        if ($this->StyledImages()->count()) {
290
            foreach ($this->StyledImages()->column('ImageID') as $id) {
291
                if ($id) {
292
                    $array[$id] = $id;
293
                }
294
            }
295
        }
296
297
        return Image::get()->filter(['ID' => $array]);
298
    }
299
300
    /**
301
     * force the list to use a certain folder ...
302
     * @param  string $folderName
303
     *
304
     * @return ImagesWithStyleSelection
305
     */
306
    public function createFolder($folderName)
307
    {
308
        $folder = Folder::find_or_make($folderName);
309
        $this->PlaceToStoreImagesID = $folder->ID;
0 ignored issues
show
The property PlaceToStoreImagesID does not exist on object<ImagesWithStyleSelection>. Since you implemented __set, maybe consider adding a @property annotation.

Since your code implements the magic setter _set, this function will be called for any write access on an undefined variable. You can add the @property annotation to your class or interface to document the existence of this variable.

<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

Since the property has write access only, you can use the @property-write annotation instead.

Of course, you may also just have mistyped another name, in which case you should fix the error.

See also the PhpDoc documentation for @property.

Loading history...
310
        $this->write();
311
312
        return $this;
313
    }
314
}
315