/iaLib/ia_examples/ia/Lib/iaReMapKeys_example.php

<?php

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

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

use ia\Lib\iaReMapKeys;
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>
/**
     * Maps rowIn[\$inKey] to rowsKeyed[\$key] using header row to define the mapping
     *
     * @param array \$headerKeys ['key1', 'key2', ...]
     * @param array \$headerSynonyms ['Synonym1_1'=>'key1', 'Synonym1_2'=>'key1', 'Synonym2_1'=>'key2', ...] default []
     * @param array \$defaultByKey ['key2'=>defaultValueKey2,...] default []
     * @return void
     */
/*
 \$iaReMapKeys = new iaReMapKeys(<span class="type">array</span> \$headerKeys, <span class="type">array</span> \$headerSynonyms <span class="default">= []</span>, <span class="type">array</span> \$defaultByKey <span class="default">= []</span>);
*/

\$iaReMapKeys = new iaReMapKeys(['a' => '1', 'b' => '2', 'c' => 3]);

</pre>
CONSTRUCTOR_PROTOTYPE;

$iaReMapKeys = new iaReMapKeys(['a' => '1', 'b' => '2', 'c' => 3]);


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



///////// \$iaReMapKeys->mapHeaderRow(['a' => '1', 'b' => '2', 'c' => 3]); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_mapHeaderRow'><b>\$iaReMapKeys->mapHeaderRow(<span class="type">array</span> \$headerRow) <span>: bool</span></b>
FUNCTIONDEF;

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

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



    /// display ///
    echo <<< DOCUMENT_EXAMPLE
        <li>\$iaReMapKeys->mapHeaderRow(['a' => '1', 'b' => '2', 'c' => 3]); -&gt;&nbsp;
DOCUMENT_EXAMPLE;
    ///run ///
     echo ($iaReMapKeys->mapHeaderRow(['a' => '1', 'b' => '2', 'c' => 3]) ? 'true' : 'false');


	echo '</ol>';


///////// \$iaReMapKeys->getHeadersDuplicated(); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_getHeadersDuplicated'><b>\$iaReMapKeys->getHeadersDuplicated() <span>: array</span></b>
FUNCTIONDEF;

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

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



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


	echo '</ol>';


///////// \$iaReMapKeys->getHeaderMap(); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_getHeaderMap'><b>\$iaReMapKeys->getHeaderMap() <span>: array</span></b>
FUNCTIONDEF;

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

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



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


	echo '</ol>';


///////// \$iaReMapKeys->getHeaderMissing(); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_getHeaderMissing'><b>\$iaReMapKeys->getHeaderMissing() <span>: array</span></b>
FUNCTIONDEF;

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

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



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


	echo '</ol>';


///////// \$iaReMapKeys->getHeaderMissingWithoutDefaults(); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_getHeaderMissingWithoutDefaults'><b>\$iaReMapKeys->getHeaderMissingWithoutDefaults() <span>: array</span></b>
FUNCTIONDEF;

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

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



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


	echo '</ol>';


///////// \$iaReMapKeys->row2key(['a' => '1', 'b' => '2', 'c' => 3]); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_row2key'><b>\$iaReMapKeys->row2key(<span class="type">array</span> \$rawRow) <span>: array</span></b>
FUNCTIONDEF;

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

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



    /// display ///
    echo <<< DOCUMENT_EXAMPLE
        <li>\$iaReMapKeys->row2key(['a' => '1', 'b' => '2', 'c' => 3]);
        -&gt;&nbsp; </b><br><pre>
DOCUMENT_EXAMPLE;
    /// run ///
        print_r(
        $iaReMapKeys->row2key(['a' => '1', 'b' => '2', 'c' => 3])
        );
        echo "</pre>";


	echo '</ol>';


///////// \$iaReMapKeys->isLastRowEmpty(); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_isLastRowEmpty'><b>\$iaReMapKeys->isLastRowEmpty() <span>: boolean</span></b>
FUNCTIONDEF;

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

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



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


	echo '</ol>';


///////// \$iaReMapKeys->getRowKeysMissing(['a' => '1', 'b' => '2', 'c' => 3]); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_getRowKeysMissing'><b>\$iaReMapKeys->getRowKeysMissing(<span class="type">array</span> \$rowKeyed) <span>: array</span></b>
FUNCTIONDEF;

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

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



    /// display ///
    echo <<< DOCUMENT_EXAMPLE
        <li>\$iaReMapKeys->getRowKeysMissing(['a' => '1', 'b' => '2', 'c' => 3]);
        -&gt;&nbsp; </b><br><pre>
