Completed
Push — master ( a48538...a41cf8 )
by Nicolaas
03:21
created

OrderProcessQueue::AddOrderToQueue()   A

Complexity

Conditions 3
Paths 2

Size

Total Lines 17
Code Lines 12

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 3
dl 0
loc 17
rs 9.4285
c 0
b 0
f 0
eloc 12
nc 2
nop 2
1
<?php
2
/**
3
 * This class provides a bunch of Meta Objects
4
 * that do not interact with the object at hand, but rather with the datalist as a whole.
5
 *
6
 */
7
8
class OrderProcessQueue 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...
9
{
10
    private static $db = array(
0 ignored issues
show
Unused Code introduced by
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...
Comprehensibility introduced by
Consider using a different property name as you override a private property of the parent class.
Loading history...
11
        'DeferTimeInSeconds' => 'Int',
12
        'InProcess' => 'Boolean'
13
    );
14
15
    private static $has_one = array(
0 ignored issues
show
Unused Code introduced by
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...
16
        'Order' => 'Order'
17
    );
18
19
    private static $indexes = array(
0 ignored issues
show
Unused Code introduced by
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...
Comprehensibility introduced by
Consider using a different property name as you override a private property of the parent class.
Loading history...
20
        'OrderID' => array(
21
            'type' => 'unique',
22
            'value' => '"OrderID"'
23
        ),
24
        'Created' => true,
25
        'DeferTimeInSeconds' => true
26
    );
27
28
    private static $casting = array(
0 ignored issues
show
Unused Code introduced by
The property $casting 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...
29
        'ToBeProcessedAt' => 'SS_Datetime'
30
    );
31
32
    private static $default_sort = array(
0 ignored issues
show
Unused Code introduced by
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...
Comprehensibility introduced by
Consider using a different property name as you override a private property of the parent class.
Loading history...
33
        'Created' => 'DESC'
34
    );
35
36
    /**
37
     * standard SS variable.
38
     *
39
     * @var array
40
     */
41
    private static $summary_fields = array(
0 ignored issues
show
Unused Code introduced by
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...
Comprehensibility introduced by
Consider using a different property name as you override a private property of the parent class.
Loading history...
42
        'Order.Title' => 'Order',
43
        'Order.Status.Title' => 'Current Step',
44
        'ToBeProcessedAt.Nice' => 'To be processed at',
45
        'ToBeProcessedAt.Ago' => 'That is ...',
46
        'InProcess.Nice' => 'Currently Running'
47
    );
48
49
    /**
50
     * standard SS variable.
51
     *
52
     * @var array
53
     */
54
    private static $searchable_fields = array(
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...
Unused Code introduced by
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...
55
        'OrderID' => array(
56
            'field' => 'NumericField',
57
            'title' => 'Order Number',
58
        )
59
    );
60
61
62
    /**
63
     * Standard SS method.
64
     *
65
     * @param Member $member
0 ignored issues
show
Documentation introduced by
Should the type for parameter $member not be Member|null?

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...
66
     *
67
     * @return bool
68
     */
69
    public function canCreate($member = null)
70
    {
71
        return false;
72
    }
73
74
    /**
75
     * Standard SS method.
76
     *
77
     * @param Member $member
0 ignored issues
show
Documentation introduced by
Should the type for parameter $member not be Member|null?

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...
78
     *
79
     * @return bool
0 ignored issues
show
Documentation introduced by
Should the return type not be boolean|string|null?

This check compares the return type specified in the @return annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch.

Loading history...
80
     */
81
    public function canView($member = null)
82
    {
83
        if (! $member) {
84
            $member = Member::currentUser();
85
        }
86
        $extended = $this->extendedCan(__FUNCTION__, $member);
0 ignored issues
show
Documentation introduced by
$member is of type object<DataObject>|null, but the function expects a object<Member>|integer.

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...
87
        if ($extended !== null) {
88
            return $extended;
89
        }
90
        if (Permission::checkMember($member, Config::inst()->get('EcommerceRole', 'admin_permission_code'))) {
91
            return true;
92
        }
93
        //is the member is a shop assistant they can always view it
94
        if (EcommerceRole::current_member_is_shop_assistant($member)) {
95
            return true;
96
        }
97
98
        return parent::canView($member);
0 ignored issues
show
Bug introduced by
It seems like $member defined by \Member::currentUser() on line 84 can also be of type object<DataObject>; however, DataObject::canView() does only seem to accept object<Member>|null, 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...
99
    }
100
101
    /**
102
     * Standard SS method.
103
     *
104
     * @param Member $member
0 ignored issues
show
Documentation introduced by
Should the type for parameter $member not be Member|null?

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...
105
     *
106
     * @return bool
107
     */
108
    public function canEdit($member = null)
109
    {
110
        return false;
111
    }
112
113
    /**
114
     * Standard SS method
115
     * logs can never be deleted...
116
     *
117
     * @param Member $member
0 ignored issues
show
Documentation introduced by
Should the type for parameter $member not be Member|null?

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...
118
     *
119
     * @return bool
120
     */
121
    public function canDelete($member = null)
122
    {
123
        return false;
124
    }
125
126
    /**
127
     * standard SS variable.
128
     *
129
     * @var string
130
     */
131
    private static $singular_name = 'Order To Be Processed';
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...
Unused Code introduced by
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...
132
    public function i18n_singular_name()
133
    {
134
        return _t('OrderProcessQueue.SINGULAR_NAME', 'Order To Be Processed');
135
    }
136
137
    /**
138
     * standard SS variable.
139
     *
140
     * @var string
141
     */
142
    private static $plural_name = 'Orders to be Processed';
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...
Unused Code introduced by
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...
143
    public function i18n_plural_name()
144
    {
145
        return _t('OrderProcessQueue.PLURAL_NAME', 'Orders to be Processed');
146
    }
147
148
149
    /**
150
     * META METHOD: Add an order to the job list.
151
     * If the order already exists, it will update the seconds and the creation  time.
152
     *
153
     * @param Order $order          [description]
154
     * @param Int   $deferInSeconds [description]
0 ignored issues
show
Bug introduced by
There is no parameter named $deferInSeconds. Was it maybe removed?

This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function.

Consider the following example. The parameter $italy is not defined by the method finale(...).

/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}

The most likely cause is that the parameter was removed, but the annotation was not.

Loading history...
155
     */
156
    public function AddOrderToQueue($order, $deferTimeInSeconds)
157
    {
158
        $filter = array('OrderID' => $order->ID);
159
        $existingEntry = OrderProcessQueue::get()->filter($filter)->first();
160
        $filter['Created'] = SS_Datetime::now()->Rfc2822();
161
        $filter['DeferTimeInSeconds'] = $deferTimeInSeconds;
162
        if (! $existingEntry) {
163
            $existingEntry = OrderProcessQueue::create($filter);
164
        } else {
165
            foreach ($filter as $field => $value) {
166
                $existingEntry->$field = $value;
167
            }
168
        }
169
        $existingEntry->write();
170
171
        return $existingEntry;
172
    }
173
174
    /**
175
     * processes the order ...
176
     *
177
     * @param  Order $order
178
     */
179
    public function process($order)
180
    {
181
        $queueObjectSingleton = Injector::inst()->get('OrderProcessQueue');
182
        $myQueueObject = $queueObjectSingleton->getQueueObject($order);
183
        if ($myQueueObject->isReadyToGo()) {
184
            $myQueueObject->InProcess = true;
185
            $myQueueObject->write();
186
            $order->tryToFinaliseOrder(
187
                $tryAgain = false,
188
                $fromOrderQueue = true
189
            );
190
            $myQueueObject->delete();
191
        }
192
    }
193
194
    /**
195
     * META METHOD: returns the queue object if it exists
196
     *
197
     * @param  Order $order
198
     *
199
     * @return null |   OrderProcessQueue
0 ignored issues
show
Documentation introduced by
Should the return type not be DataObject|false?

This check compares the return type specified in the @return annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch.

Loading history...
200
     */
201
    public function getQueueObject($order)
202
    {
203
        $filter = array('OrderID' => $order->ID);
204
        $existingEntry = OrderProcessQueue::get()->filter($filter)->first();
205
        if ($existingEntry) {
206
            return $existingEntry;
207
        }
208
209
        return false;
210
    }
211
212
    /**
213
     * META METHOD: Once you are done, you can remove the item like this ...
214
     *
215
     * @param  Order $order
216
     */
217
    public function removeOrderFromQueue($order)
218
    {
219
        $filter = array('OrderID' => $order->ID);
220
        $existingEntries = OrderProcessQueue::get()->filter($filter);
221
        $existingEntries->removeAll();
222
    }
223
224
    /**
225
     * META METHOD: returns a list of orders to be processed
226
     * @param int $limit total number of orders that can be retrieved at any one time
227
     * @param int $id force this Order to be processed
228
     * @return DataList (of orders)
229
     */
230
    public function OrdersToBeProcessed($limit = 9999, $id = 0)
231
    {
232
        $sql = '
233
            SELECT "OrderID"
234
            FROM "OrderProcessQueue"
235
            WHERE
236
                "InProcess" = 0
237
                AND
238
                (UNIX_TIMESTAMP("Created") + "DeferTimeInSeconds") < '.time().'
239
            ORDER BY "Created" DESC
240
            LIMIT = '.$limit.';
241
        ';
242
        $rows = DB::query($sql);
243
        $orderIDs = array($id => $id);
244
        foreach ($rows as $row) {
245
            $orderIDs[$row['OrderID']] = $row['OrderID'];
246
        }
247
248
        return Order::get()
249
            ->filter(array('ID' => $orderIDs));
250
    }
251
252
    /**
253
     * non-database method of working out if an Order is ready to go.
254
     *
255
     * @return bool
256
     */
257
    public function isReadyToGo()
258
    {
259
        return (strtotime($this->Created) + $this->DeferTimeInSeconds) < time();
0 ignored issues
show
Documentation introduced by
The property DeferTimeInSeconds does not exist on object<OrderProcessQueue>. 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...
260
    }
261
262
    /**
263
     *
264
     * casted variable
265
     * @return SS_DateTime
266
     */
267
    public function ToBeProcessedAt()
268
    {
269
        return $this->getToBeProcessedAt();
270
    }
271
272
    /**
273
     *
274
     * casted variable
275
     * @return SS_DateTime
276
     */
277
    public function getToBeProcessedAt()
278
    {
279
        return DBField::create_field('SS_Datetime', (strtotime($this->Created) + $this->DeferTimeInSeconds));
0 ignored issues
show
Documentation introduced by
The property DeferTimeInSeconds does not exist on object<OrderProcessQueue>. 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...
280
    }
281
282
283
    /**
284
     * CMS Fields
285
     * @return FieldList
286
     */
287
    public function getCMSFields()
288
    {
289
        $fields = parent::getCMSFields();
290
        if($this->exists()) {
291
            $fields->addFieldToTab(
292
                'Root.main',
293
                LiteralField::create(
294
                    'processQueueNow',
295
                    '<h2><a href="/dev/tasks/EcommerceTaskProcessOrderQueue/?id='.$this->ID.'" target="_blank">'._t('OrderProcessQueue.PROCESS', 'Process now').'</a></h2>'
296
                )
297
            );
298
        }
299
        return $fields;
300
    }
301
}
302