cleanup_task::get_name() - Code Metrics - danielneis/moodle-logstore_fluentd - Measure and Improve Code Quality continuously with Scrutinizer

cleanup_task::get_name() A
last analyzed 2017-06-19 21:46 UTC

↳ Parent: cleanup_task

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	3
rs	10
c	0
b	0
f	0
cc	1
eloc	2
nc	1
nop	0

<?php

// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.

/**
 * Template log reader/writer.
 *
 * @package    logstore_fluentd
 * @copyright  2015 Daniel Neis (based on standard log store from Petr Skoda)
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */

namespace logstore_fluentd\task;

defined('MOODLE_INTERNAL') || die();

class cleanup_task extends \core\task\scheduled_task {

    /**
     * Get a descriptive name for this task (shown to admins).
     *
     * @return string
     */
    public function get_name() {
        return get_string('taskcleanup', 'logstore_fluentd');
    }

    /**
     * Do the job.
     * Throw exceptions on errors (the job will be retried).
     */
    public function execute() {
        global $DB;
function myFunction($a, $b) {
    // Do something
}

        $loglifetime = (int)get_config('logstore_fluentd', 'loglifetime');

        if (empty($loglifetime) || $loglifetime < 0) {
            return;
        }

        $loglifetime = time() - ($loglifetime * 3600 * 24); // Value in days.
        $lifetimep = array($loglifetime);
        $start = time();

        while ($min = $DB->get_field_select("logstore_fluentd_log", "MIN(timecreated)", "timecreated < ?", $lifetimep)) {
            // Break this down into chunks to avoid transaction for too long and generally thrashing database.
            // Experiments suggest deleting one day takes up to a few seconds; probably a reasonable chunk size usually.
            // If the cleanup has just been enabled, it might take e.g a month to clean the years of logs.
            $params = array(min($min + 3600 * 24, $loglifetime));
            $DB->delete_records_select("logstore_fluentd_log", "timecreated < ?", $params);
            if (time() > $start + 300) {
                // Do not churn on log deletion for too long each run.
                break;
            }
        }

        mtrace(" Deleted old log records from fluentd store.");
    }
}


cleanup_task::get_name() A
last analyzed 2017-06-19 21:46 UTC

Complexity

Size

Duplication

Importance

1. Pass all data via parameters

2. Create a class that maintains your state

1			<?php
			0 ignored issues – show Coding Style Compatibility introduced 2016-04-03 16:44 UTC by Report Bug Copy Issue Report For compatibility and reusability of your code, PSR1 recommends that a file should introduce either new symbols (like classes, functions, etc.) or have side-effects (like outputting something, or including other files), but not both at the same time. The first symbol is defined on line 29 and the first side effect is on line 27. The PSR-1: Basic Coding Standard recommends that a file should either introduce new symbols, that is classes, functions, constants or similar, or have side effects. Side effects are anything that executes logic, like for example printing output, changing ini settings or writing to a file. The idea behind this recommendation is that merely auto-loading a class should not change the state of an application. It also promotes a cleaner style of programming and makes your code less prone to errors, because the logic is not spread out all over the place. To learn more about the PSR-1, please see the PHP-FIG site on the PSR-1. Loading history...
2			// This file is part of Moodle - http://moodle.org/
3			//
4			// Moodle is free software: you can redistribute it and/or modify
5			// it under the terms of the GNU General Public License as published by
6			// the Free Software Foundation, either version 3 of the License, or
7			// (at your option) any later version.
8			//
9			// Moodle is distributed in the hope that it will be useful,
10			// but WITHOUT ANY WARRANTY; without even the implied warranty of
11			// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12			// GNU General Public License for more details.
13			//
14			// You should have received a copy of the GNU General Public License
15			// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
16
17			/**
18			* Template log reader/writer.
19			*
20			* @package logstore_fluentd
21			* @copyright 2015 Daniel Neis (based on standard log store from Petr Skoda)
22			* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23			*/
24
25			namespace logstore_fluentd\task;
26
27			defined('MOODLE_INTERNAL') \|\| die();
28
29			class cleanup_task extends \core\task\scheduled_task {
30
31			/**
32			* Get a descriptive name for this task (shown to admins).
33			*
34			* @return string
35			*/
36			public function get_name() {
37			return get_string('taskcleanup', 'logstore_fluentd');
38			}
39
40			/**
41			* Do the job.
42			* Throw exceptions on errors (the job will be retried).
43			*/
44			public function execute() {
45			global $DB;
			0 ignored issues – show Compatibility Best Practice introduced 2015-12-03 18:13 UTC by Report Bug Copy Issue Report Use of `global` functionality is not recommended; it makes your code harder to test, and less reusable. Instead of relying on `global` state, we recommend one of these alternatives: 1. Pass all data via parameters function myFunction($a, $b) { // Do something } 2. Create a class that maintains your state class MyClass { private $a; private $b; public function __construct($a, $b) { $this->a = $a; $this->b = $b; } public function myFunction() { // Do something } } Loading history...
46
47			$loglifetime = (int)get_config('logstore_fluentd', 'loglifetime');
48
49			if (empty($loglifetime) \|\| $loglifetime < 0) {
50			return;
51			}
52
53			$loglifetime = time() - ($loglifetime * 3600 * 24); // Value in days.
54			$lifetimep = array($loglifetime);
55			$start = time();
56
57			while ($min = $DB->get_field_select("logstore_fluentd_log", "MIN(timecreated)", "timecreated < ?", $lifetimep)) {
58			// Break this down into chunks to avoid transaction for too long and generally thrashing database.
59			// Experiments suggest deleting one day takes up to a few seconds; probably a reasonable chunk size usually.
60			// If the cleanup has just been enabled, it might take e.g a month to clean the years of logs.
61			$params = array(min($min + 3600 * 24, $loglifetime));
62			$DB->delete_records_select("logstore_fluentd_log", "timecreated < ?", $params);
63			if (time() > $start + 300) {
64			// Do not churn on log deletion for too long each run.
65			break;
66			}
67			}
68
69			mtrace(" Deleted old log records from fluentd store.");
70			}
71			}
72

danielneis / moodle-logstore_fluentd

cleanup_task::get_name() A last analyzed 2017-06-19 21:46 UTC

Complexity

Size

Duplication

Importance

1. Pass all data via parameters

2. Create a class that maintains your state

Duplication Side-by-Side

Filter issues like

cleanup_task::get_name() A
last analyzed 2017-06-19 21:46 UTC