/iaLib/ia_examples/ia/Sql/Mysql/MultipleInsert_example.php
<?php
$ia_example = [
'title' => 'ia\Sql\Mysql\MultipleInsert', // 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/MultipleInsert_example_code.php', // method by method example, blank '' not shown.
];
include( __DIR__ . '/../../../template/ia_example_class.php');
/iaLib/ia_examples/code/ia/Sql/Mysql/MultipleInsert_example_code.php
use ia\Sql\Mysql\MultipleInsert;
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>
/**
* MultipleInsert::__construct()
*
* @param IaMysqli \$db
* @param string \$insertIntoClause
* @param string \$onDuplicateClause
* @param integer \$maxLength
* @param bool \$simulate
* @return
*/
/*
\$multipleInsert = new MultipleInsert(<span class="type">IaMysqli</span> \$db, <span class="type">string</span> \$insertIntoClause, <span class="type">string</span> \$onDuplicateClause <span class="default">= ''</span>, <span class="type">integer</span> \$maxLength <span class="default">= 5000</span>, <span class="type">bool</span> \$simulate <span class="default">= false</span>);
*/
\$multipleInsert = new MultipleInsert($gSqlClass, 'palabra');
</pre>
CONSTRUCTOR_PROTOTYPE;
$multipleInsert = new MultipleInsert($gSqlClass, 'palabra');
echo '<ul class="usage">';
///////// \$multipleInsert->valuesArray(['a' => '1', 'b' => '2', 'c' => 3]); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_valuesArray'><b>\$multipleInsert->valuesArray(<span class="type">array</span> \$values, <span class="type">array</span> \$fieldNameDontQuote <span class="default">= []</span>) <span>: bool</span></b>
FUNCTIONDEF;
echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Sql\Mysql\MultipleInsert", "valuesArray")."</pre>";
echo "<ol class='usage'>";
/// display ///
echo <<< DOCUMENT_EXAMPLE
<li>\$multipleInsert->valuesArray(['a' => '1', 'b' => '2', 'c' => 3]); ->
DOCUMENT_EXAMPLE;
///run ///
echo ($multipleInsert->valuesArray(['a' => '1', 'b' => '2', 'c' => 3]) ? 'true' : 'false');
echo '</ol>';
///////// \$multipleInsert->insertAllArrayOfValues(['a' => '1', 'b' => '2', 'c' => 3]); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_insertAllArrayOfValues'><b>\$multipleInsert->insertAllArrayOfValues(<span class="type">array</span> \$array, <span class="type">array</span> \$fieldNameDontQuote <span class="default">= []</span>) <span>: bool</span></b>
FUNCTIONDEF;
echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Sql\Mysql\MultipleInsert", "insertAllArrayOfValues")."</pre>";
echo "<ol class='usage'>";
/// display ///
echo <<< DOCUMENT_EXAMPLE
<li>\$multipleInsert->insertAllArrayOfValues(['a' => '1', 'b' => '2', 'c' => 3]); ->
DOCUMENT_EXAMPLE;
///run ///
echo ($multipleInsert->insertAllArrayOfValues(['a' => '1', 'b' => '2', 'c' => 3]) ? 'true' : 'false');
echo '</ol>';
///////// \$multipleInsert->valuesString('palabra'); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_valuesString'><b>\$multipleInsert->valuesString(<span class="type">string</span> \$valueString) <span>: bool</span></b>
FUNCTIONDEF;
echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Sql\Mysql\MultipleInsert", "valuesString")."</pre>";
echo "<ol class='usage'>";
/// display ///
echo <<< DOCUMENT_EXAMPLE
<li>\$multipleInsert->valuesString('palabra'); ->
DOCUMENT_EXAMPLE;
///run ///
echo ($multipleInsert->valuesString('palabra') ? 'true' : 'false');
echo '</ol>';
///////// \$multipleInsert->insertNow(); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_insertNow'><b>\$multipleInsert->insertNow() <span>: </span></b>
FUNCTIONDEF;
echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Sql\Mysql\MultipleInsert", "insertNow")."</pre>";
echo "<ol class='usage'>";
/// display ///
echo <<< DOCUMENT_EXAMPLE
<li>\$multipleInsert->insertNow();
-> </b><br><pre>
DOCUMENT_EXAMPLE;
/// run ///
print_r(
$multipleInsert->insertNow()
);
echo "</pre>";
echo '</ol>';
///////// \$multipleInsert->get_valuesClauseNum(); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_get_valuesClauseNum'><b>\$multipleInsert->get_valuesClauseNum() <span>: int</span></b>
FUNCTIONDEF;
echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Sql\Mysql\MultipleInsert", "get_valuesClauseNum")."</pre>";
echo "<ol class='usage'>";
/// display ///
echo <<< DOCUMENT_EXAMPLE
<li>\$multipleInsert->get_valuesClauseNum(); ->
DOCUMENT_EXAMPLE;
/// run ///
echo $multipleInsert->get_valuesClauseNum();
echo '</ol>';
///////// \$multipleInsert->get_valuesCurrentNum(); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_get_valuesCurrentNum'><b>\$multipleInsert->get_valuesCurrentNum() <span>: int</span></b>
FUNCTIONDEF;
echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Sql\Mysql\MultipleInsert", "get_valuesCurrentNum")."</pre>";
echo "<ol class='usage'>";
/// display ///
echo <<< DOCUMENT_EXAMPLE
<li>\$multipleInsert->get_valuesCurrentNum(); ->
DOCUMENT_EXAMPLE;
/// run ///
echo $multipleInsert->get_valuesCurrentNum();
echo '</ol>';
///////// \$multipleInsert->get_insertsOkNum(); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_get_insertsOkNum'><b>\$multipleInsert->get_insertsOkNum() <span>: int</span></b>
FUNCTIONDEF;
echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Sql\Mysql\MultipleInsert", "get_insertsOkNum")."</pre>";
echo "<ol class='usage'>";
/// display ///
echo <<< DOCUMENT_EXAMPLE
<li>\$multipleInsert->get_insertsOkNum(); ->
DOCUMENT_EXAMPLE;
/// run ///
echo $multipleInsert->get_insertsOkNum();
echo '</ol>';
///////// \$multipleInsert->get_insertsErrorsNum(); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_get_insertsErrorsNum'><b>\$multipleInsert->get_insertsErrorsNum() <span>: int</span></b>
FUNCTIONDEF;
echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Sql\Mysql\MultipleInsert", "get_insertsErrorsNum")."</pre>";
echo "<ol class='usage'>";
/// display ///
echo <<< DOCUMENT_EXAMPLE
<li>\$multipleInsert->get_insertsErrorsNum(); ->
DOCUMENT_EXAMPLE;
/// run ///
echo $multipleInsert->get_insertsErrorsNum();
echo '</ol>';
///////// \$multipleInsert->get_insertLast(); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_get_insertLast'><b>\$multipleInsert->get_insertLast() <span>: string</span></b>
FUNCTIONDEF;
echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Sql\Mysql\MultipleInsert", "get_insertLast")."</pre>";
echo "<ol class='usage'>";
/// display ///
echo <<< DOCUMENT_EXAMPLE
<li>\$multipleInsert->get_insertLast(); ->
DOCUMENT_EXAMPLE;
/// run ///
echo $multipleInsert->get_insertLast();
echo '</ol>';
///////// \$multipleInsert->get_insertLastOk(); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_get_insertLastOk'><b>\$multipleInsert->get_insertLastOk() <span>: string</span></b>
FUNCTIONDEF;
echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Sql\Mysql\MultipleInsert", "get_insertLastOk")."</pre>";
echo "<ol class='usage'>";
/// display ///
echo <<< DOCUMENT_EXAMPLE
<li>\$multipleInsert->get_insertLastOk(); ->
DOCUMENT_EXAMPLE;
/// run ///
echo $multipleInsert->get_insertLastOk();
echo '</ol>';
///////// \$multipleInsert->get_currentLength(); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_get_currentLength'><b>\$multipleInsert->get_currentLength() <span>: int</span></b>
FUNCTIONDEF;
echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Sql\Mysql\MultipleInsert", "get_currentLength")."</pre>";
echo "<ol class='usage'>";
/// display ///
echo <<< DOCUMENT_EXAMPLE
<li>\$multipleInsert->get_currentLength(); ->
DOCUMENT_EXAMPLE;
/// run ///
echo $multipleInsert->get_currentLength();
echo '</ol>';
///////// \$multipleInsert->get_insertIntoLength(); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_get_insertIntoLength'><b>\$multipleInsert->get_insertIntoLength() <span>: int</span></b>
FUNCTIONDEF;
echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Sql\Mysql\MultipleInsert", "get_insertIntoLength")."</pre>";
echo "<ol class='usage'>";
/// display ///
echo <<< DOCUMENT_EXAMPLE
<li>\$multipleInsert->get_insertIntoLength(); ->
DOCUMENT_EXAMPLE;
/// run ///
echo $multipleInsert->get_insertIntoLength();
echo '</ol>';
///////// \$multipleInsert->get_simulate(); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_get_simulate'><b>\$multipleInsert->get_simulate() <span>: bool</span></b>
FUNCTIONDEF;
echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Sql\Mysql\MultipleInsert", "get_simulate")."</pre>";
echo "<ol class='usage'>";
/// display ///
echo <<< DOCUMENT_EXAMPLE
<li>\$multipleInsert->get_simulate(); ->
DOCUMENT_EXAMPLE;
///run ///
echo ($multipleInsert->get_simulate() ? 'true' : 'false');
echo '</ol>';
///////// \$multipleInsert->set_simulate(true); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_set_simulate'><b>\$multipleInsert->set_simulate(<span class="type">bool</span> \$simulate) <span>: bool</span></b>
FUNCTIONDEF;
echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Sql\Mysql\MultipleInsert", "set_simulate")."</pre>";
echo "<ol class='usage'>";
/// display ///
echo <<< DOCUMENT_EXAMPLE
<li>\$multipleInsert->set_simulate(true); ->
DOCUMENT_EXAMPLE;
///run ///
echo ($multipleInsert->set_simulate(true) ? 'true' : 'false');
echo '</ol>';
///////// \$multipleInsert->get_allInserts(); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_get_allInserts'><b>\$multipleInsert->get_allInserts() <span>: array</span></b>
FUNCTIONDEF;
echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Sql\Mysql\MultipleInsert", "get_allInserts")."</pre>";
echo "<ol class='usage'>";
/// display ///
echo <<< DOCUMENT_EXAMPLE
<li>\$multipleInsert->get_allInserts();
-> </b><br><pre>
DOCUMENT_EXAMPLE;
/// run ///
print_r(
$multipleInsert->get_allInserts()
);
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\MultipleInsert;
use PHPUnit\Framework\TestCase;
class MultipleInsertTest extends TestCase {
/**
* @dataProvider valuesArray_Provider
*
*/
public function test_valuesArray($values, $fieldNameDontQuote , $expected) {
$multipleInsert = new MultipleInsert($db, $insertIntoClause, $onDuplicateClause, $maxLength, $simulate);
$this->assertEquals($expected, $multipleInsert->valuesArray($values, $fieldNameDontQuote) );
}
function valuesArray_Provider() {
return [
'test 1' => [ '', '', '' ],
];
}
/**
* @dataProvider insertAllArrayOfValues_Provider
*
*/
public function test_insertAllArrayOfValues($array, $fieldNameDontQuote , $expected) {
$multipleInsert = new MultipleInsert($db, $insertIntoClause, $onDuplicateClause, $maxLength, $simulate);
$this->assertEquals($expected, $multipleInsert->insertAllArrayOfValues($array, $fieldNameDontQuote) );
}
function insertAllArrayOfValues_Provider() {
return [
'test 1' => [ '', '', '' ],
];
}
/**
* @dataProvider valuesString_Provider
*
*/
public function test_valuesString($valueString , $expected) {
$multipleInsert = new MultipleInsert($db, $insertIntoClause, $onDuplicateClause, $maxLength, $simulate);
$this->assertEquals($expected, $multipleInsert->valuesString($valueString) );
}
function valuesString_Provider() {
return [
'test 1' => [ '', '' ],
];
}
/**
* @dataProvider insertNow_Provider
*
*/
public function test_insertNow( $expected) {
$multipleInsert = new MultipleInsert($db, $insertIntoClause, $onDuplicateClause, $maxLength, $simulate);
$this->assertEquals($expected, $multipleInsert->insertNow() );
}
function insertNow_Provider() {
return [
'test 1' => [ '' ],
];
}
/**
* @dataProvider get_valuesClauseNum_Provider
*
*/
public function test_get_valuesClauseNum( $expected) {
$multipleInsert = new MultipleInsert($db, $insertIntoClause, $onDuplicateClause, $maxLength, $simulate);
$this->assertEquals($expected, $multipleInsert->get_valuesClauseNum() );
}
function get_valuesClauseNum_Provider() {
return [
'test 1' => [ '' ],
];
}
/**
* @dataProvider get_valuesCurrentNum_Provider
*
*/
public function test_get_valuesCurrentNum( $expected) {
$multipleInsert = new MultipleInsert($db, $insertIntoClause, $onDuplicateClause, $maxLength, $simulate);
$this->assertEquals($expected, $multipleInsert->get_valuesCurrentNum() );
}
function get_valuesCurrentNum_Provider() {
return [
'test 1' => [ '' ],
];
}
/**
* @dataProvider get_insertsOkNum_Provider
*
*/
public function test_get_insertsOkNum( $expected) {
$multipleInsert = new MultipleInsert($db, $insertIntoClause, $onDuplicateClause, $maxLength, $simulate);
$this->assertEquals($expected, $multipleInsert->get_insertsOkNum() );
}
function get_insertsOkNum_Provider() {
return [
'test 1' => [ '' ],
];
}
/**
* @dataProvider get_insertsErrorsNum_Provider
*
*/
public function test_get_insertsErrorsNum( $expected) {
$multipleInsert = new MultipleInsert($db, $insertIntoClause, $onDuplicateClause, $maxLength, $simulate);
$this->assertEquals($expected, $multipleInsert->get_insertsErrorsNum() );
}
function get_insertsErrorsNum_Provider() {
return [
'test 1' => [ '' ],
];
}
/**
* @dataProvider get_insertLast_Provider
*
*/
public function test_get_insertLast( $expected) {
$multipleInsert = new MultipleInsert($db, $insertIntoClause, $onDuplicateClause, $maxLength, $simulate);
$this->assertEquals($expected, $multipleInsert->get_insertLast() );
}
function get_insertLast_Provider() {
return [
'test 1' => [ '' ],
];
}
/**
* @dataProvider get_insertLastOk_Provider
*
*/
public function test_get_insertLastOk( $expected) {
$multipleInsert = new MultipleInsert($db, $insertIntoClause, $onDuplicateClause, $maxLength, $simulate);
$this->assertEquals($expected, $multipleInsert->get_insertLastOk() );
}
function get_insertLastOk_Provider() {
return [
'test 1' => [ '' ],
];
}
/**
* @dataProvider get_currentLength_Provider
*
*/
public function test_get_currentLength( $expected) {
$multipleInsert = new MultipleInsert($db, $insertIntoClause, $onDuplicateClause, $maxLength, $simulate);
$this->assertEquals($expected, $multipleInsert->get_currentLength() );
}
function get_currentLength_Provider() {
return [
'test 1' => [ '' ],
];
}
/**
* @dataProvider get_insertIntoLength_Provider
*
*/
public function test_get_insertIntoLength( $expected) {
$multipleInsert = new MultipleInsert($db, $insertIntoClause, $onDuplicateClause, $maxLength, $simulate);
$this->assertEquals($expected, $multipleInsert->get_insertIntoLength() );
}
function get_insertIntoLength_Provider() {
return [
'test 1' => [ '' ],
];
}
/**
* @dataProvider get_simulate_Provider
*
*/
public function test_get_simulate( $expected) {
$multipleInsert = new MultipleInsert($db, $insertIntoClause, $onDuplicateClause, $maxLength, $simulate);
$this->assertEquals($expected, $multipleInsert->get_simulate() );
}
function get_simulate_Provider() {
return [
'test 1' => [ '' ],
];
}
/**
* @dataProvider set_simulate_Provider
*
*/
public function test_set_simulate($simulate , $expected) {
$multipleInsert = new MultipleInsert($db, $insertIntoClause, $onDuplicateClause, $maxLength, $simulate);
$this->assertEquals($expected, $multipleInsert->set_simulate($simulate) );
}
function set_simulate_Provider() {
return [
'test 1' => [ '', '' ],
];
}
/**
* @dataProvider get_allInserts_Provider
*
*/
public function test_get_allInserts( $expected) {
$multipleInsert = new MultipleInsert($db, $insertIntoClause, $onDuplicateClause, $maxLength, $simulate);
$this->assertEquals($expected, $multipleInsert->get_allInserts() );
}
function get_allInserts_Provider() {
return [
'test 1' => [ '' ],
];
}
}
ia Doc