Models: Fix phpDoc

Icinga · Jul 4, 2024 · dfc17ee · dfc17ee
1 parent 3432958
commit dfc17ee
Show file tree

Hide file tree

Showing 16 changed files with 62 additions and 57 deletions.
diff --git a/library/Notifications/Model/AvailableChannelType.php b/library/Notifications/Model/AvailableChannelType.php
@@ -12,7 +12,7 @@
  * @property string $type
  * @property string $name
  * @property string $version
- * @property string $author_name
+ * @property string $author
  * @property string $config_attrs
  *
  * @property Query|Channel $channel
@@ -34,7 +34,7 @@ public function getColumns(): array
         return [
             'name',
             'version',
-            'author_name',
+            'author',
             'config_attrs',
         ];
     }

diff --git a/library/Notifications/Model/Channel.php b/library/Notifications/Model/Channel.php
@@ -19,7 +19,7 @@
  * @property int $id
  * @property string $name
  * @property string $type
- * @property string $config
+ * @property ?string $config
  * @property DateTime $changed_at
  * @property bool $deleted
  *

diff --git a/library/Notifications/Model/Contact.php b/library/Notifications/Model/Contact.php
@@ -18,7 +18,6 @@
  * @property string $full_name
  * @property ?string $username
  * @property int $default_channel_id
- * @property string $color
  * @property DateTime $changed_at
  * @property bool $deleted
  *
@@ -29,6 +28,8 @@
  * @property Query|RotationMember $rotation_member
  * @property Query|ContactAddress $contact_address
  * @property Query|RuleEscalationRecipient $rule_escalation_recipient
