ScheduledExecutionTest::testScheduledExecutionInterval() - Code Metrics - silverstripe-australia/silverstripe-queuedjobs - Measure and Improve Code Quality continuously with Scrutinizer

testScheduledExecutionInterval() A
last analyzed 2017-06-30 01:57 UTC

↳ Parent: ScheduledExecutionTest

Complexity

Conditions	3
Paths	4

Size

Total Lines	69
Code Lines	38

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	69
rs	9.2083
c	0
b	0
f	0
cc	3
eloc	38
nc	4
nop	0

How to fix Long Method

<?php

use SilverStripe\Dev\SapphireTest;
use SilverStripe\ORM\DataObject;
use Symbiote\QueuedJobs\Tests\ScheduledExecutionTest\TestScheduledDataObject;

/**
 * @author [email protected]
 * @license BSD License http://silverstripe.org/bsd-license/
 */
class ScheduledExecutionTest extends SapphireTest
namespace YourVendor;

class YourClass { }
{
    /**
     * We need the DB for this test
     *
     * @var bool
     */
    protected $usesDatabase = true;

    /**
     * {@inheritDoc}
     * @var array
     */
    protected static $extra_dataobjects = array(
        TestScheduledDataObject::class
    );

    public function testScheduledExecutionTimes()
    {
        $test = new TestScheduledDataObject;

        $test->Title = 'Test execute of stuff';
<?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.");
        }
    }

}
        $test->write();

        $test->FirstExecution = '1980-09-22 09:15:00';
<?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.");
        }
    }

}
        $test->ExecuteEvery = 'Hour';
<?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.");
        }
    }

}

        $test->write();

        // should now have a job
        $this->assertTrue($test->ScheduledJobID > 0, 'Scheduled job has not been created');
<?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.");
        }
    }

}

        $jobId = $test->ScheduledJobID;
<?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.");
        }
    }

}

        // execute said job
        $job = $test->ScheduledJob();
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 { }

        $job->execute();

        // reload the test object and make sure its job has now changed
        $test = DataObject::get_by_id(TestScheduledDataObject::class, $test->ID);

        $this->assertNotEquals($test->ScheduledJobID, $jobId);
        $this->assertEquals('EXECUTED', $test->Message);
    }

    public function testScheduledExecutionInterval()
    {
        $test = new TestScheduledDataObject;

        $test->Title = 'Test execute at custom interval sizes';
<?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.");
        }
    }

}
        $test->write();

        $test->FirstExecution = '1980-09-22 09:15:00';
<?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.");
        }
    }

}
        $test->ExecuteEvery = 'Minute';
<?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.");
        }
    }

}

        $test->write();

        // should now have a job
        $this->assertTrue($test->ScheduledJobID > 0, 'Scheduled job has not been created');
<?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.");
        }
    }

}
        // should default the ExecuteInterval
        $this->assertEquals(1, $test->ExecuteInterval, 'ExecuteInterval did not default to 1');
<?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.");
        }
    }

}

        // should check the interval in code also
        $test->ExecuteInterval = 0;
<?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.");
        }
    }

}
        $test->write();

        $jobId = $test->ScheduledJobID;
<?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.");
        }
    }

}

        // execute said job
        $job = $test->ScheduledJob();
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 { }
        $job->execute();

        // reload the test object and make sure its job has now changed
        $test = DataObject::get_by_id(TestScheduledDataObject::class, $test->ID);

        $this->assertNotEquals($test->ScheduledJobID, $jobId);
        $this->assertEquals('EXECUTED', $test->Message);

        $job = $test->ScheduledJob();

        // should reschedule in 1 minute time
        $expectedMinutes = date('i', time());
        $expectedMinutes = intval($expectedMinutes, 10);
        if ($expectedMinutes + 1 > 59) { // Wrap around the hour
            $expectedMinutes = $expectedMinutes - 59;
        }
        $scheduledMinutes = substr($job->StartAfter, 14, 2);
        $scheduledMinutes = intval($scheduledMinutes, 10);

        $this->assertEquals($expectedMinutes + 1, $scheduledMinutes, 'Did not reschedule 1 minute later');

        // test a custom interval of 3 minutes

        $test->ExecuteInterval = 3;
        $test->write();

        $job = $test->ScheduledJob();
        $job->execute();

        $test = DataObject::get_by_id(TestScheduledDataObject::class, $test->ID);

        $job = $test->ScheduledJob();

        // should reschedule in 3 minutes time
        $expectedMinutes = date('i', time());
        $expectedMinutes = intval($expectedMinutes, 10);
        if ($expectedMinutes + 3 > 59) {
            $expectedMinutes = $expectedMinutes - 59;
        }
        $scheduledMinutes = substr($job->StartAfter, 14, 2);
        $scheduledMinutes = intval($scheduledMinutes, 10);

        $this->assertEquals($expectedMinutes + 3, $scheduledMinutes, 'Did not reschedule 3 minutes later');
    }
}


