SimpleJobsDailyTask - Code Metrics - lekoala/silverstripe-simple-jobs - Measure and Improve Code Quality continuously with Scrutinizer

SimpleJobsDailyTask A
last analyzed 2025-03-13 12:09 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	83
Duplicated Lines	0 %

Importance

Changes

Metric	Value
eloc	25
dl	0
loc	83
rs	10
c	0
b	0
f	0
wmc	11

8 Methods

Rating	Name	Size	Complexity
A	getJobRecords()	3	1
A	getJobTitle()	3	1
A	process()	10	2
A	getSchedule()	3	1
A	getJobCategory()	3	1
A	getJobDescription()	3	1
A	IsDisabled()	8	3
A	getExpiredSessions()	13	1

<?php

namespace LeKoala\SimpleJobs;

use SilverStripe\ORM\DataList;
use SilverStripe\Core\Config\Configurable;
use SilverStripe\ORM\FieldType\DBDatetime;
use SilverStripe\CronTask\Interfaces\CronTask;
use SilverStripe\SessionManager\Models\LoginSession;

/**
 */
class SimpleJobsDailyTask implements CronTask, SimpleJobsDescription
{
    use Configurable;

    public static function getJobTitle(): string
    {
        return 'Session collection service';
    }

    public static function getJobCategory(): string
    {
        return SimpleJobsDescription::SYSTEM;
    }

    public static function getJobDescription(): string
    {
        return 'Collects expired session in the database';
    }

    /**
     * Logic extracted roughly from GarbageCollectionService that doesn't expose what it collects
     * so we need to run our own query
     */
    protected static function getExpiredSessions(): DataList
    {
        $maxAge = LoginSession::getMaxAge();
        $nowTs = DBDatetime::now()->getTimestamp();
        $now = date('Y-m-d H:i:s', $nowTs);

        $case1 = "(LastAccessed < '$maxAge' AND Persistent = 0)";
        $case2 = "(Persistent = 1 AND RememberLoginHash.ExpiryDate < '$now')";
        $case3 = "(LastAccessed < '$maxAge' AND Persistent = 1 AND RememberLoginHash.ExpiryDate IS NULL)";

        $list = LoginSession::get()->leftJoin('RememberLoginHash', 'RememberLoginHash.LoginSessionID = LoginSession.ID');
        $list = $list->where("$case1 OR $case2 OR $case3");
        return $list;
    }

    public static function getJobRecords(): ?DataList
    {
        return null;

        //@link https://github.com/silverstripe/silverstripe-session-manager/issues/178
        // return self::getExpiredSessions();
    }

    /**
     * Return a string for a CRON expression. If a "falsy" value is returned, the CronTaskController will assume the
     * CronTask is disabled.
     *
     * @return string
     */
    public function getSchedule()
    {
        return SimpleJobsSchedules::EVERY_DAY;
    }

    public static function IsDisabled(): bool
    {
        $config = static::config();
        $sessionGarbageCollector = \SilverStripe\SessionManager\Services\GarbageCollectionService::class;
        if (class_exists($sessionGarbageCollector) && $config->clean_sessions) {
            return false;
        }
        return true;
    }

    /**
     * When this script is supposed to run the CronTaskController will execute
     * process().
     *
     * @return mixed
     */
    public function process()
    {
        if (self::IsDisabled()) {
            return 'disabled';
interface HasName {
    /** @return string */
    public function getName();
}

class Name {
    public $name;
}

class User implements HasName {
    /** @return string|Name */
    public function getName() {
        return new Name('foo'); // This is a violation of the ``HasName`` interface
                                // which only allows a string value to be returned.
    }
}
        }

        // Hard to know what this will be doing
        // @link https://github.com/silverstripe/silverstripe-session-manager/issues/160
        \SilverStripe\SessionManager\Services\GarbageCollectionService::singleton()->collect();
        return 'done';
interface HasName {
    /** @return string */
    public function getName();
}

class Name {
    public $name;
}

class User implements HasName {
    /** @return string|Name */
    public function getName() {
        return new Name('foo'); // This is a violation of the ``HasName`` interface
                                // which only allows a string value to be returned.
    }
}
    }
}


