1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 <?php
namespace Gedcomx\Util;
/**
* Class representing a fully parsed GedcomX standard date, for the purpose of creating or understanding
* GedcomX formal date strings.
* Format of a GedcomX formal dates are made up by strings of these types:
*
* Simple date:
* (+|-)YYYY[-MM[-DD[Thh[:mm[:ss[(+\-)hh[:mm]|Z]]]]]]
*
* Duration:
* P[yyyyY][mmM][ddD][T[hhH][mmM][ssS]]
*
* Closed date Range:
* [simpleDate]/[simpleDate|Duration]
* Open-ended date range:
* [simpleDate]/
* /[simpleDate]
* Recurring date
* R[repetitions]/simpleDate/(simpleDate|Duration)
* Approximate date or date range
* A(simpleDate)
* A(dateRange)
*
* => ([A](simpleDate|dateRange) | R[repetitions]/simpleDate/(simpleDate|Duration))
* => [A]simpleDate
* [A]simpleDate/[simpleDate|Duration]
* [A]/simpleDate
* R[repetitions]/simpleDate/(simpleDate|Duration)
*
* User: danny yeshurun (ported from Java)
* Date: 6/23/14
* Time: 11:48 PM
*
*/
class FormalDate
{
/**
* Flag for whether this date or range is approximate
* @var bool
*/
private $isApproximate;
/**
* Flag for whether this FormalDate is a range. If true, then a null 'end' and 'duration' indicates an open-ended range.
* @var bool
*/
private $isRange;
/**
* Starting time of a range, or the whole time when not a range.
* @var SimpleDate
*/
private $start;
/**
* End of a range (unless duration is used). Must be null if !isRange or duration is non-null.
* If isRange and duration is null and 'end' is null, then this is an open-ended range.
* @var SimpleDate
*/
private $end;
/**
* Duration of range. Must be null if !isRange or 'end' is non-null.
* @var Duration
*/
private $duration;
/**
* Flag for whether this is a repeating date or not
* @var bool
*/
private $isRecurring;
/**
* number of repetitions. null => no limit.
* @var int
*/
private $numRepetitions;
private static $FORMAL_DATE_PATTERN = "/(A|R([0-9]*)\/)?([^\/]*)(\/([^\/]*))?/";
/**
* Parses a formal date string.
* @param $formalDateString
* @throws \Exception
*/
public function parse($formalDateString)
{
$matches = array();
$status = preg_match(self::$FORMAL_DATE_PATTERN, $formalDateString, $matches);
if ($status === false) {
throw new \Exception("Malformed simple date string {$formalDateString}");
}
// group 1: A or R[numRepetitions]
if (isset($matches[1])) {
if ($matches[1] === "A") {
$this->isApproximate = true;
} elseif (substr($matches[1], 0, 1) === "R") {
$this->isRecurring = true;
// Group 2: numRepetitions
if (isset($matches[2]) && !empty($matches[2])) {
$this->numRepetitions = intval($matches[2]);
}
}
}
// Group 3: starting simpleDate
if (isset($matches[3]) && !empty($matches[3])) {
$this->start = new SimpleDate();
$this->start->parse($matches[3]);
}
// Group 4: "/" and ending simpleDate or duration
if (isset($matches[4])) {
$this->isRange = true;
if (isset($matches[5]) && !empty($matches[5])) {
if (substr($matches[5], 0, 1) === "P") {
if ($this->start === null) {
throw new \Exception("Error: Cannot have duration without a starting date");
}
$this->duration = new Duration();
$this->duration->parse($matches[5]);
} else {
$this->end = new SimpleDate();
$this->end->parse($matches[5]);
}
}
}
}
/**
* Tell whether the current state of the date is valid for a GedcomX formal date.
* In particular, make sure it follows one of the following patterns:
* [A]simpleDate
* [A]simpleDate/[simpleDate|Duration]
* [A]/simpleDate
* R[repetitions]/simpleDate/(simpleDate|Duration)
* @return bool
*/
public function isValid()
{
if ($this->isRecurring) {
return !$this->isApproximate && $this->start !== null && $this->start->isValid() && (($this->end !== null && $this->end->isValid()) || ($this->end === null && $this->duration !== null && $this->duration->isValid()));
} else {
if ($this->numRepetitions !== null) {
return false;
}
if ($this->start !== null && !$this->isRange) {
return $this->end === null && $this->duration === null && $this->start->isValid();
}
if ($this->isRange) {
if ($this->start === null) {
return $this->end !== null && $this->end->isValid() && $this->duration === null;
} else {
return
($this->end === null || $this->duration === null) &&
($this->end === null || $this->end->isValid()) &&
($this->duration === null || $this->duration->isValid());
}
}
}
return false;
}
/**
* Convert a FormalDate to a string
* @return string
*/
public function __toString()
{
$result = array();
if ($this->isRecurring) {
$result[] = "R";
if ($this->numRepetitions !== null) {
$result[] = $this->numRepetitions;
}
$result[] = "/";
} elseif ($this->isApproximate) {
$result[] = "A";
}
if ($this->start !== null) {
$result[] = $this->start->__toString();
}
if ($this->isRange) {
$result[] = "/";
}
if ($this->end !== null) {
$result[] = $this->end->__toString();
} elseif ($this->duration !== null) {
$result[] = $this->duration->__toString();
}
return implode("", $result);
}
/**
* Set the duration of a FormalDate.
* @param \Gedcomx\Util\Duration $duration
*/
public function setDuration($duration)
{
$this->duration = $duration;
}
/**
* Get the Duration portion of a FormalDate, or null if there is no duration.
* If the duration is non-null, then the starting date must be non-null.
* A duration is used in a range or in a recurring date.
* Must be null if the end is non-null.
* @return \Gedcomx\Util\Duration
*/
public function getDuration()
{
return $this->duration;
}
/**
* Set the ending date of this FormalDate range. If the starting date is null, then the date
* is interpreted as "any time up to this ending time".
* If the date is a range, and the end is null, then it means "any time from the starting date or later".
* If the date is not a range, the end must be null.
* If the date is a range, then either the start or end must be non-null.
* @param \Gedcomx\Util\SimpleDate $end
*/
public function setEnd($end)
{
$this->end = $end;
}
/**
* Get the ending date for this FormalDate range. If the starting date is null, then the FormalDate
* is interpreted as "any time up to this ending date".
* If the date is a range, and the end is null, then it means "any time from the starting date or later."
* If the date is not a range, the end must be null.
* @return \Gedcomx\Util\SimpleDate
*/
public function getEnd()
{
return $this->end;
}
/**
* Set the flag for whether this date is approximate. Note that it is illegal to have an approximate repeating date.
* @param mixed $isApproximate
*/
public function setIsApproximate($isApproximate)
{
$this->isApproximate = $isApproximate;
}
/**
* Tell whether this FormalDate is approximate.
* @return mixed
*/
public function getIsApproximate()
{
return $this->isApproximate;
}
/**
* Set the flag for whether this FormalDate is a range.
* @param mixed $isRange
*/
public function setIsRange($isRange)
{
$this->isRange = $isRange;
}
/**
* Tell whether this date is a range.
* @return mixed
*/
public function getIsRange()
{
return $this->isRange;
}
/**
* Set the flag for whether this is a recurring date, in which case there must be
* a start date and either an end date or a duration (but not both).
* @param mixed $isRecurring
*/
public function setIsRecurring($isRecurring)
{
$this->isRecurring = $isRecurring;
}
/**
* Get the flag for whether this date is a repeating date. If so, then there must be
* a start date, and either an end date or a duration (but not both).
* @return mixed
*/
public function getIsRecurring()
{
return $this->isRecurring;
}
/**
* Set the number of repetitions for a recurring date. Ignored if the date is not recurring.
* If null, a recurring date is assumed to have no limit on the number of repetitions.
* @param mixed $numRepetitions
*/
public function setNumRepetitions($numRepetitions)
{
$this->numRepetitions = $numRepetitions;
}
/**
* Get the number of repetitions for a recurring date, or null if none.
* @return mixed
*/
public function getNumRepetitions()
{
return $this->numRepetitions;
}
/**
* Set the starting date. (If the date is not a range, this is the whole date).
* @param \Gedcomx\Util\SimpleDate $start
*/
public function setStart($start)
{
$this->start = $start;
}
/**
* Get the starting date for this FormalDate.
* If the date is not a range, this is the whole date.
* If the date is a range, and this is null, then it implies "any time before the ending date".
* Must not be null if this FormalDate is not a range.
* @return \Gedcomx\Util\SimpleDate
*/
public function getStart()
{
return $this->start;
}
}