/iaLib/ia_examples/ia/Date/DateUtil_example.php

<?php

    $ia_example = [
        'title' => 'ia\Date\DateUtil', // fully qualified className
        'summary' => '', // class summary
        'full_example' => '', // full usage example, relative path from ia_examples, blank '' not shown.
        'example_file' => 'code/ia/Date/DateUtil_example_code.php', // method by method example, blank '' not shown.
    ];
     include( __DIR__ . '/../../template/ia_example_class.php');

/iaLib/ia_examples/code/ia/Date/DateUtil_example_code.php

use ia\Date\DateUtil;
use ia\DocumentIt\DocumentIt;

echo '<h3>Disclaimer: Auto generated file.
                Please help us setting parameters to useful values and extending the examples.
        </h3>';

try {


echo '<ul class="usage">';



///////// DateUtil::validYMD('palabra'); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_validYMD'><b>DateUtil::validYMD(<span class="type">string</span> \$ymd) <span>: bool</span></b>
FUNCTIONDEF;

echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Date\DateUtil", "validYMD")."</pre>";

echo "<ol class='usage'>";



    /// display ///
    echo <<< DOCUMENT_EXAMPLE
        <li>DateUtil::validYMD('palabra'); -&gt;&nbsp;
DOCUMENT_EXAMPLE;
    ///run ///
     echo (DateUtil::validYMD('palabra') ? 'true' : 'false');


	echo '</ol>';


///////// DateUtil::roundToNearestMinuteInterval(3); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_roundToNearestMinuteInterval'><b>DateUtil::roundToNearestMinuteInterval(<span class="type">DateTimeInterface</span> \$dateTime, <span class="type">int</span> \$minuteInterval <span class="default">= 10</span>) <span>: DateTimeImmutable|false</span></b>
FUNCTIONDEF;

echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Date\DateUtil", "roundToNearestMinuteInterval")."</pre>";

echo "<ol class='usage'>";



    /// display ///
    echo <<< DOCUMENT_EXAMPLE
        <li>DateUtil::roundToNearestMinuteInterval(3);
        -&gt;&nbsp; </b><br><pre>
DOCUMENT_EXAMPLE;
    /// run ///
        print_r(
        DateUtil::roundToNearestMinuteInterval(3)
        );
        echo "</pre>";


	echo '</ol>';


///////// DateUtil::roundUpToMinuteInterval(3); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_roundUpToMinuteInterval'><b>DateUtil::roundUpToMinuteInterval(<span class="type">DateTimeInterface</span> \$dateTime, <span class="type">int</span> \$minuteInterval <span class="default">= 10</span>) <span>: DateTimeImmutable|false</span></b>
FUNCTIONDEF;

echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Date\DateUtil", "roundUpToMinuteInterval")."</pre>";

echo "<ol class='usage'>";



    /// display ///
    echo <<< DOCUMENT_EXAMPLE
        <li>DateUtil::roundUpToMinuteInterval(3);
        -&gt;&nbsp; </b><br><pre>
DOCUMENT_EXAMPLE;
    /// run ///
        print_r(
        DateUtil::roundUpToMinuteInterval(3)
        );
        echo "</pre>";


	echo '</ol>';


///////// DateUtil::roundDownToMinuteInterval(3); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_roundDownToMinuteInterval'><b>DateUtil::roundDownToMinuteInterval(<span class="type">DateTimeInterface</span> \$dateTime, <span class="type">int</span> \$minuteInterval <span class="default">= 10</span>) <span>: DateTimeImmutable|false</span></b>
FUNCTIONDEF;

echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Date\DateUtil", "roundDownToMinuteInterval")."</pre>";

echo "<ol class='usage'>";



    /// display ///
    echo <<< DOCUMENT_EXAMPLE
        <li>DateUtil::roundDownToMinuteInterval(3);
        -&gt;&nbsp; </b><br><pre>
DOCUMENT_EXAMPLE;
    /// run ///
        print_r(
        DateUtil::roundDownToMinuteInterval(3)
        );
        echo "</pre>";


	echo '</ol>';


///////// DateUtil::quarter(3); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_quarter'><b>DateUtil::quarter(<span class="type">string|integer|DateTimeInterface</span> \$anyDate) <span>: int</span></b>
FUNCTIONDEF;

echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Date\DateUtil", "quarter")."</pre>";

echo "<ol class='usage'>";


    /// display ///
    echo <<< DOCUMENT_EXAMPLE
        <li>DateUtil::quarter(3); -&gt;&nbsp;
DOCUMENT_EXAMPLE;
    /// run ///
         echo DateUtil::quarter(3);

	echo '</ol>';


///////// DateUtil::dayOfWeek(3); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_dayOfWeek'><b>DateUtil::dayOfWeek(<span class="type">string|integer|DateTimeInterface</span> \$anyDate) <span>: int</span></b>
FUNCTIONDEF;

echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Date\DateUtil", "dayOfWeek")."</pre>";

echo "<ol class='usage'>";


    /// display ///
    echo <<< DOCUMENT_EXAMPLE
        <li>DateUtil::dayOfWeek(3); -&gt;&nbsp;
DOCUMENT_EXAMPLE;
    /// run ///
         echo DateUtil::dayOfWeek(3);

	echo '</ol>';


///////// DateUtil::toYmd(3); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_toYmd'><b>DateUtil::toYmd(<span class="type">string|integer|DateTime|DateTimeImmutable</span> \$anyDate) <span>: string</span></b>
FUNCTIONDEF;

echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Date\DateUtil", "toYmd")."</pre>";

echo "<ol class='usage'>";


    /// display ///
    echo <<< DOCUMENT_EXAMPLE
        <li>DateUtil::toYmd(3); -&gt;&nbsp;
DOCUMENT_EXAMPLE;
    /// run ///
         echo DateUtil::toYmd(3);

	echo '</ol>';


///////// DateUtil::toDateImmutable(3); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_toDateImmutable'><b>DateUtil::toDateImmutable(<span class="type">string|integer|DateTime|DateTimeImmutable</span> \$anyDate) <span>: DateTimeImmutable|false</span></b>
FUNCTIONDEF;

echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Date\DateUtil", "toDateImmutable")."</pre>";

echo "<ol class='usage'>";



    /// display ///
    echo <<< DOCUMENT_EXAMPLE
        <li>DateUtil::toDateImmutable(3);
        -&gt;&nbsp; </b><br><pre>
DOCUMENT_EXAMPLE;
    /// run ///
        print_r(
        DateUtil::toDateImmutable(3)
        );
        echo "</pre>";


	echo '</ol>';


///////// DateUtil::toDateTimeImmutable(3); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_toDateTimeImmutable'><b>DateUtil::toDateTimeImmutable(<span class="type">string|integer|DateTimeInterface|DateTime</span> \$anyDate) <span>: DateTimeImmutable</span></b>
FUNCTIONDEF;

echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Date\DateUtil", "toDateTimeImmutable")."</pre>";

echo "<ol class='usage'>";



    /// display ///
    echo <<< DOCUMENT_EXAMPLE
        <li>DateUtil::toDateTimeImmutable(3);
        -&gt;&nbsp; </b><br><pre>
DOCUMENT_EXAMPLE;
    /// run ///
        print_r(
        DateUtil::toDateTimeImmutable(3)
        );
        echo "</pre>";


	echo '</ol>';


///////// DateUtil::toDateHourImmutable(3); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_toDateHourImmutable'><b>DateUtil::toDateHourImmutable(<span class="type">string|integer|DateTimeInterface|DateTime</span> \$anyDate) <span>: DateTimeImmutable</span></b>
FUNCTIONDEF;

echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Date\DateUtil", "toDateHourImmutable")."</pre>";

echo "<ol class='usage'>";



    /// display ///
    echo <<< DOCUMENT_EXAMPLE
        <li>DateUtil::toDateHourImmutable(3);
        -&gt;&nbsp; </b><br><pre>
DOCUMENT_EXAMPLE;
    /// run ///
        print_r(
        DateUtil::toDateHourImmutable(3)
        );
        echo "</pre>";


	echo '</ol>';


///////// DateUtil::ordered(new DateTimeImmutable(), new DateTimeImmutable()); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_ordered'><b>DateUtil::ordered(<span class="type">DateTimeImmutable</span> &\$start, <span class="type">DateTimeImmutable</span> &\$end) <span>: int</span></b>
FUNCTIONDEF;

echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Date\DateUtil", "ordered")."</pre>";

echo "<ol class='usage'>";


    /// display ///
    echo <<< DOCUMENT_EXAMPLE
        <li>DateUtil::ordered(new DateTimeImmutable(), new DateTimeImmutable()); -&gt;&nbsp;
DOCUMENT_EXAMPLE;
    /// run ///
        //  echo DateUtil::ordered(new DateTimeImmutable(), new DateTimeImmutable());

	echo '</ol>';


/* PerfilExample adds new methods here */

echo '</ul>';

} catch(Exception $exception) { echo "<pre class='errorBlock'>$exception</pre>"; }

