mirror of
https://gitlab.com/davical-project/davical.git
synced 2026-03-04 06:36:39 +00:00
267 lines
9.7 KiB
HTML
267 lines
9.7 KiB
HTML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<!-- template designed by Marco Von Ballmoos -->
|
|
<title>Docs For Class RepeatRuleDateRange</title>
|
|
<link rel="stylesheet" href="../../media/stylesheet.css" />
|
|
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
|
</head>
|
|
<body>
|
|
<div class="page-body">
|
|
<h2 class="class-name"><img src="../../media/images/Class_logo.png"
|
|
alt=" Class"
|
|
title=" Class"
|
|
style="vertical-align: middle"> RepeatRuleDateRange</h2>
|
|
|
|
<a name="sec-description"></a>
|
|
<div class="info-box">
|
|
<div class="info-box-title">Description</div>
|
|
<div class="nav-bar">
|
|
<span class="disabled">Description</span> |
|
|
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
|
|
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
|
|
|
|
</div>
|
|
<div class="info-box-body">
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">This class is used to hold a pair of dates defining a range. The range may be open-ended by including a null for one end or the other, or both.</p>
|
|
<ul class="tags">
|
|
<li><span class="field">author:</span> Andrew McMillan <<a href="mailto:andrew@mcmillan.net.nz">andrew@mcmillan.net.nz</a>></li>
|
|
</ul>
|
|
<p class="notes">
|
|
Located in <a class="field" href="_inc---RRule-v2.php.html">/inc/RRule-v2.php</a> (line <span class="field">522</span>)
|
|
</p>
|
|
|
|
|
|
<pre></pre>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
<a name="sec-var-summary"></a>
|
|
<div class="info-box">
|
|
<div class="info-box-title">Variable Summary</span></div>
|
|
<div class="nav-bar">
|
|
<a href="#sec-description">Description</a> |
|
|
<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
|
|
|
|
|
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
|
|
|
|
</div>
|
|
<div class="info-box-body">
|
|
<div class="var-summary">
|
|
<div class="var-title">
|
|
<img src="../../media/images/Variable.png" alt=" " />
|
|
<span class="var-type">mixed</span>
|
|
<a href="#$from" title="details" class="var-name">$from</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<img src="../../media/images/Variable.png" alt=" " />
|
|
<span class="var-type">mixed</span>
|
|
<a href="#$until" title="details" class="var-name">$until</a>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<a name="sec-method-summary"></a>
|
|
<div class="info-box">
|
|
<div class="info-box-title">Method Summary</span></div>
|
|
<div class="nav-bar">
|
|
<a href="#sec-description">Description</a> |
|
|
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
|
|
|
|
|
|
|
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
|
|
</div>
|
|
<div class="info-box-body">
|
|
<div class="method-summary">
|
|
<div class="method-definition">
|
|
<img src="../../media/images/Constructor.png" alt=" "/>
|
|
<span class="method-result">RepeatRuleDateRange</span>
|
|
<a href="#__construct" title="details" class="method-name">__construct</a>
|
|
(<span class="var-type"><a href="../../awl/caldav/RepeatRuleDateTime.html">RepeatRuleDateTime</a></span> <span class="var-name">$date1</span>, <span class="var-type"><a href="../../awl/caldav/RepeatRuleDateTime.html">RepeatRuleDateTime</a></span> <span class="var-name">$date2</span>)
|
|
</div>
|
|
<div class="method-definition">
|
|
<img src="../../media/images/Method.png" alt=" "/>
|
|
<span class="method-result">NULL|<a href="../../awl/caldav/Rfc5545Duration.html">Rfc5545Duration</a></span>
|
|
<a href="#getDuration" title="details" class="method-name">getDuration</a>
|
|
()
|
|
</div>
|
|
<div class="method-definition">
|
|
<img src="../../media/images/Method.png" alt=" "/>
|
|
<span class="method-result">boolean</span>
|
|
<a href="#overlaps" title="details" class="method-name">overlaps</a>
|
|
(<span class="var-type"><a href="../../awl/caldav/RepeatRuleDateRange.html">RepeatRuleDateRange</a></span> <span class="var-name">$other</span>)
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<a name="sec-vars"></a>
|
|
<div class="info-box">
|
|
<div class="info-box-title">Variables</div>
|
|
<div class="nav-bar">
|
|
<a href="#sec-description">Description</a> |
|
|
<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
|
|
|
|
|
|
|
|
|
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
|
|
|
|
</div>
|
|
<div class="info-box-body">
|
|
|
|
<a name="var$from" id="$from"><!-- --></A>
|
|
<div class="oddrow">
|
|
|
|
<div class="var-header">
|
|
<img src="../../media/images/Variable.png" />
|
|
<span class="var-title">
|
|
<span class="var-type">mixed</span>
|
|
<span class="var-name">$from</span>
|
|
(line <span class="line-number">523</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> public</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$until" id="$until"><!-- --></A>
|
|
<div class="evenrow">
|
|
|
|
<div class="var-header">
|
|
<img src="../../media/images/Variable.png" />
|
|
<span class="var-title">
|
|
<span class="var-type">mixed</span>
|
|
<span class="var-name">$until</span>
|
|
(line <span class="line-number">524</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> public</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<a name="sec-methods"></a>
|
|
<div class="info-box">
|
|
<div class="info-box-title">Methods</div>
|
|
<div class="nav-bar">
|
|
<a href="#sec-description">Description</a> |
|
|
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
|
|
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
|
|
|
|
</div>
|
|
<div class="info-box-body">
|
|
<A NAME='method_detail'></A>
|
|
<a name="method__construct" id="__construct"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div class="method-header">
|
|
<img src="../../media/images/Constructor.png" />
|
|
<span class="method-title">Constructor __construct</span> (line <span class="line-number">535</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Construct a new RepeatRuleDateRange which will be the range between $date1 and $date2. The earliest of the two dates will be used as the start of the period, the latest as the end. If one of the dates is null then the order of the parameters is significant, with the null treated as -infinity if it is first, or +infinity if it is second.</p>
|
|
<p class="description"><p>If both parameters are null then the range is from -infinity to +infinity.</p></p>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">RepeatRuleDateRange</span>
|
|
<span class="method-name">
|
|
__construct
|
|
</span>
|
|
(<span class="var-type"><a href="../../awl/caldav/RepeatRuleDateTime.html">RepeatRuleDateTime</a></span> <span class="var-name">$date1</span>, <span class="var-type"><a href="../../awl/caldav/RepeatRuleDateTime.html">RepeatRuleDateTime</a></span> <span class="var-name">$date2</span>)
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type"><a href="../../awl/caldav/RepeatRuleDateTime.html">RepeatRuleDateTime</a></span>
|
|
<span class="var-name">$date1</span> </li>
|
|
<li>
|
|
<span class="var-type"><a href="../../awl/caldav/RepeatRuleDateTime.html">RepeatRuleDateTime</a></span>
|
|
<span class="var-name">$date2</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodgetDuration" id="getDuration"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<img src="../../media/images/Method.png" />
|
|
<span class="method-title">getDuration</span> (line <span class="line-number">570</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Get an Rfc5545Duration from this date range. If the from date is null it will be null.</p>
|
|
<p class="description"><p>If the until date is null the duration will either be 1 day (if the from is a date) or 0 otherwise.</p></p>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">NULL|<a href="../../awl/caldav/Rfc5545Duration.html">Rfc5545Duration</a></span>
|
|
<span class="method-name">
|
|
getDuration
|
|
</span>
|
|
()
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<a name="methodoverlaps" id="overlaps"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div class="method-header">
|
|
<img src="../../media/images/Method.png" />
|
|
<span class="method-title">overlaps</span> (line <span class="line-number">551</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Assess whether this range overlaps the supplied range. null values are treated as infinity.</p>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">boolean</span>
|
|
<span class="method-name">
|
|
overlaps
|
|
</span>
|
|
(<span class="var-type"><a href="../../awl/caldav/RepeatRuleDateRange.html">RepeatRuleDateRange</a></span> <span class="var-name">$other</span>)
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type"><a href="../../awl/caldav/RepeatRuleDateRange.html">RepeatRuleDateRange</a></span>
|
|
<span class="var-name">$other</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<p class="notes" id="credit">
|
|
Documentation generated on Wed, 04 Jul 2012 10:13:09 +0000 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
|
|
</p>
|
|
</div></body>
|
|
</html> |