Issues (113)

lib/Elements/Time.php (3 issues)

1
<?php
2
/**
3
 * The MIT License
4
 *
5
 * Copyright 2016 julien.
6
 *
7
 * Permission is hereby granted, free of charge, to any person obtaining a copy
8
 * of this software and associated documentation files (the "Software"), to deal
9
 * in the Software without restriction, including without limitation the rights
10
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11
 * copies of the Software, and to permit persons to whom the Software is
12
 * furnished to do so, subject to the following conditions:
13
 *
14
 * The above copyright notice and this permission notice shall be included in
15
 * all copies or substantial portions of the Software.
16
 *
17
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19
 * FITNESS FOR A PARTICULAR PURPOSE AND NON INFRINGEMENT. IN NO EVENT SHALL THE
20
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
23
 * THE SOFTWARE.
24
 */
25
26
namespace i3Soft\CDA\Elements;
27
28
use i3Soft\CDA\DataType\Collection\Interval\IntervalOfTime;
29
use i3Soft\CDA\DataType\Collection\Interval\PeriodicIntervalOfTime;
30
use i3Soft\CDA\DataType\Quantity\DateAndTime\TimeStamp;
31
32
/**
33
 * @author julien
34
 */
35
class Time extends AbstractElement
36
{
37
  /**
38
   *
39
   * @var TimeStamp
40
   */
41
  protected $time;
42
43
  /**
44
   * Time constructor.
45
   *
46
   * @param null $time
0 ignored issues
show
Documentation Bug introduced by
Are you sure the doc-type for parameter $time is correct as it would always require null to be passed?
Loading history...
47
   */
48
  public function __construct ($time)
49
  {
50
    $this->setTime($time);
51
  }
52
53
  /**
54
   * @return TimeStamp|IntervalOfTime
55
   */
56
  public function getTime ()
57
  {
58
    return $this->time;
59
  }
60
61
  /**
62
   * @param TimeStamp|IntervalOfTime $in
63
   *
64
   * @return self
65
   */
66
  public function setTime ($in): self
67
  {
68
    if ($in instanceof TimeStamp || $in instanceof IntervalOfTime || $in instanceof PeriodicIntervalOfTime)
0 ignored issues
show
$in is always a sub-type of i3Soft\CDA\DataType\Coll...Interval\IntervalOfTime.
Loading history...
69
    {
70
      $this->time = $in;
0 ignored issues
show
Documentation Bug introduced by
It seems like $in can also be of type i3Soft\CDA\DataType\Coll...Interval\IntervalOfTime. However, the property $time is declared as type i3Soft\CDA\DataType\Quantity\DateAndTime\TimeStamp. Maybe add an additional type check?

Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly.

For example, imagine you have a variable $accountId that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the id property of an instance of the Account class. This class holds a proper account, so the id value must no longer be false.

Either this assignment is in error or a type check should be added for that assignment.

class Id
{
    public $id;

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

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
Loading history...
71
    }
72
    return $this;
73
  }
74
75
  /**
76
   * @param \DOMDocument $doc
77
   *
78
   * @return \DOMElement
79
   */
80
  public function toDOMElement (\DOMDocument $doc): \DOMElement
81
  {
82
    return $this->createElement($doc, array('time'));
83
  }
84
85
  /**
86
   * @return string
87
   */
88
  protected function getElementTag (): string
89
  {
90
    return 'time';
91
  }
92
}
93