/iaLib/ia_examples/ia/Lib/iaParametros_example.php

<?php

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

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

use ia\Lib\iaParametros;
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 <<< CONSTRUCTOR_PROTOTYPE
            <pre>
/**
     * constructor
     *
     * @param object \$db
     * @return void
     */
/*
 \$iaParametros = new iaParametros(<span class="type">object</span> \$db);
*/

\$iaParametros = new iaParametros(null /* =object= */);

</pre>
CONSTRUCTOR_PROTOTYPE;

$iaParametros = new iaParametros(null /* =object= */);


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



///////// \$iaParametros->colModelDef(); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_colModelDef'><b>\$iaParametros->colModelDef() <span>: array</span></b>
FUNCTIONDEF;

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

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



    /// display ///
    echo <<< DOCUMENT_EXAMPLE
        <li>\$iaParametros->colModelDef();
        -&gt;&nbsp; </b><br><pre>
DOCUMENT_EXAMPLE;
    /// run ///
        print_r(
        $iaParametros->colModelDef()
        );
        echo "</pre>";


	echo '</ol>';


///////// \$iaParametros->get_all(); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_get_all'><b>\$iaParametros->get_all() <span>: array</span></b>
FUNCTIONDEF;

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

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



    /// display ///
    echo <<< DOCUMENT_EXAMPLE
        <li>\$iaParametros->get_all();
        -&gt;&nbsp; </b><br><pre>
DOCUMENT_EXAMPLE;
    /// run ///
        print_r(
        $iaParametros->get_all()
        );
        echo "</pre>";


	echo '</ol>';


///////// \$iaParametros->get_value('palabra'); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_get_value'><b>\$iaParametros->get_value(<span class="type">string</span> \$key) <span>: mixed</span></b>
FUNCTIONDEF;

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

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



    /// display ///
    echo <<< DOCUMENT_EXAMPLE
        <li>\$iaParametros->get_value('palabra');
        -&gt;&nbsp; </b><br><pre>
DOCUMENT_EXAMPLE;
    /// run ///
        print_r(
        $iaParametros->get_value('palabra')
        );
        echo "</pre>";


	echo '</ol>';


///////// \$iaParametros->has_key('palabra'); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_has_key'><b>\$iaParametros->has_key(<span class="type">string</span> \$key) <span>: bool</span></b>
FUNCTIONDEF;

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

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



    /// display ///
    echo <<< DOCUMENT_EXAMPLE
        <li>\$iaParametros->has_key('palabra'); -&gt;&nbsp;
DOCUMENT_EXAMPLE;
    ///run ///
     echo ($iaParametros->has_key('palabra') ? 'true' : 'false');


	echo '</ol>';


///////// \$iaParametros->get_fromDb(); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_get_fromDb'><b>\$iaParametros->get_fromDb() <span>: array</span></b>
FUNCTIONDEF;

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

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



    /// display ///
    echo <<< DOCUMENT_EXAMPLE
        <li>\$iaParametros->get_fromDb();
        -&gt;&nbsp; </b><br><pre>
DOCUMENT_EXAMPLE;
    /// run ///
        print_r(
        $iaParametros->get_fromDb()
        );
        echo "</pre>";


	echo '</ol>';


///////// \$iaParametros->set_all(['a' => '1', 'b' => '2', 'c' => 3]); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_set_all'><b>\$iaParametros->set_all(<span class="type">array</span> \$parametros) <span>: void</span></b>
FUNCTIONDEF;

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

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



    /// display ///
    echo <<< DOCUMENT_EXAMPLE
        <li>\$iaParametros->set_all(['a' => '1', 'b' => '2', 'c' => 3]);"
DOCUMENT_EXAMPLE;
    /// run ///
         echo $iaParametros->set_all(['a' => '1', 'b' => '2', 'c' => 3]);


	echo '</ol>';


