Completed
Pull Request — master (#37)
by
unknown
02:11
created

Check::getTable()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 4
Code Lines 2

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
dl 0
loc 4
rs 10
c 0
b 0
f 0
cc 1
eloc 2
nc 1
nop 0
1
<?php
2
3
namespace Spatie\ServerMonitor\Models;
4
5
use Carbon\Carbon;
6
use Symfony\Component\Process\Process;
7
use Illuminate\Database\Eloquent\Model;
8
use Illuminate\Database\Eloquent\Builder;
9
use Spatie\ServerMonitor\Events\CheckRestored;
10
use Spatie\ServerMonitor\Models\Enums\CheckStatus;
11
use Spatie\ServerMonitor\Models\Concerns\HasProcess;
12
use Illuminate\Database\Eloquent\Relations\BelongsTo;
13
use Spatie\ServerMonitor\CheckDefinitions\CheckDefinition;
14
use Spatie\ServerMonitor\Models\Presenters\CheckPresenter;
15
use Spatie\ServerMonitor\Exceptions\InvalidCheckDefinition;
16
use Spatie\ServerMonitor\Models\Concerns\HandlesCheckResult;
17
use Spatie\ServerMonitor\Models\Concerns\HasCustomProperties;
18
use Spatie\ServerMonitor\Models\Concerns\ThrottlesFailingNotifications;
19
20
class Check extends Model
21
{
22
    use CheckPresenter,
23
        HasCustomProperties,
24
        ThrottlesFailingNotifications,
25
        HasProcess,
26
        HandlesCheckResult;
27
28
    public $guarded = [];
29
30
    public $casts = [
31
        'custom_properties' => 'array',
32
        'last_run_output' => 'array',
33
    ];
34
35
    public $dates = [
36
        'last_ran_at', 'next_check_at', 'started_throttling_failing_notifications_at',
37
    ];
38
39
    public function getTable(): String
40
    {
41
        return config('server-monitor.checks_table');
42
    }
43
44
    public function host(): BelongsTo
45
    {
46
        return $this->belongsTo(Host::class);
47
    }
48
49
    public function scopeHealthy($query)
50
    {
51
        return $query->where('status', CheckStatus::SUCCESS);
52
    }
53
54
    public function scopeUnhealthy($query)
55
    {
56
        return $query->where('status', '!=', CheckStatus::SUCCESS);
57
    }
58
59
    public function scopeEnabled(Builder $query)
60
    {
61
        $query->where('enabled', 1);
62
    }
63
64
    public function shouldRun(): bool
65
    {
66
        if (! $this->enabled) {
0 ignored issues
show
Documentation introduced by
The property enabled does not exist on object<Spatie\ServerMonitor\Models\Check>. 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...
67
            return false;
68
        }
69
70
        if (is_null($this->last_ran_at)) {
0 ignored issues
show
Documentation introduced by
The property last_ran_at does not exist on object<Spatie\ServerMonitor\Models\Check>. 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
            return true;
72
        }
73
74
        return ! $this->last_ran_at
0 ignored issues
show
Documentation introduced by
The property last_ran_at does not exist on object<Spatie\ServerMonitor\Models\Check>. 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...
75
            ->addMinutes($this->next_run_in_minutes)
0 ignored issues
show
Documentation introduced by
The property next_run_in_minutes does not exist on object<Spatie\ServerMonitor\Models\Check>. 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...
76
            ->isFuture();
77
    }
78
79
    public function getDefinition(): CheckDefinition
80
    {
81
        if (! $definitionClass = config("server-monitor.checks.{$this->type}")) {
0 ignored issues
show
Documentation introduced by
The property type does not exist on object<Spatie\ServerMonitor\Models\Check>. 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...
82
            throw InvalidCheckDefinition::unknownCheckType($this);
83
        }
84
85
        if (! class_exists($definitionClass)) {
86
            throw InvalidCheckDefinition::definitionClassDoesNotExist($this, $definitionClass);
87
        }
88
89
        return app($definitionClass)->setCheck($this);
90
    }
91
92
    public function handleFinishedProcess()
93
    {
94
        $originalStatus = $this->status;
0 ignored issues
show
Documentation introduced by
The property status does not exist on object<Spatie\ServerMonitor\Models\Check>. 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...
95
96
        $this->getDefinition()->determineResult($this->getProcess());
97
98
        $this->scheduleNextRun();
99
100
        if ($this->shouldFireRestoredEvent($originalStatus, $this->status)) {
0 ignored issues
show
Documentation introduced by
The property status does not exist on object<Spatie\ServerMonitor\Models\Check>. 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...
101
            event(new CheckRestored($this));
102
        }
103
104
        return $this;
105
    }
106
107
    protected function shouldFireRestoredEvent(?string $originalStatus, ?string $newStatus)
108
    {
109
        if (! in_array($originalStatus, [CheckStatus::FAILED, CheckStatus::WARNING])) {
110
            return false;
111
        }
112
113
        return $newStatus === CheckStatus::SUCCESS;
114
    }
115
116
    protected function scheduleNextRun()
117
    {
118
        $this->last_ran_at = Carbon::now();
0 ignored issues
show
Documentation introduced by
The property last_ran_at does not exist on object<Spatie\ServerMonitor\Models\Check>. 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...
119
120
        $this->next_run_in_minutes = $this->getDefinition()->performNextRunInMinutes();
0 ignored issues
show
Documentation introduced by
The property next_run_in_minutes does not exist on object<Spatie\ServerMonitor\Models\Check>. 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...
121
        $this->save();
122
123
        return $this;
124
    }
125
126
    public function hasStatus(string $status): bool
127
    {
128
        return $this->status === $status;
0 ignored issues
show
Documentation introduced by
The property status does not exist on object<Spatie\ServerMonitor\Models\Check>. 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...
129
    }
130
131
    public function storeProcessOutput(Process $process)
132
    {
133
        $this->last_run_output = [
0 ignored issues
show
Documentation introduced by
The property last_run_output does not exist on object<Spatie\ServerMonitor\Models\Check>. 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...
134
            'output' => $process->getOutput(),
135
            'error_output' => $process->getErrorOutput(),
136
            'exit_code' => $process->getExitCode(),
137
            'exit_code_text' => $process->getExitCodeText(),
138
        ];
139
140
        $this->save();
141
    }
142
}
143