DOCUMENT_EXAMPLE;
    /// run ///
        print_r(
        $iaReMapKeys->getRowKeysMissing(['a' => '1', 'b' => '2', 'c' => 3])
        );
        echo "</pre>";


	echo '</ol>';


///////// \$iaReMapKeys->getRowKeysEmpty(['a' => '1', 'b' => '2', 'c' => 3]); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_getRowKeysEmpty'><b>\$iaReMapKeys->getRowKeysEmpty(<span class="type">array</span> \$rowKeyed) <span>: array</span></b>
FUNCTIONDEF;

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

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



    /// display ///
    echo <<< DOCUMENT_EXAMPLE
        <li>\$iaReMapKeys->getRowKeysEmpty(['a' => '1', 'b' => '2', 'c' => 3]);
        -&gt;&nbsp; </b><br><pre>
DOCUMENT_EXAMPLE;
    /// run ///
        print_r(
        $iaReMapKeys->getRowKeysEmpty(['a' => '1', 'b' => '2', 'c' => 3])
        );
        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\iaReMapKeys;
use PHPUnit\Framework\TestCase;

class iaReMapKeysTest extends TestCase {



    /**
     * @dataProvider mapHeaderRow_Provider
     *
     */
    public function test_mapHeaderRow($headerRow , $expected) {
        $iaReMapKeys = new iaReMapKeys($headerKeys, $headerSynonyms, $defaultByKey);
        $this->assertEquals($expected, $iaReMapKeys->mapHeaderRow($headerRow) );
    }

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



    /**
     * @dataProvider getHeadersDuplicated_Provider
     *
     */
    public function test_getHeadersDuplicated(  $expected) {
        $iaReMapKeys = new iaReMapKeys($headerKeys, $headerSynonyms, $defaultByKey);
        $this->assertEquals($expected, $iaReMapKeys->getHeadersDuplicated() );
    }

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



    /**
     * @dataProvider getHeaderMap_Provider
     *
     */
    public function test_getHeaderMap(  $expected) {
        $iaReMapKeys = new iaReMapKeys($headerKeys, $headerSynonyms, $defaultByKey);
        $this->assertEquals($expected, $iaReMapKeys->getHeaderMap() );
    }

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



    /**
     * @dataProvider getHeaderMissing_Provider
     *
     */
    public function test_getHeaderMissing(  $expected) {
        $iaReMapKeys = new iaReMapKeys($headerKeys, $headerSynonyms, $defaultByKey);
        $this->assertEquals($expected, $iaReMapKeys->getHeaderMissing() );
    }

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



    /**
     * @dataProvider getHeaderMissingWithoutDefaults_Provider
     *
     */
    public function test_getHeaderMissingWithoutDefaults(  $expected) {
        $iaReMapKeys = new iaReMapKeys($headerKeys, $headerSynonyms, $defaultByKey);
        $this->assertEquals($expected, $iaReMapKeys->getHeaderMissingWithoutDefaults() );
    }

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



    /**
     * @dataProvider row2key_Provider
     *
     */
    public function test_row2key($rawRow , $expected) {
        $iaReMapKeys = new iaReMapKeys($headerKeys, $headerSynonyms, $defaultByKey);
        $this->assertEquals($expected, $iaReMapKeys->row2key($rawRow) );
    }

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



    /**
     * @dataProvider isLastRowEmpty_Provider
     *
     */
    public function test_isLastRowEmpty(  $expected) {
        $iaReMapKeys = new iaReMapKeys($headerKeys, $headerSynonyms, $defaultByKey);
        $this->assertEquals($expected, $iaReMapKeys->isLastRowEmpty() );
    }

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



    /**
     * @dataProvider getRowKeysMissing_Provider
     *
     */
    public function test_getRowKeysMissing($rowKeyed , $expected) {
        $iaReMapKeys = new iaReMapKeys($headerKeys, $headerSynonyms, $defaultByKey);
        $this->assertEquals($expected, $iaReMapKeys->getRowKeysMissing($rowKeyed) );
    }

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



    /**
     * @dataProvider getRowKeysEmpty_Provider
     *
     */
    public function test_getRowKeysEmpty($rowKeyed , $expected) {
        $iaReMapKeys = new iaReMapKeys($headerKeys, $headerSynonyms, $defaultByKey);
        $this->assertEquals($expected, $iaReMapKeys->getRowKeysEmpty($rowKeyed) );
    }

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