mirror of
https://github.com/codeigniter4/CodeIgniter4.git
synced 2025-02-20 11:44:28 +08:00
842 lines
65 KiB
HTML
842 lines
65 KiB
HTML
|
|
|
|
<!DOCTYPE html>
|
|
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
|
|
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
|
|
<head>
|
|
<meta charset="utf-8">
|
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
|
|
<title>Dates and Times — CodeIgniter4 4.0.0-beta.1 documentation</title>
|
|
|
|
|
|
|
|
|
|
<link rel="shortcut icon" href="../_static/ci-icon.ico"/>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="../_static/css/citheme.css" type="text/css" />
|
|
|
|
|
|
|
|
|
|
|
|
<link rel="top" title="CodeIgniter4 4.0.0-beta.1 documentation" href="../index.html"/>
|
|
<link rel="up" title="Library Reference" href="index.html"/>
|
|
<link rel="next" title="Typography" href="typography.html"/>
|
|
<link rel="prev" title="Throttler" href="throttler.html"/>
|
|
|
|
|
|
<script src="../_static/js/modernizr.min.js"></script>
|
|
|
|
</head>
|
|
|
|
<body class="wy-body-for-nav" role="document">
|
|
|
|
|
|
<div class="wy-grid-for-nav">
|
|
|
|
|
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
|
<div class="wy-side-scroll">
|
|
<div class="wy-side-nav-search">
|
|
|
|
|
|
|
|
<a href="../index.html" class="icon icon-home"> CodeIgniter4
|
|
|
|
|
|
|
|
</a>
|
|
|
|
|
|
|
|
|
|
<div role="search">
|
|
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
|
|
<input type="text" name="q" placeholder="Search docs" />
|
|
<input type="hidden" name="check_keywords" value="yes" />
|
|
<input type="hidden" name="area" value="default" />
|
|
</form>
|
|
</div>
|
|
|
|
|
|
</div>
|
|
|
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../intro/index.html">Welcome to CodeIgniter4</a></li>
|
|
</ul>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../installation/index.html">Installation</a></li>
|
|
</ul>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../tutorial/index.html">Tutorial</a></li>
|
|
</ul>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../concepts/index.html">CodeIgniter4 Overview</a></li>
|
|
</ul>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../general/index.html">General Topics</a></li>
|
|
</ul>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../incoming/index.html">Controllers and Routing</a></li>
|
|
</ul>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../outgoing/index.html">Building Responses</a></li>
|
|
</ul>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../database/index.html">Working With Databases</a></li>
|
|
</ul>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../models/index.html">Modeling Data</a></li>
|
|
</ul>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../dbmgmt/index.html">Managing Databases</a></li>
|
|
</ul>
|
|
<ul class="current">
|
|
<li class="toctree-l1 current"><a class="reference internal" href="index.html">Library Reference</a><ul class="current">
|
|
<li class="toctree-l2"><a class="reference internal" href="caching.html">Caching Driver</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="curlrequest.html">CURLRequest Class</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="files.html">Working with Files</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="honeypot.html">Honeypot Class</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="images.html">Image Manipulation Class</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="pagination.html">Pagination</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="security.html">Security Class</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="sessions.html">Session Library</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="throttler.html">Throttler</a></li>
|
|
<li class="toctree-l2 current"><a class="current reference internal" href="#">Dates and Times</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="typography.html">Typography</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="uploaded_files.html">Working with Uploaded Files</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="uri.html">Working with URIs</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="user_agent.html">User Agent Class</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="validation.html">Validation</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../helpers/index.html">Helpers</a></li>
|
|
</ul>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../testing/index.html">Testing</a></li>
|
|
</ul>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../cli/index.html">Command Line Usage</a></li>
|
|
</ul>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../extending/index.html">Extending CodeIgniter</a></li>
|
|
</ul>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../license.html">The MIT License (MIT)</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../changelogs/index.html">Change Logs</a></li>
|
|
</ul>
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
|
|
|
|
|
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
|
|
|
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
|
<a href="../index.html">CodeIgniter4</a>
|
|
|
|
</nav>
|
|
|
|
|
|
|
|
<div class="wy-nav-content">
|
|
<div class="rst-content">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div role="navigation" aria-label="breadcrumbs navigation">
|
|
|
|
<ul class="wy-breadcrumbs">
|
|
|
|
<li><a href="../index.html">Docs</a> »</li>
|
|
|
|
<li><a href="index.html">Library Reference</a> »</li>
|
|
|
|
<li>Dates and Times</li>
|
|
|
|
|
|
<li class="wy-breadcrumbs-aside">
|
|
|
|
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
|
|
<hr/>
|
|
</div>
|
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
|
<div itemprop="articleBody">
|
|
|
|
<div class="section" id="dates-and-times">
|
|
<h1>Dates and Times<a class="headerlink" href="#dates-and-times" title="Permalink to this headline">¶</a></h1>
|
|
<p>CodeIgniter provides a fully-localized, immutable, date/time class that is built on PHP’s DateTime object, but uses the Intl
|
|
extension’s features to convert times across timezones and display the output correctly for different locales. This class
|
|
is the <strong>Time</strong> class and lives in the <strong>CodeIgniter\I18n</strong> namespace.</p>
|
|
<div class="admonition note">
|
|
<p class="first admonition-title">Note</p>
|
|
<p class="last">Since the Time class extends DateTime, if there are features that you need that this class doesn’t provide,
|
|
you can likely find them within the DateTime class itself.</p>
|
|
</div>
|
|
<div class="contents local topic" id="contents">
|
|
<ul class="simple">
|
|
<li><a class="reference internal" href="#instantiating" id="id2">Instantiating</a></li>
|
|
<li><a class="reference internal" href="#displaying-the-value" id="id3">Displaying the Value</a></li>
|
|
<li><a class="reference internal" href="#working-with-individual-values" id="id4">Working with Individual Values</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="section" id="instantiating">
|
|
<h2><a class="toc-backref" href="#id2">Instantiating</a><a class="headerlink" href="#instantiating" title="Permalink to this headline">¶</a></h2>
|
|
<p>There are several ways that a new Time instance can be created. The first is simply to create a new instance
|
|
like any other class. When you do it this way, you can pass in a string representing the desired time. This can
|
|
be any string that PHP’s strtotime function can parse:</p>
|
|
<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="k">use</span> <span class="nx">CodeIgniter\I18n\Time</span><span class="p">;</span>
|
|
|
|
<span class="nv">$myTime</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">Time</span><span class="p">(</span><span class="s1">'+3 week'</span><span class="p">);</span>
|
|
<span class="nv">$myTime</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">Time</span><span class="p">(</span><span class="s1">'now'</span><span class="p">);</span>
|
|
</pre></div>
|
|
</div>
|
|
<p>You can pass in strings representing the timezone and the locale in the second and parameters, respectively. Timezones
|
|
can be any supported by PHP’s <a class="reference external" href="http://php.net/manual/en/timezones.php">DateTimeZone</a> class. The locale can be
|
|
any supported by PHP’s <a class="reference external" href="http://php.net/manual/en/class.locale.php">Locale</a> class. If no locale or timezone is
|
|
provided, the application defaults will be used.</p>
|
|
<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$myTime</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">Time</span><span class="p">(</span><span class="s1">'now'</span><span class="p">,</span> <span class="s1">'America/Chicago'</span><span class="p">,</span> <span class="s1">'en_US'</span><span class="p">);</span>
|
|
</pre></div>
|
|
</div>
|
|
<div class="section" id="now">
|
|
<h3>now()<a class="headerlink" href="#now" title="Permalink to this headline">¶</a></h3>
|
|
<p>The Time class has several helper methods to instantiate the class. The first of these is the <strong>now()</strong> method
|
|
that returns a new instance set to the current time. You can pass in strings representing the timezone and the locale
|
|
in the second and parameters, respectively. If no locale or timezone is provided, the application defaults will be used.</p>
|
|
<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$myTime</span> <span class="o">=</span> <span class="nx">Time</span><span class="o">::</span><span class="na">now</span><span class="p">(</span><span class="s1">'America/Chicago'</span><span class="p">,</span> <span class="s1">'en_US'</span><span class="p">);</span>
|
|
</pre></div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="parse">
|
|
<h3>parse()<a class="headerlink" href="#parse" title="Permalink to this headline">¶</a></h3>
|
|
<p>This helper method is a static version of the default constructor. It takes a string acceptable as DateTime’s
|
|
constructor as the first parameter, a timezone as the second parameter, and the locale as the third parameter.:</p>
|
|
<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$myTime</span> <span class="o">=</span> <span class="nx">Time</span><span class="o">::</span><span class="na">parse</span><span class="p">(</span><span class="s1">'next Tuesday'</span><span class="p">,</span> <span class="s1">'America/Chicago'</span><span class="p">,</span> <span class="s1">'en_US'</span><span class="p">);</span>
|
|
</pre></div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="today">
|
|
<h3>today()<a class="headerlink" href="#today" title="Permalink to this headline">¶</a></h3>
|
|
<p>Returns a new instance with the date set to the current date, and the time set to midnight. It accepts strings
|
|
for the timezone and locale in the second and third parameters:</p>
|
|
<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$myTime</span> <span class="o">=</span> <span class="nx">Time</span><span class="o">::</span><span class="na">today</span><span class="p">(</span><span class="s1">'America/Chicago'</span><span class="p">,</span> <span class="s1">'en_US'</span><span class="p">);</span>
|
|
</pre></div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="yesterday">
|
|
<h3>yesterday()<a class="headerlink" href="#yesterday" title="Permalink to this headline">¶</a></h3>
|
|
<p>Returns a new instance with the date set to the yesterday’s date and the time set to midnight. It accepts strings
|
|
for the timezone and locale in the second and third parameters:</p>
|
|
<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$myTime</span> <span class="o">=</span> <span class="nx">Time</span><span class="o">::</span><span class="na">yesterday</span><span class="p">(</span><span class="s1">'America/Chicago'</span><span class="p">,</span> <span class="s1">'en_US'</span><span class="p">);</span>
|
|
</pre></div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="tomorrow">
|
|
<h3>tomorrow()<a class="headerlink" href="#tomorrow" title="Permalink to this headline">¶</a></h3>
|
|
<p>Returns a new instance with the date set to the tomorrow’s date and the time set to midnight. It accepts strings
|
|
for the timezone and locale in the second and third parameters:</p>
|
|
<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$myTime</span> <span class="o">=</span> <span class="nx">Time</span><span class="o">::</span><span class="na">tomorrow</span><span class="p">(</span><span class="s1">'America/Chicago'</span><span class="p">,</span> <span class="s1">'en_US'</span><span class="p">);</span>
|
|
</pre></div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="createfromdate">
|
|
<h3>createFromDate()<a class="headerlink" href="#createfromdate" title="Permalink to this headline">¶</a></h3>
|
|
<p>Given separate inputs for <strong>year</strong>, <strong>month</strong>, and <strong>day</strong>, will return a new instance. If any of these parameters
|
|
are not provided, it will use the current value to fill it in. Accepts strings for the timezone and locale in the
|
|
fourth and fifth parameters:</p>
|
|
<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$today</span> <span class="o">=</span> <span class="nx">Time</span><span class="o">::</span><span class="na">createFromDate</span><span class="p">();</span> <span class="c1">// Uses current year, month, and day</span>
|
|
<span class="nv">$anniversary</span> <span class="o">=</span> <span class="nx">Time</span><span class="o">::</span><span class="na">createFromDate</span><span class="p">(</span><span class="mi">2018</span><span class="p">);</span> <span class="c1">// Uses current month and day</span>
|
|
<span class="nv">$date</span> <span class="o">=</span> <span class="nx">Time</span><span class="o">::</span><span class="na">createFromDate</span><span class="p">(</span><span class="mi">2018</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">15</span><span class="p">,</span> <span class="s1">'America/Chicago'</span><span class="p">,</span> <span class="s1">'en_US'</span><span class="p">);</span>
|
|
</pre></div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="createfromtime">
|
|
<h3>createFromTime()<a class="headerlink" href="#createfromtime" title="Permalink to this headline">¶</a></h3>
|
|
<p>Like <strong>createFromDate</strong> except it is only concerned with the <strong>hours</strong>, <strong>minutes</strong>, and <strong>seconds</strong>. Uses the
|
|
current day for the date portion of the Time instance. Accepts strings for the timezone and locale in the
|
|
fourth and fifth parameters:</p>
|
|
<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$lunch</span> <span class="o">=</span> <span class="nx">Time</span><span class="o">::</span><span class="na">createFromTime</span><span class="p">(</span><span class="mi">11</span><span class="p">,</span> <span class="mi">30</span><span class="p">)</span> <span class="c1">// 11:30 am today</span>
|
|
<span class="nv">$dinner</span> <span class="o">=</span> <span class="nx">Time</span><span class="o">::</span><span class="na">createFromTime</span><span class="p">(</span><span class="mi">18</span><span class="p">,</span> <span class="mo">00</span><span class="p">,</span> <span class="mo">00</span><span class="p">)</span> <span class="c1">// 6:00 pm today</span>
|
|
<span class="nv">$time</span> <span class="o">=</span> <span class="nx">Time</span><span class="o">::</span><span class="na">createFromTime</span><span class="p">(</span><span class="nv">$hour</span><span class="p">,</span> <span class="nv">$minutes</span><span class="p">,</span> <span class="nv">$seconds</span><span class="p">,</span> <span class="nv">$timezone</span><span class="p">,</span> <span class="nv">$locale</span><span class="p">);</span>
|
|
</pre></div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="create">
|
|
<h3>create()<a class="headerlink" href="#create" title="Permalink to this headline">¶</a></h3>
|
|
<p>A combination of the previous two methods, takes <strong>year</strong>, <strong>month</strong>, <strong>day</strong>, <strong>hour</strong>, <strong>minutes</strong>, and <strong>seconds</strong>
|
|
as separate parameters. Any value not provided will use the current date and time to determine. Accepts strings for the
|
|
timezone and locale in the fourth and fifth parameters:</p>
|
|
<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$time</span> <span class="o">=</span> <span class="nx">Time</span><span class="o">::</span><span class="na">create</span><span class="p">(</span><span class="nv">$year</span><span class="p">,</span> <span class="nv">$month</span><span class="p">,</span> <span class="nv">$day</span><span class="p">,</span> <span class="nv">$hour</span><span class="p">,</span> <span class="nv">$minutes</span><span class="p">,</span> <span class="nv">$seconds</span><span class="p">,</span> <span class="nv">$timezone</span><span class="p">,</span> <span class="nv">$locale</span><span class="p">);</span>
|
|
</pre></div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="createfromformat">
|
|
<h3>createFromFormat()<a class="headerlink" href="#createfromformat" title="Permalink to this headline">¶</a></h3>
|
|
<p>This is a replacement for DateTime’s method of the same name. This allows the timezone to be set at the same time,
|
|
and returns a <strong>Time</strong> instance, instead of DateTime:</p>
|
|
<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$time</span> <span class="o">=</span> <span class="nx">Time</span><span class="o">::</span><span class="na">createFromFormat</span><span class="p">(</span><span class="s1">'j-M-Y'</span><span class="p">,</span> <span class="s1">'15-Feb-2009'</span><span class="p">,</span> <span class="s1">'America/Chicago'</span><span class="p">);</span>
|
|
</pre></div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="createfromtimestamp">
|
|
<h3>createFromTimestamp()<a class="headerlink" href="#createfromtimestamp" title="Permalink to this headline">¶</a></h3>
|
|
<p>This method takes a UNIX timestamp and, optionally, the timezone and locale, to create a new Time instance:</p>
|
|
<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$time</span> <span class="o">=</span> <span class="nx">Time</span><span class="o">::</span><span class="na">createFromTimestamp</span><span class="p">(</span><span class="mi">1501821586</span><span class="p">,</span> <span class="s1">'America/Chicago'</span><span class="p">,</span> <span class="s1">'en_US'</span><span class="p">);</span>
|
|
</pre></div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="instance">
|
|
<h3>instance()<a class="headerlink" href="#instance" title="Permalink to this headline">¶</a></h3>
|
|
<p>When working with other libraries that provide a DateTime instance, you can use this method to convert that
|
|
to a Time instance, optionally setting the locale. The timezone will be automatically determined from the DateTime
|
|
instance passed in:</p>
|
|
<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$dt</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">DateTime</span><span class="p">(</span><span class="s1">'now'</span><span class="p">);</span>
|
|
<span class="nv">$time</span> <span class="o">=</span> <span class="nx">Time</span><span class="o">::</span><span class="na">instance</span><span class="p">(</span><span class="nv">$dt</span><span class="p">,</span> <span class="s1">'en_US'</span><span class="p">);</span>
|
|
</pre></div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="todatetime">
|
|
<h3>toDateTime()<a class="headerlink" href="#todatetime" title="Permalink to this headline">¶</a></h3>
|
|
<p>While not an instantiator, this method is the opposite of the <strong>instance</strong> method, allowing you to convert a Time
|
|
instance into a DateTime instance. This preserves the timezone setting, but loses the locale, since DateTime is
|
|
not aware of locales:</p>
|
|
<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$datetime</span> <span class="o">=</span> <span class="nx">Time</span><span class="o">::</span><span class="na">toDateTime</span><span class="p">();</span>
|
|
</pre></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="displaying-the-value">
|
|
<h2><a class="toc-backref" href="#id3">Displaying the Value</a><a class="headerlink" href="#displaying-the-value" title="Permalink to this headline">¶</a></h2>
|
|
<p>Since the Time class extends DateTime, you get all of the output methods that provides, including the format() method.
|
|
However, the DateTime methods do not provide a localize result. The Time class does provide a number of helper methods
|
|
to display localized versions of the value, though.</p>
|
|
<div class="section" id="tolocalizedstring">
|
|
<h3>toLocalizedString()<a class="headerlink" href="#tolocalizedstring" title="Permalink to this headline">¶</a></h3>
|
|
<p>This is the localized version of DateTime’s format() method. Instead of using the values you might be familiar with, though,
|
|
you must use values acceptable to the <a class="reference external" href="http://php.net/manual/en/class.intldateformatter.php">IntlDateFormatter</a> class.
|
|
A full listing of values can be found <a class="reference external" href="http://www.icu-project.org/apiref/icu4c/classSimpleDateFormat.html#details">here</a>.</p>
|
|
<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$time</span> <span class="o">=</span> <span class="nx">Time</span><span class="o">::</span><span class="na">parse</span><span class="p">(</span><span class="s1">'March 9, 2016 12:00:00'</span><span class="p">,</span> <span class="s1">'America/Chicago'</span><span class="p">);</span>
|
|
<span class="k">echo</span> <span class="nv">$time</span><span class="o">-></span><span class="na">toLocalizedString</span><span class="p">(</span><span class="s1">'MMM d, yyyy'</span><span class="p">);</span> <span class="c1">// March 9, 2016</span>
|
|
</pre></div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="todatetimestring">
|
|
<h3>toDateTimeString()<a class="headerlink" href="#todatetimestring" title="Permalink to this headline">¶</a></h3>
|
|
<p>This is the first of three helper methods to work with the IntlDateFormatter without having to remember their values.
|
|
This will return a string formatted as you would commonly use for datetime columns in a database (Y-m-d H:i:s):</p>
|
|
<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$time</span> <span class="o">=</span> <span class="nx">Time</span><span class="o">::</span><span class="na">parse</span><span class="p">(</span><span class="s1">'March 9, 2016 12:00:00'</span><span class="p">,</span> <span class="s1">'America/Chicago'</span><span class="p">);</span>
|
|
<span class="k">echo</span> <span class="nv">$time</span><span class="o">-></span><span class="na">toDateTimeString</span><span class="p">();</span> <span class="c1">// 2016-03-09 12:00:00</span>
|
|
</pre></div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="todatestring">
|
|
<h3>toDateString()<a class="headerlink" href="#todatestring" title="Permalink to this headline">¶</a></h3>
|
|
<p>Displays just the date portion of the Time:</p>
|
|
<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$time</span> <span class="o">=</span> <span class="nx">Time</span><span class="o">::</span><span class="na">parse</span><span class="p">(</span><span class="s1">'March 9, 2016 12:00:00'</span><span class="p">,</span> <span class="s1">'America/Chicago'</span><span class="p">);</span>
|
|
<span class="k">echo</span> <span class="nv">$time</span><span class="o">-></span><span class="na">toDateTimeString</span><span class="p">();</span> <span class="c1">// 2016-03-09</span>
|
|
</pre></div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="totimestring">
|
|
<h3>toTimeString()<a class="headerlink" href="#totimestring" title="Permalink to this headline">¶</a></h3>
|
|
<p>Displays just the time portion of the value:</p>
|
|
<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$time</span> <span class="o">=</span> <span class="nx">Time</span><span class="o">::</span><span class="na">parse</span><span class="p">(</span><span class="s1">'March 9, 2016 12:00:00'</span><span class="p">,</span> <span class="s1">'America/Chicago'</span><span class="p">);</span>
|
|
<span class="k">echo</span> <span class="nv">$time</span><span class="o">-></span><span class="na">toTimeString</span><span class="p">();</span> <span class="c1">// 12:00:00</span>
|
|
</pre></div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="humanize">
|
|
<h3>humanize()<a class="headerlink" href="#humanize" title="Permalink to this headline">¶</a></h3>
|
|
<p>This methods returns a string that displays the difference between the current date/time and the instance in a
|
|
human readable format that is geared towards being easily understood. It can create strings like ‘3 hours ago’,
|
|
‘in 1 month’, etc:</p>
|
|
<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="c1">// Assume current time is: March 10, 2017 (America/Chicago)</span>
|
|
<span class="nv">$time</span> <span class="o">=</span> <span class="nx">Time</span><span class="o">::</span><span class="na">parse</span><span class="p">(</span><span class="s1">'March 9, 2016 12:00:00'</span><span class="p">,</span> <span class="s1">'America/Chicago'</span><span class="p">);</span>
|
|
|
|
<span class="k">echo</span> <span class="nv">$time</span><span class="o">-></span><span class="na">humanize</span><span class="p">();</span> <span class="c1">// 1 year ago</span>
|
|
</pre></div>
|
|
</div>
|
|
<p>The exact time displayed is determined in the following manner:</p>
|
|
<table border="1" class="docutils">
|
|
<colgroup>
|
|
<col width="48%" />
|
|
<col width="52%" />
|
|
</colgroup>
|
|
<thead valign="bottom">
|
|
<tr class="row-odd"><th class="head">Time difference</th>
|
|
<th class="head">Result</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody valign="top">
|
|
<tr class="row-even"><td>$time > 1 year && < 2 years</td>
|
|
<td>in 1 year / 1 year ago</td>
|
|
</tr>
|
|
<tr class="row-odd"><td>$time > 1 month && < 1 year</td>
|
|
<td>in 6 months / 6 months ago</td>
|
|
</tr>
|
|
<tr class="row-even"><td>$time > 7 days && < 1 month</td>
|
|
<td>in 3 weeks / 3 weeks ago</td>
|
|
</tr>
|
|
<tr class="row-odd"><td>$time > today && < 7 days</td>
|
|
<td>in 4 days / 4 days ago</td>
|
|
</tr>
|
|
<tr class="row-even"><td>$time == tomorrow / yesterday</td>
|
|
<td>Tomorrow / Yesterday</td>
|
|
</tr>
|
|
<tr class="row-odd"><td>$time > 59 minutes && < 1 day</td>
|
|
<td>1:37pm</td>
|
|
</tr>
|
|
<tr class="row-even"><td>$time > now && < 1 hour</td>
|
|
<td>in 35 minutes / 35 minutes ago</td>
|
|
</tr>
|
|
<tr class="row-odd"><td>$time == now</td>
|
|
<td>Now</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p>The exact language used is controlled through the language file, Time.php.</p>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="working-with-individual-values">
|
|
<h2><a class="toc-backref" href="#id4">Working with Individual Values</a><a class="headerlink" href="#working-with-individual-values" title="Permalink to this headline">¶</a></h2>
|
|
<p>The Time object provides a number of methods to allow to get and set individual items, like the year, month, hour, etc,
|
|
of an existing instance. All of the values retrieved through the following methods will be fully localized and respect
|
|
the locale that the Time instance was created with.</p>
|
|
<p>All of the following <cite>getX</cite> and <cite>setX</cite> methods can also be used as if they were a class property. So, any calls to methods
|
|
like <cite>getYear</cite> can also be accessed through <cite>$time->year</cite>, and so on.</p>
|
|
<div class="section" id="getters">
|
|
<h3>Getters<a class="headerlink" href="#getters" title="Permalink to this headline">¶</a></h3>
|
|
<p>The following basic getters exist:</p>
|
|
<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$time</span> <span class="o">=</span> <span class="nx">Time</span><span class="o">::</span><span class="na">parse</span><span class="p">(</span><span class="s1">'August 12, 2016 4:15:23pm'</span><span class="p">);</span>
|
|
|
|
<span class="k">echo</span> <span class="nv">$time</span><span class="o">-></span><span class="na">getYear</span><span class="p">();</span> <span class="c1">// 2016</span>
|
|
<span class="k">echo</span> <span class="nv">$time</span><span class="o">-></span><span class="na">getMonth</span><span class="p">();</span> <span class="c1">// 8</span>
|
|
<span class="k">echo</span> <span class="nv">$time</span><span class="o">-></span><span class="na">getDay</span><span class="p">();</span> <span class="c1">// 12</span>
|
|
<span class="k">echo</span> <span class="nv">$time</span><span class="o">-></span><span class="na">getHour</span><span class="p">();</span> <span class="c1">// 16</span>
|
|
<span class="k">echo</span> <span class="nv">$time</span><span class="o">-></span><span class="na">getMinute</span><span class="p">();</span> <span class="c1">// 15</span>
|
|
<span class="k">echo</span> <span class="nv">$time</span><span class="o">-></span><span class="na">getSecond</span><span class="p">();</span> <span class="c1">// 23</span>
|
|
|
|
<span class="k">echo</span> <span class="nv">$time</span><span class="o">-></span><span class="na">year</span><span class="p">;</span> <span class="c1">// 2016</span>
|
|
<span class="k">echo</span> <span class="nv">$time</span><span class="o">-></span><span class="na">month</span><span class="p">;</span> <span class="c1">// 8</span>
|
|
<span class="k">echo</span> <span class="nv">$time</span><span class="o">-></span><span class="na">day</span><span class="p">;</span> <span class="c1">// 12</span>
|
|
<span class="k">echo</span> <span class="nv">$time</span><span class="o">-></span><span class="na">hour</span><span class="p">;</span> <span class="c1">// 16</span>
|
|
<span class="k">echo</span> <span class="nv">$time</span><span class="o">-></span><span class="na">minute</span><span class="p">;</span> <span class="c1">// 15</span>
|
|
<span class="k">echo</span> <span class="nv">$time</span><span class="o">-></span><span class="na">second</span><span class="p">;</span> <span class="c1">// 23</span>
|
|
</pre></div>
|
|
</div>
|
|
<p>In addition to these, a number of methods exist to provide additional information about the date:</p>
|
|
<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$time</span> <span class="o">=</span> <span class="nx">Time</span><span class="o">::</span><span class="na">parse</span><span class="p">(</span><span class="s1">'August 12, 2016 4:15:23pm'</span><span class="p">);</span>
|
|
|
|
<span class="k">echo</span> <span class="nv">$time</span><span class="o">-></span><span class="na">getDayOfWeek</span><span class="p">();</span> <span class="c1">// 6 - but may vary based on locale's starting day of the week</span>
|
|
<span class="k">echo</span> <span class="nv">$time</span><span class="o">-></span><span class="na">getDayOfYear</span><span class="p">();</span> <span class="c1">// 225</span>
|
|
<span class="k">echo</span> <span class="nv">$time</span><span class="o">-></span><span class="na">getWeekOfMonth</span><span class="p">();</span> <span class="c1">// 2</span>
|
|
<span class="k">echo</span> <span class="nv">$time</span><span class="o">-></span><span class="na">getWeekOfYear</span><span class="p">();</span> <span class="c1">// 33</span>
|
|
<span class="k">echo</span> <span class="nv">$time</span><span class="o">-></span><span class="na">getTimestamp</span><span class="p">();</span> <span class="c1">// 1471018523 - UNIX timestamp</span>
|
|
<span class="k">echo</span> <span class="nv">$time</span><span class="o">-></span><span class="na">getQuarter</span><span class="p">();</span> <span class="c1">// 3</span>
|
|
|
|
<span class="k">echo</span> <span class="nv">$time</span><span class="o">-></span><span class="na">dayOfWeek</span><span class="p">;</span> <span class="c1">// 6</span>
|
|
<span class="k">echo</span> <span class="nv">$time</span><span class="o">-></span><span class="na">dayOfYear</span><span class="p">;</span> <span class="c1">// 225</span>
|
|
<span class="k">echo</span> <span class="nv">$time</span><span class="o">-></span><span class="na">weekOfMonth</span><span class="p">;</span> <span class="c1">// 2</span>
|
|
<span class="k">echo</span> <span class="nv">$time</span><span class="o">-></span><span class="na">weekOfYear</span><span class="p">;</span> <span class="c1">// 33</span>
|
|
<span class="k">echo</span> <span class="nv">$time</span><span class="o">-></span><span class="na">timestamp</span><span class="p">;</span> <span class="c1">// 1471018523</span>
|
|
<span class="k">echo</span> <span class="nv">$time</span><span class="o">-></span><span class="na">quarter</span><span class="p">;</span> <span class="c1">// 3</span>
|
|
</pre></div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="getage">
|
|
<h3>getAge()<a class="headerlink" href="#getage" title="Permalink to this headline">¶</a></h3>
|
|
<p>Returns the age, in years, of between the Time’s instance and the current time. Perfect for checking
|
|
the age of someone based on their birthday:</p>
|
|
<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$time</span> <span class="o">=</span> <span class="nx">Time</span><span class="o">::</span><span class="na">parse</span><span class="p">(</span><span class="s1">'5 years ago'</span><span class="p">);</span>
|
|
|
|
<span class="k">echo</span> <span class="nv">$time</span><span class="o">-></span><span class="na">getAge</span><span class="p">();</span> <span class="c1">// 5</span>
|
|
<span class="k">echo</span> <span class="nv">$time</span><span class="o">-></span><span class="na">age</span><span class="p">;</span> <span class="c1">// 5</span>
|
|
</pre></div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="getdst">
|
|
<h3>getDST()<a class="headerlink" href="#getdst" title="Permalink to this headline">¶</a></h3>
|
|
<p>Returns boolean true/false based on whether the Time instance is currently observing Daylight Savings Time:</p>
|
|
<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="k">echo</span> <span class="nx">Time</span><span class="o">::</span><span class="na">createFromDate</span><span class="p">(</span><span class="mi">2012</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span><span class="o">-></span><span class="na">getDst</span><span class="p">();</span> <span class="c1">// false</span>
|
|
<span class="k">echo</span> <span class="nx">Time</span><span class="o">::</span><span class="na">createFromDate</span><span class="p">(</span><span class="mi">2012</span><span class="p">,</span> <span class="mi">9</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span><span class="o">-></span><span class="na">dst</span><span class="p">;</span> <span class="c1">// true</span>
|
|
</pre></div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="getlocal">
|
|
<h3>getLocal()<a class="headerlink" href="#getlocal" title="Permalink to this headline">¶</a></h3>
|
|
<p>Returns boolean true if the Time instance is in the same timezone as the application is currently running in:</p>
|
|
<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="k">echo</span> <span class="nx">Time</span><span class="o">::</span><span class="na">now</span><span class="p">()</span><span class="o">-></span><span class="na">getLocal</span><span class="p">();</span> <span class="c1">// true</span>
|
|
<span class="k">echo</span> <span class="nx">Time</span><span class="o">::</span><span class="na">now</span><span class="p">(</span><span class="s1">'Europe/London'</span><span class="p">);</span> <span class="c1">// false</span>
|
|
</pre></div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="getutc">
|
|
<h3>getUtc()<a class="headerlink" href="#getutc" title="Permalink to this headline">¶</a></h3>
|
|
<p>Returns boolean true if the Time instance is in UTC time:</p>
|
|
<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="k">echo</span> <span class="nx">Time</span><span class="o">::</span><span class="na">now</span><span class="p">(</span><span class="s1">'America/Chicago'</span><span class="p">)</span><span class="o">-></span><span class="na">getUtc</span><span class="p">();</span> <span class="c1">// false</span>
|
|
<span class="k">echo</span> <span class="nx">Time</span><span class="o">::</span><span class="na">now</span><span class="p">(</span><span class="s1">'UTC'</span><span class="p">)</span><span class="o">-></span><span class="na">utc</span><span class="p">;</span> <span class="c1">// true</span>
|
|
</pre></div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="gettimezone">
|
|
<h3>getTimezone()<a class="headerlink" href="#gettimezone" title="Permalink to this headline">¶</a></h3>
|
|
<p>Returns a new <a class="reference external" href="http://php.net/manual/en/class.datetimezone.php">DateTimeZone</a> object set the timezone of the Time
|
|
instance:</p>
|
|
<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$tz</span> <span class="o">=</span> <span class="nx">Time</span><span class="o">::</span><span class="na">now</span><span class="p">()</span><span class="o">-></span><span class="na">getTimezone</span><span class="p">();</span>
|
|
<span class="nv">$tz</span> <span class="o">=</span> <span class="nx">Time</span><span class="o">::</span><span class="na">now</span><span class="p">()</span><span class="o">-></span><span class="na">timezone</span><span class="p">;</span>
|
|
|
|
<span class="k">echo</span> <span class="nv">$tz</span><span class="o">-></span><span class="na">getName</span><span class="p">();</span>
|
|
<span class="k">echo</span> <span class="nv">$tz</span><span class="o">-></span><span class="na">getOffset</span><span class="p">();</span>
|
|
</pre></div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="gettimezonename">
|
|
<h3>getTimezoneName()<a class="headerlink" href="#gettimezonename" title="Permalink to this headline">¶</a></h3>
|
|
<p>Returns the full <a class="reference external" href="http://php.net/manual/en/timezones.php">timezone string</a> of the Time instance:</p>
|
|
<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="k">echo</span> <span class="nx">Time</span><span class="o">::</span><span class="na">now</span><span class="p">(</span><span class="s1">'America/Chicago'</span><span class="p">)</span><span class="o">-></span><span class="na">getTimezoneName</span><span class="p">();</span> <span class="c1">// America/Chicago</span>
|
|
<span class="k">echo</span> <span class="nx">Time</span><span class="o">::</span><span class="na">now</span><span class="p">(</span><span class="s1">'Europe/London'</span><span class="p">)</span><span class="o">-></span><span class="na">timezoneName</span><span class="p">;</span> <span class="c1">// Europe/London</span>
|
|
</pre></div>
|
|
</div>
|
|
<div class="section" id="setters">
|
|
<h4>Setters<a class="headerlink" href="#setters" title="Permalink to this headline">¶</a></h4>
|
|
<p>The following basic setters exist. If any of the values set are out of range, an <code class="docutils literal"><span class="pre">InvalidArgumentExeption</span></code> will be
|
|
thrown.</p>
|
|
<div class="admonition note">
|
|
<p class="first admonition-title">Note</p>
|
|
<p class="last">All setters will return a new Time instance, leaving the original instance untouched.</p>
|
|
</div>
|
|
<div class="admonition note">
|
|
<p class="first admonition-title">Note</p>
|
|
<p class="last">All setters will throw an InvalidArgumentException if the value is out of range.</p>
|
|
</div>
|
|
<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$time</span> <span class="o">=</span> <span class="nv">$time</span><span class="o">-></span><span class="na">setYear</span><span class="p">(</span><span class="mi">2017</span><span class="p">);</span>
|
|
<span class="nv">$time</span> <span class="o">=</span> <span class="nv">$time</span><span class="o">-></span><span class="na">setMonthNumber</span><span class="p">(</span><span class="mi">4</span><span class="p">);</span> <span class="c1">// April</span>
|
|
<span class="nv">$time</span> <span class="o">=</span> <span class="nv">$time</span><span class="o">-></span><span class="na">setMonthLongName</span><span class="p">(</span><span class="s1">'April'</span><span class="p">);</span>
|
|
<span class="nv">$time</span> <span class="o">=</span> <span class="nv">$time</span><span class="o">-></span><span class="na">setMonthShortName</span><span class="p">(</span><span class="s1">'Feb'</span><span class="p">);</span> <span class="c1">// February</span>
|
|
<span class="nv">$time</span> <span class="o">=</span> <span class="nv">$time</span><span class="o">-></span><span class="na">setDay</span><span class="p">(</span><span class="mi">25</span><span class="p">);</span>
|
|
<span class="nv">$time</span> <span class="o">=</span> <span class="nv">$time</span><span class="o">-></span><span class="na">setHour</span><span class="p">(</span><span class="mi">14</span><span class="p">);</span> <span class="c1">// 2:00 pm</span>
|
|
<span class="nv">$time</span> <span class="o">=</span> <span class="nv">$time</span><span class="o">-></span><span class="na">setMinute</span><span class="p">(</span><span class="mi">30</span><span class="p">);</span>
|
|
<span class="nv">$time</span> <span class="o">=</span> <span class="nv">$time</span><span class="o">-></span><span class="na">setSecond</span><span class="p">(</span><span class="mi">54</span><span class="p">);</span>
|
|
</pre></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="settimezone">
|
|
<h3>setTimezone()<a class="headerlink" href="#settimezone" title="Permalink to this headline">¶</a></h3>
|
|
<p>Converts the time from it’s current timezone into the new one:</p>
|
|
<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$time</span> <span class="o">=</span> <span class="nx">Time</span><span class="o">::</span><span class="na">parse</span><span class="p">(</span><span class="s1">'May 10, 2017'</span><span class="p">,</span> <span class="s1">'America/Chicago'</span><span class="p">);</span>
|
|
<span class="nv">$time2</span> <span class="o">=</span> <span class="nv">$time</span><span class="o">-></span><span class="na">setTimezone</span><span class="p">(</span><span class="s1">'Europe/London'</span><span class="p">);</span> <span class="c1">// Returns new instance converted to new timezone</span>
|
|
|
|
<span class="k">echo</span> <span class="nv">$time</span><span class="o">-></span><span class="na">timezoneName</span><span class="p">;</span> <span class="c1">// American/Chicago</span>
|
|
<span class="k">echo</span> <span class="nv">$time2</span><span class="o">-></span><span class="na">timezoneName</span><span class="p">;</span> <span class="c1">// Europe/London</span>
|
|
</pre></div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="settimestamp">
|
|
<h3>setTimestamp()<a class="headerlink" href="#settimestamp" title="Permalink to this headline">¶</a></h3>
|
|
<p>Returns a new instance with the date set to the new timestamp:</p>
|
|
<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$time</span> <span class="o">=</span> <span class="nx">Time</span><span class="o">::</span><span class="na">parse</span><span class="p">(</span><span class="s1">'May 10, 2017'</span><span class="p">,</span> <span class="s1">'America/Chicago'</span><span class="p">);</span>
|
|
<span class="nv">$time2</span> <span class="o">=</span> <span class="nv">$time</span><span class="o">-></span><span class="na">setTimestamp</span><span class="p">(</span><span class="nb">strtotime</span><span class="p">(</span><span class="s1">'April 1, 2017'</span><span class="p">));</span>
|
|
|
|
<span class="k">echo</span> <span class="nv">$time</span><span class="o">-></span><span class="na">toDateTimeString</span><span class="p">();</span> <span class="c1">// 2017-05-10 00:00:00</span>
|
|
<span class="k">echo</span> <span class="nv">$time2</span><span class="o">-></span><span class="na">toDateTimeString</span><span class="p">();</span> <span class="c1">// 2017-04-01 00:00:00</span>
|
|
</pre></div>
|
|
</div>
|
|
<div class="section" id="modifying-the-value">
|
|
<h4>Modifying the Value<a class="headerlink" href="#modifying-the-value" title="Permalink to this headline">¶</a></h4>
|
|
<p>The following methods allow you to modify the date by adding or subtracting values to the current Time. This will not
|
|
modify the existing Time instance, but will return a new instance.</p>
|
|
<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$time</span> <span class="o">=</span> <span class="nv">$time</span><span class="o">-></span><span class="na">addSeconds</span><span class="p">(</span><span class="mi">23</span><span class="p">);</span>
|
|
<span class="nv">$time</span> <span class="o">=</span> <span class="nv">$time</span><span class="o">-></span><span class="na">addMinutes</span><span class="p">(</span><span class="mi">15</span><span class="p">);</span>
|
|
<span class="nv">$time</span> <span class="o">=</span> <span class="nv">$time</span><span class="o">-></span><span class="na">addHours</span><span class="p">(</span><span class="mi">12</span><span class="p">);</span>
|
|
<span class="nv">$time</span> <span class="o">=</span> <span class="nv">$time</span><span class="o">-></span><span class="na">addDays</span><span class="p">(</span><span class="mi">21</span><span class="p">);</span>
|
|
<span class="nv">$time</span> <span class="o">=</span> <span class="nv">$time</span><span class="o">-></span><span class="na">addMonths</span><span class="p">(</span><span class="mi">14</span><span class="p">);</span>
|
|
<span class="nv">$time</span> <span class="o">=</span> <span class="nv">$time</span><span class="o">-></span><span class="na">addYears</span><span class="p">(</span><span class="mi">5</span><span class="p">);</span>
|
|
|
|
<span class="nv">$time</span> <span class="o">=</span> <span class="nv">$time</span><span class="o">-></span><span class="na">subSeconds</span><span class="p">(</span><span class="mi">23</span><span class="p">);</span>
|
|
<span class="nv">$time</span> <span class="o">=</span> <span class="nv">$time</span><span class="o">-></span><span class="na">subMinutes</span><span class="p">(</span><span class="mi">15</span><span class="p">);</span>
|
|
<span class="nv">$time</span> <span class="o">=</span> <span class="nv">$time</span><span class="o">-></span><span class="na">subHours</span><span class="p">(</span><span class="mi">12</span><span class="p">);</span>
|
|
<span class="nv">$time</span> <span class="o">=</span> <span class="nv">$time</span><span class="o">-></span><span class="na">subDays</span><span class="p">(</span><span class="mi">21</span><span class="p">);</span>
|
|
<span class="nv">$time</span> <span class="o">=</span> <span class="nv">$time</span><span class="o">-></span><span class="na">subMonths</span><span class="p">(</span><span class="mi">14</span><span class="p">);</span>
|
|
<span class="nv">$time</span> <span class="o">=</span> <span class="nv">$time</span><span class="o">-></span><span class="na">subYears</span><span class="p">(</span><span class="mi">5</span><span class="p">);</span>
|
|
</pre></div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="comparing-two-times">
|
|
<h4>Comparing Two Times<a class="headerlink" href="#comparing-two-times" title="Permalink to this headline">¶</a></h4>
|
|
<p>The following methods allow you to compare one Time instance with another. All comparisons are first converted to UTC
|
|
before comparisons are done, to ensure that different timezones respond correctly.</p>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="equals">
|
|
<h3>equals()<a class="headerlink" href="#equals" title="Permalink to this headline">¶</a></h3>
|
|
<p>Determines if the datetime passed in is equal to the current instance. Equal in this case means that they represent the
|
|
same moment in time, and are not required to be in the same timezone, as both times are converted to UTC and compared
|
|
that way:</p>
|
|
<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$time1</span> <span class="o">=</span> <span class="nx">Time</span><span class="o">::</span><span class="na">parse</span><span class="p">(</span><span class="s1">'January 10, 2017 21:50:00'</span><span class="p">,</span> <span class="s1">'America/Chicago'</span><span class="p">);</span>
|
|
<span class="nv">$time2</span> <span class="o">=</span> <span class="nx">Time</span><span class="o">::</span><span class="na">parse</span><span class="p">(</span><span class="s1">'January 11, 2017 03:50:00'</span><span class="p">,</span> <span class="s1">'Europe/London'</span><span class="p">);</span>
|
|
|
|
<span class="nv">$time1</span><span class="o">-></span><span class="na">equals</span><span class="p">(</span><span class="nv">$time2</span><span class="p">);</span> <span class="c1">// true</span>
|
|
</pre></div>
|
|
</div>
|
|
<p>The value being tested against can be a Time instance, a DateTime instance, or a string with the full date time in
|
|
a manner that a new DateTime instance can understand. When passing a string as the first parameter, you can pass
|
|
a timezone string in as the second parameter. If no timezone is given, the system default will be used:</p>
|
|
<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$time1</span><span class="o">-></span><span class="na">equals</span><span class="p">(</span><span class="s1">'January 11, 2017 03:50:00'</span><span class="p">,</span> <span class="s1">'Europe/London'</span><span class="p">);</span> <span class="c1">// true</span>
|
|
</pre></div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="sameas">
|
|
<h3>sameAs()<a class="headerlink" href="#sameas" title="Permalink to this headline">¶</a></h3>
|
|
<p>This is identical to the <strong>equals</strong> method, except that it only returns true when the date, time, AND timezone are
|
|
all identical:</p>
|
|
<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$time1</span> <span class="o">=</span> <span class="nx">Time</span><span class="o">::</span><span class="na">parse</span><span class="p">(</span><span class="s1">'January 10, 2017 21:50:00'</span><span class="p">,</span> <span class="s1">'America/Chicago'</span><span class="p">);</span>
|
|
<span class="nv">$time2</span> <span class="o">=</span> <span class="nx">Time</span><span class="o">::</span><span class="na">parse</span><span class="p">(</span><span class="s1">'January 11, 2017 03:50:00'</span><span class="p">,</span> <span class="s1">'Europe/London'</span><span class="p">);</span>
|
|
|
|
<span class="nv">$time1</span><span class="o">-></span><span class="na">sameAs</span><span class="p">(</span><span class="nv">$time2</span><span class="p">);</span> <span class="c1">// false</span>
|
|
<span class="nv">$time2</span><span class="o">-></span><span class="na">sameAs</span><span class="p">(</span><span class="s1">'January 10, 2017 21:50:00'</span><span class="p">,</span> <span class="s1">'America/Chicago'</span><span class="p">);</span> <span class="c1">// true</span>
|
|
</pre></div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="isbefore">
|
|
<h3>isBefore()<a class="headerlink" href="#isbefore" title="Permalink to this headline">¶</a></h3>
|
|
<p>Checks if the passed in time is before the the current instance. The comparison is done against the UTC versions of
|
|
both times:</p>
|
|
<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$time1</span> <span class="o">=</span> <span class="nx">Time</span><span class="o">::</span><span class="na">parse</span><span class="p">(</span><span class="s1">'January 10, 2017 21:50:00'</span><span class="p">,</span> <span class="s1">'America/Chicago'</span><span class="p">);</span>
|
|
<span class="nv">$time2</span> <span class="o">=</span> <span class="nx">Time</span><span class="o">::</span><span class="na">parse</span><span class="p">(</span><span class="s1">'January 11, 2017 03:50:00'</span><span class="p">,</span> <span class="s1">'America/Chicago'</span><span class="p">);</span>
|
|
|
|
<span class="nv">$time1</span><span class="o">-></span><span class="na">isBefore</span><span class="p">(</span><span class="nv">$time2</span><span class="p">);</span> <span class="c1">// true</span>
|
|
<span class="nv">$time2</span><span class="o">-></span><span class="na">isBefore</span><span class="p">(</span><span class="nv">$time1</span><span class="p">);</span> <span class="c1">// false</span>
|
|
</pre></div>
|
|
</div>
|
|
<p>The value being tested against can be a Time instance, a DateTime instance, or a string with the full date time in
|
|
a manner that a new DateTime instance can understand. When passing a string as the first parameter, you can pass
|
|
a timezone string in as the second parameter. If no timezone is given, the system default will be used:</p>
|
|
<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$time1</span><span class="o">-></span><span class="na">isBefore</span><span class="p">(</span><span class="s1">'March 15, 2013'</span><span class="p">,</span> <span class="s1">'America/Chicago'</span><span class="p">);</span> <span class="c1">// false</span>
|
|
</pre></div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="isafter">
|
|
<h3>isAfter()<a class="headerlink" href="#isafter" title="Permalink to this headline">¶</a></h3>
|
|
<p>Works exactly the same as <strong>isBefore()</strong> except checks if the time is after the time passed in:</p>
|
|
<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$time1</span> <span class="o">=</span> <span class="nx">Time</span><span class="o">::</span><span class="na">parse</span><span class="p">(</span><span class="s1">'January 10, 2017 21:50:00'</span><span class="p">,</span> <span class="s1">'America/Chicago'</span><span class="p">);</span>
|
|
<span class="nv">$time2</span> <span class="o">=</span> <span class="nx">Time</span><span class="o">::</span><span class="na">parse</span><span class="p">(</span><span class="s1">'January 11, 2017 03:50:00'</span><span class="p">,</span> <span class="s1">'America/Chicago'</span><span class="p">);</span>
|
|
|
|
<span class="nv">$time1</span><span class="o">-></span><span class="na">isAfter</span><span class="p">(</span><span class="nv">$time2</span><span class="p">);</span> <span class="c1">// false</span>
|
|
<span class="nv">$time2</span><span class="o">-></span><span class="na">isAfter</span><span class="p">(</span><span class="nv">$time1</span><span class="p">);</span> <span class="c1">// true</span>
|
|
</pre></div>
|
|
</div>
|
|
<div class="section" id="viewing-differences">
|
|
<h4>Viewing Differences<a class="headerlink" href="#viewing-differences" title="Permalink to this headline">¶</a></h4>
|
|
<p>To compare two Times directly, you would use the <strong>difference()</strong> method, which returns a <strong>CodeIgniterI18nTimeDifference</strong>
|
|
instance. The first parameter is either a Time instance, a DateTime instance, or a string with the date/time. If
|
|
a string is passed in the first parameter, the second parameter can be a timezone string:</p>
|
|
<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$time</span> <span class="o">=</span> <span class="nx">Time</span><span class="o">::</span><span class="na">parse</span><span class="p">(</span><span class="s1">'March 10, 2017'</span><span class="p">,</span> <span class="s1">'America/Chicago'</span><span class="p">);</span>
|
|
|
|
<span class="nv">$diff</span> <span class="o">=</span> <span class="nv">$time</span><span class="o">-></span><span class="na">difference</span><span class="p">(</span><span class="nx">Time</span><span class="o">::</span><span class="na">now</span><span class="p">());</span>
|
|
<span class="nv">$diff</span> <span class="o">=</span> <span class="nv">$time</span><span class="o">-></span><span class="na">difference</span><span class="p">(</span><span class="k">new</span> <span class="nx">DateTime</span><span class="p">(</span><span class="s1">'July 4, 1975'</span><span class="p">,</span> <span class="s1">'America/Chicago'</span><span class="p">);</span>
|
|
<span class="nv">$diff</span> <span class="o">=</span> <span class="nv">$time</span><span class="o">-></span><span class="na">difference</span><span class="p">(</span><span class="s1">'July 4, 1975 13:32:05'</span><span class="p">,</span> <span class="s1">'America/Chicago'</span><span class="p">);</span>
|
|
</pre></div>
|
|
</div>
|
|
<p>Once you have the TimeDifference instance, you have several methods you can use to find information about the difference
|
|
between the two times. The value returned will be negative if it was in the past, or positive if in the future from
|
|
the original time:</p>
|
|
<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$current</span> <span class="o">=</span> <span class="nx">Time</span><span class="o">::</span><span class="na">parse</span><span class="p">(</span><span class="s1">'March 10, 2017'</span><span class="p">,</span> <span class="s1">'America/Chicago'</span><span class="p">);</span>
|
|
<span class="nv">$test</span> <span class="o">=</span> <span class="nx">Time</span><span class="o">::</span><span class="na">parse</span><span class="p">(</span><span class="s1">'March 10, 2010'</span><span class="p">,</span> <span class="s1">'America/Chicago'</span><span class="p">);</span>
|
|
|
|
<span class="nv">$diff</span> <span class="o">=</span> <span class="nv">$current</span><span class="o">-></span><span class="na">difference</span><span class="p">(</span><span class="nv">$test</span><span class="p">);</span>
|
|
|
|
<span class="k">echo</span> <span class="nv">$diff</span><span class="o">-></span><span class="na">getYears</span><span class="p">();</span> <span class="c1">// -7</span>
|
|
<span class="k">echo</span> <span class="nv">$diff</span><span class="o">-></span><span class="na">getMonths</span><span class="p">();</span> <span class="c1">// -84</span>
|
|
<span class="k">echo</span> <span class="nv">$diff</span><span class="o">-></span><span class="na">getWeeks</span><span class="p">();</span> <span class="c1">// -365</span>
|
|
<span class="k">echo</span> <span class="nv">$diff</span><span class="o">-></span><span class="na">getDays</span><span class="p">();</span> <span class="c1">// -2557</span>
|
|
<span class="k">echo</span> <span class="nv">$diff</span><span class="o">-></span><span class="na">getHours</span><span class="p">();</span> <span class="c1">// -61368</span>
|
|
<span class="k">echo</span> <span class="nv">$diff</span><span class="o">-></span><span class="na">getMinutes</span><span class="p">();</span> <span class="c1">// -3682080</span>
|
|
<span class="k">echo</span> <span class="nv">$diff</span><span class="o">-></span><span class="na">getSeconds</span><span class="p">();</span> <span class="c1">// -220924800</span>
|
|
</pre></div>
|
|
</div>
|
|
<p>You can use either <strong>getX()</strong> methods, or access the calculate values as if they were properties:</p>
|
|
<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="k">echo</span> <span class="nv">$diff</span><span class="o">-></span><span class="na">years</span><span class="p">;</span> <span class="c1">// -7</span>
|
|
<span class="k">echo</span> <span class="nv">$diff</span><span class="o">-></span><span class="na">months</span><span class="p">;</span> <span class="c1">// -84</span>
|
|
<span class="k">echo</span> <span class="nv">$diff</span><span class="o">-></span><span class="na">weeks</span><span class="p">;</span> <span class="c1">// -365</span>
|
|
<span class="k">echo</span> <span class="nv">$diff</span><span class="o">-></span><span class="na">days</span><span class="p">;</span> <span class="c1">// -2557</span>
|
|
<span class="k">echo</span> <span class="nv">$diff</span><span class="o">-></span><span class="na">hours</span><span class="p">;</span> <span class="c1">// -61368</span>
|
|
<span class="k">echo</span> <span class="nv">$diff</span><span class="o">-></span><span class="na">minutes</span><span class="p">;</span> <span class="c1">// -3682080</span>
|
|
<span class="k">echo</span> <span class="nv">$diff</span><span class="o">-></span><span class="na">seconds</span><span class="p">;</span> <span class="c1">// -220924800</span>
|
|
</pre></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="id1">
|
|
<h3>humanize()<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h3>
|
|
<p>Much like Time’s humanize() method, this returns a string that displays the difference between the times in a
|
|
human readable format that is geared towards being easily understood. It can create strings like ‘3 hours ago’,
|
|
‘in 1 month’, etc. The biggest differences are in how very recent dates are handled:</p>
|
|
<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="c1">// Assume current time is: March 10, 2017 (America/Chicago)</span>
|
|
<span class="nv">$time</span> <span class="o">=</span> <span class="nx">Time</span><span class="o">::</span><span class="na">parse</span><span class="p">(</span><span class="s1">'March 9, 2016 12:00:00'</span><span class="p">,</span> <span class="s1">'America/Chicago'</span><span class="p">);</span>
|
|
|
|
<span class="k">echo</span> <span class="nv">$time</span><span class="o">-></span><span class="na">humanize</span><span class="p">();</span> <span class="c1">// 1 year ago</span>
|
|
</pre></div>
|
|
</div>
|
|
<p>The exact time displayed is determined in the following manner:</p>
|
|
<table border="1" class="docutils">
|
|
<colgroup>
|
|
<col width="48%" />
|
|
<col width="52%" />
|
|
</colgroup>
|
|
<thead valign="bottom">
|
|
<tr class="row-odd"><th class="head">Time difference</th>
|
|
<th class="head">Result</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody valign="top">
|
|
<tr class="row-even"><td>$time > 1 year && < 2 years</td>
|
|
<td>in 1 year / 1 year ago</td>
|
|
</tr>
|
|
<tr class="row-odd"><td>$time > 1 month && < 1 year</td>
|
|
<td>in 6 months / 6 months ago</td>
|
|
</tr>
|
|
<tr class="row-even"><td>$time > 7 days && < 1 month</td>
|
|
<td>in 3 weeks / 3 weeks ago</td>
|
|
</tr>
|
|
<tr class="row-odd"><td>$time > today && < 7 days</td>
|
|
<td>in 4 days / 4 days ago</td>
|
|
</tr>
|
|
<tr class="row-even"><td>$time > 1 hour && < 1 day</td>
|
|
<td>in 8 hours / 8 hours ago</td>
|
|
</tr>
|
|
<tr class="row-odd"><td>$time > 1 minute && < 1 hour</td>
|
|
<td>in 35 minutes / 35 minutes ago</td>
|
|
</tr>
|
|
<tr class="row-even"><td>$time < 1 minute</td>
|
|
<td>Now</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p>The exact language used is controlled through the language file, Time.php.</p>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
</div>
|
|
<div class="articleComments">
|
|
|
|
</div>
|
|
</div>
|
|
<footer>
|
|
|
|
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
|
|
|
<a href="typography.html" class="btn btn-neutral float-right" title="Typography" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
|
|
|
|
|
<a href="throttler.html" class="btn btn-neutral" title="Throttler" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
|
|
|
</div>
|
|
|
|
|
|
<hr/>
|
|
|
|
<div role="contentinfo">
|
|
<p>
|
|
© Copyright 2014-2019 British Columbia Institute of Technology.
|
|
Last updated on Mar 06, 2019.
|
|
|
|
</p>
|
|
</div>
|
|
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
|
|
|
</footer>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</section>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<script type="text/javascript">
|
|
var DOCUMENTATION_OPTIONS = {
|
|
URL_ROOT:'../',
|
|
VERSION:'4.0.0-beta.1',
|
|
COLLAPSE_INDEX:false,
|
|
FILE_SUFFIX:'.html',
|
|
HAS_SOURCE: false,
|
|
SOURCELINK_SUFFIX: ''
|
|
};
|
|
</script>
|
|
<script type="text/javascript" src="../_static/jquery.js"></script>
|
|
<script type="text/javascript" src="../_static/underscore.js"></script>
|
|
<script type="text/javascript" src="../_static/doctools.js"></script>
|
|
|
|
|
|
|
|
|
|
|
|
<script type="text/javascript" src="../_static/js/theme.js"></script>
|
|
|
|
|
|
|
|
|
|
<script type="text/javascript">
|
|
jQuery(function () {
|
|
SphinxRtdTheme.StickyNav.enable();
|
|
});
|
|
</script>
|
|
|
|
|
|
</body>
|
|
</html> |