/iaLib/ia_examples/ia/Lib/iaLib_example.php

<?php

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

/iaLib/ia_examples/code/ia/Lib/iaLib_example_code.php

use ia\Lib\iaLib;
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">';



///////// iaLib::param(null /* == */); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_param'><b>iaLib::param(<span class="type"></span> \$key, <span class="type"></span> \$dflt <span class="default">= ''</span>, <span class="type"></span> \$cleanNumber <span class="default">= false</span>, <span class="type"></span> \$doStrim <span class="default">= true</span>) <span>: </span></b>
FUNCTIONDEF;

echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Lib\iaLib", "param")."</pre>";

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



    /// display ///
    echo <<< DOCUMENT_EXAMPLE
        <li>iaLib::param(null /* == */);
        -&gt;&nbsp; </b><br><pre>
DOCUMENT_EXAMPLE;
    /// run ///
        print_r(
        iaLib::param(null /* == */)
        );
        echo "</pre>";


	echo '</ol>';


///////// iaLib::get_post_trim(null /* == */); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_get_post_trim'><b>iaLib::get_post_trim(<span class="type"></span> \$key, <span class="type"></span> \$dflt <span class="default">= ''</span>) <span>: </span></b>
FUNCTIONDEF;

echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Lib\iaLib", "get_post_trim")."</pre>";

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



    /// display ///
    echo <<< DOCUMENT_EXAMPLE
        <li>iaLib::get_post_trim(null /* == */);
        -&gt;&nbsp; </b><br><pre>
DOCUMENT_EXAMPLE;
    /// run ///
        print_r(
        iaLib::get_post_trim(null /* == */)
        );
        echo "</pre>";


	echo '</ol>';


///////// iaLib::get_request(null /* == */); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_get_request'><b>iaLib::get_request(<span class="type"></span> \$key, <span class="type"></span> \$dflt <span class="default">= ''</span>) <span>: </span></b>
FUNCTIONDEF;

echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Lib\iaLib", "get_request")."</pre>";

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



    /// display ///
    echo <<< DOCUMENT_EXAMPLE
        <li>iaLib::get_request(null /* == */);
        -&gt;&nbsp; </b><br><pre>
DOCUMENT_EXAMPLE;
    /// run ///
        print_r(
        iaLib::get_request(null /* == */)
        );
        echo "</pre>";


	echo '</ol>';


///////// iaLib::get_request_raw(null /* == */); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_get_request_raw'><b>iaLib::get_request_raw(<span class="type"></span> \$key, <span class="type"></span> \$dflt <span class="default">= ''</span>) <span>: </span></b>
FUNCTIONDEF;

echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Lib\iaLib", "get_request_raw")."</pre>";

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



    /// display ///
    echo <<< DOCUMENT_EXAMPLE
        <li>iaLib::get_request_raw(null /* == */);
        -&gt;&nbsp; </b><br><pre>
DOCUMENT_EXAMPLE;
    /// run ///
        print_r(
        iaLib::get_request_raw(null /* == */)
        );
        echo "</pre>";


	echo '</ol>';


///////// iaLib::get_post_raw(null /* == */); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_get_post_raw'><b>iaLib::get_post_raw(<span class="type"></span> \$key, <span class="type"></span> \$dflt <span class="default">= ''</span>) <span>: </span></b>
FUNCTIONDEF;

echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Lib\iaLib", "get_post_raw")."</pre>";

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



    /// display ///
    echo <<< DOCUMENT_EXAMPLE
        <li>iaLib::get_post_raw(null /* == */);
        -&gt;&nbsp; </b><br><pre>
DOCUMENT_EXAMPLE;
    /// run ///
        print_r(
        iaLib::get_post_raw(null /* == */)
        );
        echo "</pre>";


	echo '</ol>';


///////// iaLib::constant2name('palabra', null /* =mixed= */); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_constant2name'><b>iaLib::constant2name(<span class="type">string</span> \$group, <span class="type">mixed</span> \$value, <span class="type">string</span> \$tag <span class="default">= 'ERR'</span>) <span>: string</span></b>
FUNCTIONDEF;

echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Lib\iaLib", "constant2name")."</pre>";

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


    /// display ///
    echo <<< DOCUMENT_EXAMPLE
        <li>iaLib::constant2name('palabra', null /* =mixed= */); -&gt;&nbsp;
DOCUMENT_EXAMPLE;
    /// run ///
         echo iaLib::constant2name('palabra', null /* =mixed= */);

	echo '</ol>';


///////// iaLib::exportTrimed(null /* =mixed= */); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_exportTrimed'><b>iaLib::exportTrimed(<span class="type">mixed</span> \$obj) <span>: string</span></b>
FUNCTIONDEF;

echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Lib\iaLib", "exportTrimed")."</pre>";

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


    /// display ///
    echo <<< DOCUMENT_EXAMPLE
        <li>iaLib::exportTrimed(null /* =mixed= */); -&gt;&nbsp;
DOCUMENT_EXAMPLE;
    /// run ///
         echo iaLib::exportTrimed(null /* =mixed= */);

	echo '</ol>';


///////// iaLib::logErrors(); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_logErrors'><b>iaLib::logErrors(<span class="type"></span> \$display <span class="default">= true</span>) <span>: </span></b>
FUNCTIONDEF;

echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Lib\iaLib", "logErrors")."</pre>";

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



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


	echo '</ol>';


///////// iaLib::ls(null /* == */); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_ls'><b>iaLib::ls(<span class="type"></span> \$dir) <span>: </span></b>
FUNCTIONDEF;

echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Lib\iaLib", "ls")."</pre>";

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



    /// display ///
    echo <<< DOCUMENT_EXAMPLE
        <li>iaLib::ls(null /* == */);
        -&gt;&nbsp; </b><br><pre>
DOCUMENT_EXAMPLE;
    /// run ///
        print_r(
        iaLib::ls(null /* == */)
        );
        echo "</pre>";


	echo '</ol>';


///////// iaLib::redirect(null /* == */, null /* == */); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_redirect'><b>iaLib::redirect(<span class="type"></span> \$localPage, <span class="type"></span> \$params) <span>: </span></b>
FUNCTIONDEF;

echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Lib\iaLib", "redirect")."</pre>";

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



    /// display ///
    echo <<< DOCUMENT_EXAMPLE
        <li>iaLib::redirect(null /* == */, null /* == */);
        -&gt;&nbsp; </b><br><pre>
DOCUMENT_EXAMPLE;
    /// run ///
        print_r(
        iaLib::redirect(null /* == */, null /* == */)
        );
        echo "</pre>";


	echo '</ol>';


///////// iaLib::is_ssl(); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_is_ssl'><b>iaLib::is_ssl() <span>: </span></b>
FUNCTIONDEF;

echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Lib\iaLib", "is_ssl")."</pre>";

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



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


	echo '</ol>';


///////// iaLib::getLogIp(); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_getLogIp'><b>iaLib::getLogIp() <span>: </span></b>
FUNCTIONDEF;

echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Lib\iaLib", "getLogIp")."</pre>";

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



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


	echo '</ol>';


///////// iaLib::getCurrentWebPath(); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_getCurrentWebPath'><b>iaLib::getCurrentWebPath() <span>: </span></b>
FUNCTIONDEF;

echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Lib\iaLib", "getCurrentWebPath")."</pre>";

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



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


	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\Lib\iaLib;
use PHPUnit\Framework\TestCase;

class iaLibTest extends TestCase {



    /**
     * @dataProvider param_Provider
     *
     */
    public function test_param($key, $dflt, $cleanNumber, $doStrim , $expected) {
        
        $this->assertEquals($expected, iaLib::param($key, $dflt, $cleanNumber, $doStrim) );
    }

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



    /**
     * @dataProvider get_post_trim_Provider
     *
     */
    public function test_get_post_trim($key, $dflt , $expected) {
        
        $this->assertEquals($expected, iaLib::get_post_trim($key, $dflt) );
    }

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



    /**
     * @dataProvider get_request_Provider
     *
     */
    public function test_get_request($key, $dflt , $expected) {
        
        $this->assertEquals($expected, iaLib::get_request($key, $dflt) );
    }

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



    /**
     * @dataProvider get_request_raw_Provider
     *
     */
    public function test_get_request_raw($key, $dflt , $expected) {
        
        $this->assertEquals($expected, iaLib::get_request_raw($key, $dflt) );
    }

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



    /**
     * @dataProvider get_post_raw_Provider
     *
     */
    public function test_get_post_raw($key, $dflt , $expected) {
        
        $this->assertEquals($expected, iaLib::get_post_raw($key, $dflt) );
    }

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



    /**
     * @dataProvider constant2name_Provider
     *
     */
    public function test_constant2name($group, $value, $tag , $expected) {
        
        $this->assertEquals($expected, iaLib::constant2name($group, $value, $tag) );
    }

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



    /**
     * @dataProvider exportTrimed_Provider
     *
     */
    public function test_exportTrimed($obj , $expected) {
        
        $this->assertEquals($expected, iaLib::exportTrimed($obj) );
    }

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



    /**
     * @dataProvider logErrors_Provider
     *
     */
    public function test_logErrors($display , $expected) {
        
        $this->assertEquals($expected, iaLib::logErrors($display) );
    }

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



    /**
     * @dataProvider ls_Provider
     *
     */
    public function test_ls($dir , $expected) {
        
        $this->assertEquals($expected, iaLib::ls($dir) );
    }

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



    /**
     * @dataProvider redirect_Provider
     *
     */
    public function test_redirect($localPage, $params , $expected) {
        
        $this->assertEquals($expected, iaLib::redirect($localPage, $params) );
    }

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



    /**
     * @dataProvider is_ssl_Provider
     *
     */
    public function test_is_ssl(  $expected) {
        
        $this->assertEquals($expected, iaLib::is_ssl() );
    }

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



    /**
     * @dataProvider getLogIp_Provider
     *
     */
    public function test_getLogIp(  $expected) {
        
        $this->assertEquals($expected, iaLib::getLogIp() );
    }

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



    /**
     * @dataProvider getCurrentWebPath_Provider
     *
     */
    public function test_getCurrentWebPath(  $expected) {
        
        $this->assertEquals($expected, iaLib::getCurrentWebPath() );
    }

        function getCurrentWebPath_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 ^🔧