+ * @property Query|ContactgroupMember $contactgroup_member
+ * @property Query|Contactgroup $contactgroup
  */
 class Contact extends Model
 {

diff --git a/library/Notifications/Model/Contactgroup.php b/library/Notifications/Model/Contactgroup.php
@@ -15,14 +15,15 @@
 /**
  * Contact group
  *
- * @property string $id
+ * @property int $id
  * @property string $name
  * @property DateTime $changed_at
  * @property bool $deleted
  *
- * @property Query | Contact $contact
- * @property Query | RuleEscalationRecipient $rule_escalation_recipient
- * @property Query | IncidentHistory $incident_history
+ * @property Query|Contact $contact
+ * @property Query|ContactgroupMember $contactgroup_member
+ * @property Query|RuleEscalationRecipient $rule_escalation_recipient
+ * @property Query|IncidentHistory $incident_history
  */
 class Contactgroup extends Model
 {

diff --git a/library/Notifications/Model/ContactgroupMember.php b/library/Notifications/Model/ContactgroupMember.php
@@ -15,13 +15,13 @@
 /**
  * Contactgroup Member
  *
- * @param string $contactgroup_id
- * @param string $contact_id
+ * @param int $contactgroup_id
+ * @param int $contact_id
  * @param DateTime $changed_at
  * @param bool $deleted
  *
- * @property Query | Contactgroup $contactgroup
- * @property Query | Contact $contact
+ * @property Query|Contactgroup $contactgroup
+ * @property Query|Contact $contact
  */
 class ContactgroupMember extends Model
 {

diff --git a/library/Notifications/Model/Event.php b/library/Notifications/Model/Event.php
@@ -28,9 +28,9 @@
  * @property ?string $message
  * @property ?string $username
  *
- * @property Query | Objects $object
- * @property Query | IncidentHistory $incident_history
- * @property Query | Incident $incident
+ * @property Query|Objects $object
+ * @property Query|IncidentHistory $incident_history
+ * @property Query|Incident $incident
  */
 class Event extends Model
 {

diff --git a/library/Notifications/Model/Incident.php b/library/Notifications/Model/Incident.php
@@ -24,13 +24,13 @@
  * @property ?DateTime $recovered_at
  * @property string $severity
  *
- * @property Query | Objects $object
- * @property Query | Event $event
- * @property Query | Contact $contact
- * @property Query | IncidentContact $incident_contact
- * @property Query | IncidentHistory $incident_history
- * @property Query | Rule $rule
- * @property Query | RuleEscalation $rule_escalation
+ * @property Query|Objects $object
+ * @property Query|Event $event
+ * @property Query|Contact $contact
+ * @property Query|IncidentContact $incident_contact
+ * @property Query|IncidentHistory $incident_history
+ * @property Query|Rule $rule
+ * @property Query|RuleEscalation $rule_escalation
  */
 class Incident extends Model
 {

diff --git a/library/Notifications/Model/IncidentContact.php b/library/Notifications/Model/IncidentContact.php
@@ -10,7 +10,7 @@
 
 /**
  * @property int $incident_id
- * @property int $contact_id
+ * @property ?int $contact_id
  * @property string $role
  *
  * @property Query|Incident $incident

diff --git a/library/Notifications/Model/IncidentHistory.php b/library/Notifications/Model/IncidentHistory.php
@@ -25,23 +25,25 @@
  * @property DateTime $time
  * @property string $type
  * @property ?int $contact_id
+ * @property ?int $schedule_id
+ * @property ?int $contactgroup_id
  * @property ?int $channel_id
  * @property ?string $new_severity
  * @property ?string $old_severity
  * @property ?string $new_recipient_role
  * @property ?string $old_recipient_role
  * @property ?string $message
- * @property string $notification_state
- * @property DateTime $sent_at
+ * @property ?string $notification_state
+ * @property ?DateTime $sent_at
  *
- * @property Query | Incident $incident
- * @property Query | Event $event
- * @property Query | Contact $contact
- * @property Query | Contactgroup $contactgroup
- * @property Query | Schedule $schedule
- * @property Query | Rule $rule
- * @property Query | RuleEscalation $rule_escalation
- * @property Query | Channel $channel
+ * @property Query|Incident $incident
+ * @property Query|Event $event
+ * @property Query|Contact $contact
+ * @property Query|Contactgroup $contactgroup
+ * @property Query|Schedule $schedule
+ * @property Query|Rule $rule
+ * @property Query|RuleEscalation $rule_escalation
+ * @property Query|Channel $channel
  */
 class IncidentHistory extends Model
 {

diff --git a/library/Notifications/Model/Objects.php b/library/Notifications/Model/Objects.php
@@ -19,16 +19,14 @@
  * @property string $id
  * @property int $source_id
  * @property string $name
- * @property string $host
- * @property ?string $service
  * @property ?string $url
  *
- * @property Query | Event $event
- * @property Query | Incident $incident
- * @property Query | Tag $tag
- * @property Query | ObjectExtraTag $object_extra_tag
- * @property Query | ExtraTag $extra_tag
- * @property Query | Source $source
+ * @property Query|Event $event
+ * @property Query|Incident $incident
+ * @property Query|Tag $tag
+ * @property Query|ObjectExtraTag $object_extra_tag
+ * @property Query|ExtraTag $extra_tag
+ * @property Query|Source $source
  * @property array<string, string> $id_tags
  */
 class Objects extends Model

diff --git a/library/Notifications/Model/Rotation.php b/library/Notifications/Model/Rotation.php
@@ -19,7 +19,7 @@
  *
  * @property int $id
  * @property int $schedule_id
- * @property int $priority
+ * @property ?int $priority
  * @property string $name
  * @property string $mode
  * @property string|array $options

diff --git a/library/Notifications/Model/RotationMember.php b/library/Notifications/Model/RotationMember.php
@@ -19,7 +19,7 @@
  * @property int $rotation_id
  * @property ?int $contact_id
  * @property ?int $contactgroup_id
- * @property int $position
+ * @property ?int $position
  * @property DateTime $changed_at
  * @property bool $deleted
  *

diff --git a/library/Notifications/Model/Rule.php b/library/Notifications/Model/Rule.php
@@ -15,7 +15,7 @@
 /**
  * @property int $id
  * @property string $name
- * @property int $timeperiod_id
+ * @property ?int $timeperiod_id
  * @property ?string $object_filter
  * @property string $is_active
  * @property DateTime $changed_at

diff --git a/library/Notifications/Model/RuleEscalation.php b/library/Notifications/Model/RuleEscalation.php
@@ -9,23 +9,24 @@
 use ipl\Orm\Behavior\MillisecondTimestamp;
 use ipl\Orm\Behaviors;
 use ipl\Orm\Model;
+use ipl\Orm\Query;
 use ipl\Orm\Relations;
 
 /**
  * @property int $id
  * @property int $rule_id
- * @property int $position
+ * @property ?int $position
  * @property ?string $condition
  * @property ?string $name
  * @property ?string $fallback_for
  * @property DateTime $changed_at
  * @property bool $deleted
  *
- * @property Rule $rule
- * @property Incident $incident
- * @property Contact $contact
- * @property RuleEscalationRecipient $rule_escalation_recipient
- * @property IncidentHistory $incident_history
+ * @property Query|Rule $rule
+ * @property Query|Incident $incident
+ * @property Query|Contact $contact
+ * @property Query|RuleEscalationRecipient $rule_escalation_recipient
+ * @property Query|IncidentHistory $incident_history
  */
 class RuleEscalation extends Model
 {

diff --git a/library/Notifications/Model/RuleEscalationRecipient.php b/library/Notifications/Model/RuleEscalationRecipient.php
@@ -16,10 +16,12 @@
 /**
  * @property int $id
  * @property int $rule_escalation_id
- * @property int $contact_id
- * @property int $contactgroup_id
- * @property int $schedule_id
- * @property int $channel_id
+ * @property ?int $contact_id
+ * @property ?int $contactgroup_id
+ * @property ?int $schedule_id
+ * @property ?int $channel_id
+ * @property string $tag
+ * @property string $value
  * @property DateTime $changed_at
  * @property bool $deleted
  *

diff --git a/library/Notifications/Model/Schedule.php b/library/Notifications/Model/Schedule.php
@@ -18,9 +18,9 @@
  * @property DateTime $changed_at
  * @property bool $deleted
  *
- * @property Rotation|Query $rotation
- * @property RuleEscalationRecipient|Query $rule_escalation_recipient
- * @property IncidentHistory|Query $incident_history
+ * @property Query|Rotation $rotation
+ * @property Query|RuleEscalationRecipient $rule_escalation_recipient
+ * @property Query|IncidentHistory $incident_history
  */
 class Schedule extends Model
 {