/iaLib/ia_examples/ia/Sql/Mysql/QueryInfo_example.php

<?php

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

/iaLib/ia_examples/code/ia/Sql/Mysql/QueryInfo_example_code.php

use ia\Sql\Mysql\QueryInfo;
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>

/*
 \$queryInfo = new QueryInfo(<span class="type"></span> \$db);
*/

\$queryInfo = new QueryInfo(null /* == */);

</pre>
CONSTRUCTOR_PROTOTYPE;

$queryInfo = new QueryInfo(null /* == */);


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



///////// \$queryInfo->fieldName2Label(null /* == */); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_fieldName2Label'><b>\$queryInfo->fieldName2Label(<span class="type"></span> \$fieldName) <span>: </span></b>
FUNCTIONDEF;

echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Sql\Mysql\QueryInfo", "fieldName2Label")."</pre>";

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



    /// display ///
    echo <<< DOCUMENT_EXAMPLE
        <li>\$queryInfo->fieldName2Label(null /* == */);
        -&gt;&nbsp; </b><br><pre>
DOCUMENT_EXAMPLE;
    /// run ///
        print_r(
        $queryInfo->fieldName2Label(null /* == */)
        );
        echo "</pre>";


	echo '</ol>';


///////// \$queryInfo->infoForTable(null /* == */); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_infoForTable'><b>\$queryInfo->infoForTable(<span class="type"></span> \$table) <span>: </span></b>
FUNCTIONDEF;

echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Sql\Mysql\QueryInfo", "infoForTable")."</pre>";

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



    /// display ///
    echo <<< DOCUMENT_EXAMPLE
        <li>\$queryInfo->infoForTable(null /* == */);
        -&gt;&nbsp; </b><br><pre>
DOCUMENT_EXAMPLE;
    /// run ///
        print_r(
        $queryInfo->infoForTable(null /* == */)
        );
        echo "</pre>";


	echo '</ol>';


///////// \$queryInfo->infoForQuery(null /* == */); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_infoForQuery'><b>\$queryInfo->infoForQuery(<span class="type"></span> \$query) <span>: </span></b>
FUNCTIONDEF;

echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Sql\Mysql\QueryInfo", "infoForQuery")."</pre>";

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



    /// display ///
    echo <<< DOCUMENT_EXAMPLE
        <li>\$queryInfo->infoForQuery(null /* == */);
        -&gt;&nbsp; </b><br><pre>
DOCUMENT_EXAMPLE;
    /// run ///
        print_r(
        $queryInfo->infoForQuery(null /* == */)
        );
        echo "</pre>";


	echo '</ol>';


///////// \$queryInfo->fieldNames(); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_fieldNames'><b>\$queryInfo->fieldNames() <span>: </span></b>
FUNCTIONDEF;

echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Sql\Mysql\QueryInfo", "fieldNames")."</pre>";

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



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


	echo '</ol>';


///////// \$queryInfo->valuesFromRequest(); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_valuesFromRequest'><b>\$queryInfo->valuesFromRequest(<span class="type"></span> \$onlyFields <span class="default">= []</span>, <span class="type"></span> \$excludeFields <span class="default">= []</span>) <span>: </span></b>
FUNCTIONDEF;

echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Sql\Mysql\QueryInfo", "valuesFromRequest")."</pre>";

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



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


	echo '</ol>';


///////// \$queryInfo->valuesValid(null /* == */); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_valuesValid'><b>\$queryInfo->valuesValid(<span class="type"></span> \$values) <span>: </span></b>
FUNCTIONDEF;

echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Sql\Mysql\QueryInfo", "valuesValid")."</pre>";

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



    /// display ///
    echo <<< DOCUMENT_EXAMPLE
        <li>\$queryInfo->valuesValid(null /* == */);
        -&gt;&nbsp; </b><br><pre>
DOCUMENT_EXAMPLE;
    /// run ///
        print_r(
        $queryInfo->valuesValid(null /* == */)
        );
        echo "</pre>";


	echo '</ol>';


///////// \$queryInfo->uniqueIndexesValid(null /* == */, null /* == */); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_uniqueIndexesValid'><b>\$queryInfo->uniqueIndexesValid(<span class="type"></span> \$tableName, <span class="type"></span> \$values) <span>: </span></b>
FUNCTIONDEF;

echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Sql\Mysql\QueryInfo", "uniqueIndexesValid")."</pre>";

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



    /// display ///
    echo <<< DOCUMENT_EXAMPLE
        <li>\$queryInfo->uniqueIndexesValid(null /* == */, null /* == */);
        -&gt;&nbsp; </b><br><pre>
DOCUMENT_EXAMPLE;
    /// run ///
        print_r(
        $queryInfo->uniqueIndexesValid(null /* == */, null /* == */)
        );
        echo "</pre>";


	echo '</ol>';


///////// \$queryInfo->primaryKeyWhere(null /* == */, null /* == */); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_primaryKeyWhere'><b>\$queryInfo->primaryKeyWhere(<span class="type"></span> \$tableName, <span class="type"></span> \$values) <span>: </span></b>
FUNCTIONDEF;

echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Sql\Mysql\QueryInfo", "primaryKeyWhere")."</pre>";

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



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

class QueryInfoTest extends TestCase {



    /**
     * @dataProvider fieldName2Label_Provider
     *
     */
    public function test_fieldName2Label($fieldName , $expected) {
        $queryInfo = new QueryInfo($db);
        $this->assertEquals($expected, $queryInfo->fieldName2Label($fieldName) );
    }

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



    /**
     * @dataProvider infoForTable_Provider
     *
     */
    public function test_infoForTable($table , $expected) {
        $queryInfo = new QueryInfo($db);
        $this->assertEquals($expected, $queryInfo->infoForTable($table) );
    }

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



    /**
     * @dataProvider infoForQuery_Provider
     *
     */
    public function test_infoForQuery($query , $expected) {
        $queryInfo = new QueryInfo($db);
        $this->assertEquals($expected, $queryInfo->infoForQuery($query) );
    }

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



    /**
     * @dataProvider fieldNames_Provider
     *
     */
    public function test_fieldNames(  $expected) {
        $queryInfo = new QueryInfo($db);
        $this->assertEquals($expected, $queryInfo->fieldNames() );
    }

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



    /**
     * @dataProvider valuesFromRequest_Provider
     *
     */
    public function test_valuesFromRequest($onlyFields, $excludeFields , $expected) {
        $queryInfo = new QueryInfo($db);
        $this->assertEquals($expected, $queryInfo->valuesFromRequest($onlyFields, $excludeFields) );
    }

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



    /**
     * @dataProvider valuesValid_Provider
     *
     */
    public function test_valuesValid($values , $expected) {
        $queryInfo = new QueryInfo($db);
        $this->assertEquals($expected, $queryInfo->valuesValid($values) );
    }

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



    /**
     * @dataProvider uniqueIndexesValid_Provider
     *
     */
    public function test_uniqueIndexesValid($tableName, $values , $expected) {
        $queryInfo = new QueryInfo($db);
        $this->assertEquals($expected, $queryInfo->uniqueIndexesValid($tableName, $values) );
    }

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



    /**
     * @dataProvider primaryKeyWhere_Provider
     *
     */
    public function test_primaryKeyWhere($tableName, $values , $expected) {
        $queryInfo = new QueryInfo($db);
        $this->assertEquals($expected, $queryInfo->primaryKeyWhere($tableName, $values) );
    }

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