phpunit test file template

<?php

use ia\Date\DateUtil;
use PHPUnit\Framework\TestCase;

class DateUtilTest extends TestCase {



    /**
     * @dataProvider validYMD_Provider
     *
     */
    public function test_validYMD($ymd , $expected) {
        
        $this->assertEquals($expected, DateUtil::validYMD($ymd) );
    }

        function validYMD_Provider() {
            return [
                'test 1' => [ '', '' ],
            ];
        }



    /**
     * @dataProvider roundToNearestMinuteInterval_Provider
     *
     */
    public function test_roundToNearestMinuteInterval($dateTime, $minuteInterval , $expected) {
        
        $this->assertEquals($expected, DateUtil::roundToNearestMinuteInterval($dateTime, $minuteInterval) );
    }

        function roundToNearestMinuteInterval_Provider() {
            return [
                'test 1' => [ '', '', '' ],
            ];
        }



    /**
     * @dataProvider roundUpToMinuteInterval_Provider
     *
     */
    public function test_roundUpToMinuteInterval($dateTime, $minuteInterval , $expected) {
        
        $this->assertEquals($expected, DateUtil::roundUpToMinuteInterval($dateTime, $minuteInterval) );
    }

        function roundUpToMinuteInterval_Provider() {
            return [
                'test 1' => [ '', '', '' ],
            ];
        }



