Backup_Status - Code Metrics - Inspection of "The Great Backup Refactor of 2015" - humanmade/backupwordpress - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#936)

by Tom

created 2015-12-02 00:23 UTC

Backup_Status A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	113
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes	5
Bugs	0	Features	1

Metric	Value
wmc	18
c	5
b	0
f	1
lcom	1
cbo	1
dl	0
loc	113
rs	10

9 Methods

Rating	Name	Size	Complexity
A	__construct()	3	1
A	start()	4	1
A	get_backup_filename()	12	3
A	is_started()	3	1
A	finish()	6	2
A	get_status()	15	3
A	set_status()	16	2
A	get_start_time()	15	4
A	get_status_filepath()	3	1

<?php

namespace HM\BackUpWordPress;

/**
 * Manages status and progress of a backup
 */
class Backup_Status {

    private $filename = '';

    public function __construct( $id ) {
        $this->id = $id;
class MyClass { }

$x = new MyClass();
$x->foo = true;
    }

    public function start( $backup_filename, $status_message ) {
        $this->filename = $backup_filename;
        $this->set_status( $status_message );
    }

    public function get_backup_filename() {


        if ( $this->is_started() ) {
            $status = json_decode( file_get_contents( $this->get_status_filepath() ) );

            if ( ! empty( $status->filename ) ) {
                $this->filename = $status->filename;
            }
        }

        return $this->filename;
    }

    public function is_started() {
        return (bool) file_exists( $this->get_status_filepath() );
    }

    public function finish() {
        // Delete the backup running file
        if ( file_exists( $this->get_status_filepath() ) ) {
            unlink( $this->get_status_filepath() );
        }
    }

    /**
     * Get the status of the running backup.
     *
     * @return string
     */
    public function get_status() {

        if ( ! file_exists( $this->get_status_filepath() ) ) {
            return '';
        }

        $status = json_decode( file_get_contents( $this->get_status_filepath() ) );

        if ( ! empty( $status->status ) ) {
            return $status->status;
        }

        return '';

    }

    /**
     * Set the status of the running backup
     *
     * @param string $message
     *
     * @return null

     */
    public function set_status( $message ) {

        // If start hasn't been called yet then we wont' have a backup filename
        if ( ! $this->filename ) {
            return '';
        }

        $status = json_encode( (object) array(
            'filename' => $this->filename,
            'started'  => $this->get_start_time(),
            'status'   => $message,
        ) );

        file_put_contents( $this->get_status_filepath(), $status );

    }

    /**
     * Get the time that the current running backup was started
     *
     * @return int $timestamp
     */
    public function get_start_time() {

        if ( ! file_exists( $this->get_status_filepath() ) ) {
            return 0;
        }

        $status = json_decode( file_get_contents( $this->get_status_filepath() ) );

        if ( ! empty( $status->started ) && (int) (string) $status->started === $status->started ) {
            return $status->started;
        }

        return time();

    }

    /**
     * Get the path to the backup running file that stores the running backup status
     *
     * @return string
     */
    public function get_status_filepath() {
    	return Path::get_path() . '/.backup-' . $this->id . '-running';
    }

}


1			<?php
2
3			namespace HM\BackUpWordPress;
4
5			/**
6			* Manages status and progress of a backup
7			*/
8			class Backup_Status {
9
10			private $filename = '';
11
12			public function __construct( $id ) {
13			$this->id = $id;
			0 ignored issues – show Bug introduced 2015-11-30 00:15 UTC by Report Bug Copy Issue Report The property `id` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
14			}
15
16			public function start( $backup_filename, $status_message ) {
17			$this->filename = $backup_filename;
18			$this->set_status( $status_message );
19			}
20
21			public function get_backup_filename() {
			0 ignored issues – show Documentation introduced 2015-11-30 00:15 UTC by Report Bug Copy Issue Report 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...
22
23			if ( $this->is_started() ) {
24			$status = json_decode( file_get_contents( $this->get_status_filepath() ) );
25
26			if ( ! empty( $status->filename ) ) {
27			$this->filename = $status->filename;
28			}
29			}
30
31			return $this->filename;
32			}
33
34			public function is_started() {
35			return (bool) file_exists( $this->get_status_filepath() );
36			}
37
38			public function finish() {
39			// Delete the backup running file
40			if ( file_exists( $this->get_status_filepath() ) ) {
41			unlink( $this->get_status_filepath() );
42			}
43			}
44
45			/**
46			* Get the status of the running backup.
47			*
48			* @return string
49			*/
50			public function get_status() {
51
52			if ( ! file_exists( $this->get_status_filepath() ) ) {
53			return '';
54			}
55
56			$status = json_decode( file_get_contents( $this->get_status_filepath() ) );
57
58			if ( ! empty( $status->status ) ) {
59			return $status->status;
60			}
61
62			return '';
63
64			}
65
66			/**
67			* Set the status of the running backup
68			*
69			* @param string $message
70			*
71			* @return null
			0 ignored issues – show Documentation introduced 2015-12-02 00:26 UTC by Report Bug Copy Issue Report Should the return type not be `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...
72			*/
73			public function set_status( $message ) {
74
75			// If start hasn't been called yet then we wont' have a backup filename
76			if ( ! $this->filename ) {
77			return '';
78			}
79
80			$status = json_encode( (object) array(
81			'filename' => $this->filename,
82			'started' => $this->get_start_time(),
83			'status' => $message,
84			) );
85
86			file_put_contents( $this->get_status_filepath(), $status );
87
88			}
89
90			/**
91			* Get the time that the current running backup was started
92			*
93			* @return int $timestamp
94			*/
95			public function get_start_time() {
96
97			if ( ! file_exists( $this->get_status_filepath() ) ) {
98			return 0;
99			}
100
101			$status = json_decode( file_get_contents( $this->get_status_filepath() ) );
102
103			if ( ! empty( $status->started ) && (int) (string) $status->started === $status->started ) {
104			return $status->started;
105			}
106
107			return time();
108
109			}
110
111			/**
112			* Get the path to the backup running file that stores the running backup status
113			*
114			* @return string
115			*/
116			public function get_status_filepath() {
117			return Path::get_path() . '/.backup-' . $this->id . '-running';
118			}
119
120			}
121

humanmade / backupwordpress

GitHub Access Token became invalid

Pull Request — master (#936)

Backup_Status A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

9 Methods

Duplication Side-by-Side

Filter issues like