1			<?php
2
3			use SilverStripe\Dev\SapphireTest;
4			use SilverStripe\ORM\DataObject;
5			use Symbiote\QueuedJobs\Tests\ScheduledExecutionTest\TestScheduledDataObject;
6
7			/**
8			* @author [email protected]
9			* @license BSD License http://silverstripe.org/bsd-license/
10			*/
11			class ScheduledExecutionTest extends SapphireTest
			0 ignored issues – show Coding Style Compatibility introduced 2015-11-20 23:52 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...
12			{
13			/**
14			* We need the DB for this test
15			*
16			* @var bool
17			*/
18			protected $usesDatabase = true;
19
20			/**
21			* {@inheritDoc}
22			* @var array
23			*/
24			protected static $extra_dataobjects = array(
25			TestScheduledDataObject::class
26			);
27
28			public function testScheduledExecutionTimes()
29			{
30			$test = new TestScheduledDataObject;
31
32			$test->Title = 'Test execute of stuff';
			0 ignored issues – show Documentation introduced 2017-06-30 01:57 UTC by Report Bug Copy Issue Report The property `Title` does not exist on `object<Symbiote\QueuedJo...estScheduledDataObject>`. 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...
33			$test->write();
34
35			$test->FirstExecution = '1980-09-22 09:15:00';
			0 ignored issues – show Documentation introduced 2017-06-30 01:57 UTC by Report Bug Copy Issue Report The property `FirstExecution` does not exist on `object<Symbiote\QueuedJo...estScheduledDataObject>`. 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...
36			$test->ExecuteEvery = 'Hour';
			0 ignored issues – show Documentation introduced 2017-06-30 01:57 UTC by Report Bug Copy Issue Report The property `ExecuteEvery` does not exist on `object<Symbiote\QueuedJo...estScheduledDataObject>`. 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...
37
38			$test->write();
39
40			// should now have a job
41			$this->assertTrue($test->ScheduledJobID > 0, 'Scheduled job has not been created');
			0 ignored issues – show Documentation introduced 2017-06-30 01:57 UTC by Report Bug Copy Issue Report The property `ScheduledJobID` does not exist on `object<Symbiote\QueuedJo...estScheduledDataObject>`. 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...
42
43			$jobId = $test->ScheduledJobID;
			0 ignored issues – show Documentation introduced 2017-06-30 01:57 UTC by Report Bug Copy Issue Report The property `ScheduledJobID` does not exist on `object<Symbiote\QueuedJo...estScheduledDataObject>`. 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...
44
45			// execute said job
46			$job = $test->ScheduledJob();
			0 ignored issues – show Documentation Bug introduced 2017-06-30 01:57 UTC by Report Bug Copy Issue Report The method `ScheduledJob` does not exist on `object<Symbiote\QueuedJo...estScheduledDataObject>`? 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...
47
48			$job->execute();
49
50			// reload the test object and make sure its job has now changed
51			$test = DataObject::get_by_id(TestScheduledDataObject::class, $test->ID);
52
53			$this->assertNotEquals($test->ScheduledJobID, $jobId);
54			$this->assertEquals('EXECUTED', $test->Message);
55			}
56
57			public function testScheduledExecutionInterval()
58			{
59			$test = new TestScheduledDataObject;
60
61			$test->Title = 'Test execute at custom interval sizes';
			0 ignored issues – show Documentation introduced 2017-06-30 01:57 UTC by Report Bug Copy Issue Report The property `Title` does not exist on `object<Symbiote\QueuedJo...estScheduledDataObject>`. 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...
62			$test->write();
63
64			$test->FirstExecution = '1980-09-22 09:15:00';
			0 ignored issues – show Documentation introduced 2017-06-30 01:57 UTC by Report Bug Copy Issue Report The property `FirstExecution` does not exist on `object<Symbiote\QueuedJo...estScheduledDataObject>`. 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...
65			$test->ExecuteEvery = 'Minute';
			0 ignored issues – show Documentation introduced 2017-06-30 01:57 UTC by Report Bug Copy Issue Report The property `ExecuteEvery` does not exist on `object<Symbiote\QueuedJo...estScheduledDataObject>`. 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...
66
67			$test->write();
68
69			// should now have a job
70			$this->assertTrue($test->ScheduledJobID > 0, 'Scheduled job has not been created');
			0 ignored issues – show Documentation introduced 2017-06-30 01:57 UTC by Report Bug Copy Issue Report The property `ScheduledJobID` does not exist on `object<Symbiote\QueuedJo...estScheduledDataObject>`. 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...
71			// should default the ExecuteInterval
72			$this->assertEquals(1, $test->ExecuteInterval, 'ExecuteInterval did not default to 1');
			0 ignored issues – show Documentation introduced 2017-06-30 01:57 UTC by Report Bug Copy Issue Report The property `ExecuteInterval` does not exist on `object<Symbiote\QueuedJo...estScheduledDataObject>`. 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...
73
74			// should check the interval in code also
75			$test->ExecuteInterval = 0;
			0 ignored issues – show Documentation introduced 2017-06-30 01:57 UTC by Report Bug Copy Issue Report The property `ExecuteInterval` does not exist on `object<Symbiote\QueuedJo...estScheduledDataObject>`. 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...
76			$test->write();
77
78			$jobId = $test->ScheduledJobID;
			0 ignored issues – show Documentation introduced 2017-06-30 01:57 UTC by Report Bug Copy Issue Report The property `ScheduledJobID` does not exist on `object<Symbiote\QueuedJo...estScheduledDataObject>`. 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...
79
80			// execute said job
81			$job = $test->ScheduledJob();
			0 ignored issues – show Documentation Bug introduced 2017-06-30 01:57 UTC by Report Bug Copy Issue Report The method `ScheduledJob` does not exist on `object<Symbiote\QueuedJo...estScheduledDataObject>`? 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...
82			$job->execute();
83
84			// reload the test object and make sure its job has now changed
85			$test = DataObject::get_by_id(TestScheduledDataObject::class, $test->ID);
86
87			$this->assertNotEquals($test->ScheduledJobID, $jobId);
88			$this->assertEquals('EXECUTED', $test->Message);
89
90			$job = $test->ScheduledJob();
91
92			// should reschedule in 1 minute time
93			$expectedMinutes = date('i', time());
94			$expectedMinutes = intval($expectedMinutes, 10);
95			if ($expectedMinutes + 1 > 59) { // Wrap around the hour
96			$expectedMinutes = $expectedMinutes - 59;
97			}
98			$scheduledMinutes = substr($job->StartAfter, 14, 2);
99			$scheduledMinutes = intval($scheduledMinutes, 10);
100
101			$this->assertEquals($expectedMinutes + 1, $scheduledMinutes, 'Did not reschedule 1 minute later');
102
103			// test a custom interval of 3 minutes
104
105			$test->ExecuteInterval = 3;
106			$test->write();
107
108			$job = $test->ScheduledJob();
109			$job->execute();
110
111			$test = DataObject::get_by_id(TestScheduledDataObject::class, $test->ID);
112
113			$job = $test->ScheduledJob();
114
115			// should reschedule in 3 minutes time
116			$expectedMinutes = date('i', time());
117			$expectedMinutes = intval($expectedMinutes, 10);
118			if ($expectedMinutes + 3 > 59) {
119			$expectedMinutes = $expectedMinutes - 59;
120			}
121			$scheduledMinutes = substr($job->StartAfter, 14, 2);
122			$scheduledMinutes = intval($scheduledMinutes, 10);
123
124			$this->assertEquals($expectedMinutes + 3, $scheduledMinutes, 'Did not reschedule 3 minutes later');
125			}
126			}
127

silverstripe-australia / silverstripe-queuedjobs

testScheduledExecutionInterval() A last analyzed 2017-06-30 01:57 UTC

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like

testScheduledExecutionInterval() A
last analyzed 2017-06-30 01:57 UTC