    /**
     * @dataProvider roundDownToMinuteInterval_Provider
     *
     */
    public function test_roundDownToMinuteInterval($dateTime, $minuteInterval , $expected) {
        
        $this->assertEquals($expected, DateUtil::roundDownToMinuteInterval($dateTime, $minuteInterval) );
    }

        function roundDownToMinuteInterval_Provider() {
            return [
                'test 1' => [ '', '', '' ],
            ];
        }



    /**
     * @dataProvider quarter_Provider
     *
     */
    public function test_quarter($anyDate , $expected) {
        
        $this->assertEquals($expected, DateUtil::quarter($anyDate) );
    }

        function quarter_Provider() {
            return [
                'test 1' => [ '', '' ],
            ];
        }



    /**
     * @dataProvider dayOfWeek_Provider
     *
     */
    public function test_dayOfWeek($anyDate , $expected) {
        
        $this->assertEquals($expected, DateUtil::dayOfWeek($anyDate) );
    }

        function dayOfWeek_Provider() {
            return [
                'test 1' => [ '', '' ],
            ];
        }



    /**
     * @dataProvider toYmd_Provider
     *
     */
    public function test_toYmd($anyDate , $expected) {
        
        $this->assertEquals($expected, DateUtil::toYmd($anyDate) );
    }

        function toYmd_Provider() {
            return [
                'test 1' => [ '', '' ],
            ];
        }



    /**
     * @dataProvider toDateImmutable_Provider
     *
     */
    public function test_toDateImmutable($anyDate , $expected) {
        
        $this->assertEquals($expected, DateUtil::toDateImmutable($anyDate) );
    }

        function toDateImmutable_Provider() {
            return [
                'test 1' => [ '', '' ],
            ];
        }



    /**
     * @dataProvider toDateTimeImmutable_Provider
     *
     */
    public function test_toDateTimeImmutable($anyDate , $expected) {
        
        $this->assertEquals($expected, DateUtil::toDateTimeImmutable($anyDate) );
    }

        function toDateTimeImmutable_Provider() {
            return [
                'test 1' => [ '', '' ],
            ];
        }



    /**
     * @dataProvider toDateHourImmutable_Provider
     *
     */
    public function test_toDateHourImmutable($anyDate , $expected) {
        
        $this->assertEquals($expected, DateUtil::toDateHourImmutable($anyDate) );
    }

        function toDateHourImmutable_Provider() {
            return [
                'test 1' => [ '', '' ],
            ];
        }



    /**
     * @dataProvider ordered_Provider
     *
     */
    public function test_ordered($start, $end , $expected) {
        
        $this->assertEquals($expected, DateUtil::ordered($start, $end) );
    }

        function ordered_Provider() {
            return [
                'test 1' => [ '', '', '' ],
            ];
        }


}

ia Doc

AesCipher ^🔧
iaLibAutoLoader ^🔧
iaSqlite ^🔧
ia
- Data
  - MexicoEstados ^🔧
- Date
- DevTools
  - iaTimer ^🔧
- DocumentIt
  - DocumentIt ^🔧
  - PerfilExample ^🔧
- JqGrid
  - Filter2where ^🔧
  - JqGridRead ^🔧
- Lib
- Math
- Sql
  - Mysql
- Util
- Work
  - WorkDay
  - Workflow
PushId ^🔧
URLify ^🔧
XLSXWriter ^🔧