///////// \$iaParametros->set_value('palabra', null /* =mixed= */); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_set_value'><b>\$iaParametros->set_value(<span class="type">string</span> \$key, <span class="type">mixed</span> \$value) <span>: void</span></b>
FUNCTIONDEF;

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

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



    /// display ///
    echo <<< DOCUMENT_EXAMPLE
        <li>\$iaParametros->set_value('palabra', null /* =mixed= */);"
DOCUMENT_EXAMPLE;
    /// run ///
         echo $iaParametros->set_value('palabra', null /* =mixed= */);


	echo '</ol>';


///////// \$iaParametros->get_colModel(); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_get_colModel'><b>\$iaParametros->get_colModel(<span class="type"></span> \$excludeColumns <span class="default">= []</span>) <span>: array</span></b>
FUNCTIONDEF;

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

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



    /// display ///
    echo <<< DOCUMENT_EXAMPLE
        <li>\$iaParametros->get_colModel();
        -&gt;&nbsp; </b><br><pre>
DOCUMENT_EXAMPLE;
    /// run ///
        print_r(
        $iaParametros->get_colModel()
        );
        echo "</pre>";


	echo '</ol>';


///////// \$iaParametros->colModel2js(null /* == */); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_colModel2js'><b>\$iaParametros->colModel2js(<span class="type"></span> \$colModel, <span class="type"></span> \$indent <span class="default">= 1</span>) <span>: </span></b>
FUNCTIONDEF;

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

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



    /// display ///
    echo <<< DOCUMENT_EXAMPLE
        <li>\$iaParametros->colModel2js(null /* == */);
        -&gt;&nbsp; </b><br><pre>
DOCUMENT_EXAMPLE;
    /// run ///
        print_r(
        $iaParametros->colModel2js(null /* == */)
        );
        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\iaParametros;
use PHPUnit\Framework\TestCase;

class iaParametrosTest extends TestCase {



    /**
     * @dataProvider colModelDef_Provider
     *
     */
    public function test_colModelDef(  $expected) {
        $iaParametros = new iaParametros($db);
        $this->assertEquals($expected, $iaParametros->colModelDef() );
    }

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



    /**
     * @dataProvider get_all_Provider
     *
     */
    public function test_get_all(  $expected) {
        $iaParametros = new iaParametros($db);
        $this->assertEquals($expected, $iaParametros->get_all() );
    }

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



    /**
     * @dataProvider get_value_Provider
     *
     */
    public function test_get_value($key , $expected) {
        $iaParametros = new iaParametros($db);
        $this->assertEquals($expected, $iaParametros->get_value($key) );
    }

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



    /**
     * @dataProvider has_key_Provider
     *
     */
    public function test_has_key($key , $expected) {
        $iaParametros = new iaParametros($db);
        $this->assertEquals($expected, $iaParametros->has_key($key) );
    }

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



    /**
     * @dataProvider get_fromDb_Provider
     *
     */
    public function test_get_fromDb(  $expected) {
        $iaParametros = new iaParametros($db);
        $this->assertEquals($expected, $iaParametros->get_fromDb() );
    }

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



    /**
     * @dataProvider set_all_Provider
     *
     */
    public function test_set_all($parametros , $expected) {
        $iaParametros = new iaParametros($db);
        $this->assertEquals($expected, $iaParametros->set_all($parametros) );
    }

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



    /**
     * @dataProvider set_value_Provider
     *
     */
    public function test_set_value($key, $value , $expected) {
        $iaParametros = new iaParametros($db);
        $this->assertEquals($expected, $iaParametros->set_value($key, $value) );
    }

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



    /**
     * @dataProvider get_colModel_Provider
     *
     */
    public function test_get_colModel($excludeColumns , $expected) {
        $iaParametros = new iaParametros($db);
        $this->assertEquals($expected, $iaParametros->get_colModel($excludeColumns) );
    }

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



    /**
     * @dataProvider colModel2js_Provider
     *
     */
    public function test_colModel2js($colModel, $indent , $expected) {
        $iaParametros = new iaParametros($db);
        $this->assertEquals($expected, $iaParametros->colModel2js($colModel, $indent) );
    }

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