1			<?php
2
3			namespace LeKoala\SimpleJobs;
4
5			use SilverStripe\ORM\DataList;
6			use SilverStripe\Core\Config\Configurable;
7			use SilverStripe\ORM\FieldType\DBDatetime;
8			use SilverStripe\CronTask\Interfaces\CronTask;
9			use SilverStripe\SessionManager\Models\LoginSession;
10
11			/**
12			*/
13			class SimpleJobsDailyTask implements CronTask, SimpleJobsDescription
14			{
15			use Configurable;
16
17			public static function getJobTitle(): string
18			{
19			return 'Session collection service';
20			}
21
22			public static function getJobCategory(): string
23			{
24			return SimpleJobsDescription::SYSTEM;
25			}
26
27			public static function getJobDescription(): string
28			{
29			return 'Collects expired session in the database';
30			}
31
32			/**
33			* Logic extracted roughly from GarbageCollectionService that doesn't expose what it collects
34			* so we need to run our own query
35			*/
36			protected static function getExpiredSessions(): DataList
37			{
38			$maxAge = LoginSession::getMaxAge();
39			$nowTs = DBDatetime::now()->getTimestamp();
40			$now = date('Y-m-d H:i:s', $nowTs);
41
42			$case1 = "(LastAccessed < '$maxAge' AND Persistent = 0)";
43			$case2 = "(Persistent = 1 AND RememberLoginHash.ExpiryDate < '$now')";
44			$case3 = "(LastAccessed < '$maxAge' AND Persistent = 1 AND RememberLoginHash.ExpiryDate IS NULL)";
45
46			$list = LoginSession::get()->leftJoin('RememberLoginHash', 'RememberLoginHash.LoginSessionID = LoginSession.ID');
47			$list = $list->where("$case1 OR $case2 OR $case3");
48			return $list;
49			}
50
51			public static function getJobRecords(): ?DataList
52			{
53			return null;
54
55			//@link https://github.com/silverstripe/silverstripe-session-manager/issues/178
56			// return self::getExpiredSessions();
57			}
58
59			/**
60			* Return a string for a CRON expression. If a "falsy" value is returned, the CronTaskController will assume the
61			* CronTask is disabled.
62			*
63			* @return string
64			*/
65			public function getSchedule()
66			{
67			return SimpleJobsSchedules::EVERY_DAY;
68			}
69
70			public static function IsDisabled(): bool
71			{
72			$config = static::config();
73			$sessionGarbageCollector = \SilverStripe\SessionManager\Services\GarbageCollectionService::class;
74			if (class_exists($sessionGarbageCollector) && $config->clean_sessions) {
75			return false;
76			}
77			return true;
78			}
79
80			/**
81			* When this script is supposed to run the CronTaskController will execute
82			* process().
83			*
84			* @return mixed
85			*/
86			public function process()
87			{
88			if (self::IsDisabled()) {
89			return 'disabled';
			0 ignored issues – show Bug Best Practice introduced 2024-01-26 15:56 UTC by Report Bug Copy Issue Report The expression `return 'disabled'` returns the type `string` which is incompatible with the return type mandated by `SilverStripe\CronTask\In...ces\CronTask::process()` of `void`. In the issue above, the returned value is violating the contract defined by the mentioned interface. Let's take a look at an example: interface HasName { /** @return string / public function getName(); } class Name { public $name; } class User implements HasName { /* @return string\|Name */ public function getName() { return new Name('foo'); // This is a violation of the ``HasName`` interface // which only allows a string value to be returned. } } Loading history...
90			}
91
92			// Hard to know what this will be doing
93			// @link https://github.com/silverstripe/silverstripe-session-manager/issues/160
94			\SilverStripe\SessionManager\Services\GarbageCollectionService::singleton()->collect();
95			return 'done';
			0 ignored issues – show Bug Best Practice introduced 2024-01-26 15:56 UTC by Report Bug Copy Issue Report The expression `return 'done'` returns the type `string` which is incompatible with the return type mandated by `SilverStripe\CronTask\In...ces\CronTask::process()` of `void`. In the issue above, the returned value is violating the contract defined by the mentioned interface. Let's take a look at an example: interface HasName { /** @return string / public function getName(); } class Name { public $name; } class User implements HasName { /* @return string\|Name */ public function getName() { return new Name('foo'); // This is a violation of the ``HasName`` interface // which only allows a string value to be returned. } } Loading history...
96			}
97			}
98

lekoala / silverstripe-simple-jobs

SimpleJobsDailyTask A last analyzed 2025-03-13 12:09 UTC

Complexity

Size/Duplication

Importance

8 Methods

Duplication Side-by-Side

Filter issues like

SimpleJobsDailyTask A
last analyzed 2025-03-13 12:09 UTC