/iaLib/ia_examples/ia/Sql/Mysql/IaMysqli_example.php
<?php
$ia_example = [
'title' => 'ia\Sql\Mysql\IaMysqli', // 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/IaMysqli_example_code.php', // method by method example, blank '' not shown.
];
include( __DIR__ . '/../../../template/ia_example_class.php');
/iaLib/ia_examples/code/ia/Sql/Mysql/IaMysqli_example_code.php
use ia\Sql\Mysql\IaMysqli;
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>
/**
* IaMysqli::__construct()
* constructor.
*
* @param string \$host host to connect, defaults to php.ini setting
* @param string \$username login, to connect, defaults to php.ini setting
* @param string \$passwd password, to connect, defaults to php.ini setting
* @param string \$dbname databasename
* @param string \$port to connect, defaults to php.ini setting
* @param string \$socket socket to use for connection, defaults to php.ini setting
* @return void
*/
/*
\$iaMysqli = new IaMysqli(<span class="type">string \$host</span> \$host <span class="default">= null</span>, <span class="type">string</span> \$username <span class="default">= null</span>, <span class="type">string</span> \$passwd <span class="default">= null</span>, <span class="type">string</span> \$dbname <span class="default">= ''</span>, <span class="type">string</span> \$port <span class="default">= null</span>, <span class="type">string \$socket</span> \$socket <span class="default">= null</span>);
*/
\$iaMysqli = new IaMysqli();
</pre>
CONSTRUCTOR_PROTOTYPE;
$iaMysqli = new IaMysqli();
echo '<ul class="usage">';
///////// \$iaMysqli->__destruct(); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u___destruct'><b>\$iaMysqli->__destruct() <span>: void</span></b>
FUNCTIONDEF;
echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Sql\Mysql\IaMysqli", "__destruct")."</pre>";
echo "<ol class='usage'>";
/// display ///
echo <<< DOCUMENT_EXAMPLE
<li>\$iaMysqli->__destruct();"
DOCUMENT_EXAMPLE;
/// run ///
echo $iaMysqli->__destruct();
echo '</ol>';
///////// \$iaMysqli->connectionInfo_set(); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_connectionInfo_set'><b>\$iaMysqli->connectionInfo_set(<span class="type">string \$host</span> \$host <span class="default">= null</span>, <span class="type">string</span> \$username <span class="default">= null</span>, <span class="type">string</span> \$passwd <span class="default">= null</span>, <span class="type">string</span> \$dbname <span class="default">= ''</span>, <span class="type">string</span> \$port <span class="default">= null</span>, <span class="type">string \$socket</span> \$socket <span class="default">= null</span>) <span>: void</span></b>
FUNCTIONDEF;
echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Sql\Mysql\IaMysqli", "connectionInfo_set")."</pre>";
echo "<ol class='usage'>";
/// display ///
echo <<< DOCUMENT_EXAMPLE
<li>\$iaMysqli->connectionInfo_set();"
DOCUMENT_EXAMPLE;
/// run ///
echo $iaMysqli->connectionInfo_set();
echo '</ol>';
///////// \$iaMysqli->connect_toString(); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_connect_toString'><b>\$iaMysqli->connect_toString(<span class="type">array</span> \$con <span class="default">= null</span>) <span>: string</span></b>
FUNCTIONDEF;
echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Sql\Mysql\IaMysqli", "connect_toString")."</pre>";
echo "<ol class='usage'>";
/// display ///
echo <<< DOCUMENT_EXAMPLE
<li>\$iaMysqli->connect_toString(); ->
DOCUMENT_EXAMPLE;
/// run ///
echo $iaMysqli->connect_toString();
echo '</ol>';
///////// \$iaMysqli->connect(); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_connect'><b>\$iaMysqli->connect() <span>: bool</span></b>
FUNCTIONDEF;
echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Sql\Mysql\IaMysqli", "connect")."</pre>";
echo "<ol class='usage'>";
/// display ///
echo <<< DOCUMENT_EXAMPLE
<li>\$iaMysqli->connect(); ->
DOCUMENT_EXAMPLE;
///run ///
echo ($iaMysqli->connect() ? 'true' : 'false');
echo '</ol>';
///////// \$iaMysqli->reconnect(); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_reconnect'><b>\$iaMysqli->reconnect() <span>: bool</span></b>
FUNCTIONDEF;
echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Sql\Mysql\IaMysqli", "reconnect")."</pre>";
echo "<ol class='usage'>";
/// display ///
echo <<< DOCUMENT_EXAMPLE
<li>\$iaMysqli->reconnect(); ->
DOCUMENT_EXAMPLE;
///run ///
echo ($iaMysqli->reconnect() ? 'true' : 'false');
echo '</ol>';
///////// \$iaMysqli->close(); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_close'><b>\$iaMysqli->close() <span>: bool</span></b>
FUNCTIONDEF;
echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Sql\Mysql\IaMysqli", "close")."</pre>";
echo "<ol class='usage'>";
/// display ///
echo <<< DOCUMENT_EXAMPLE
<li>\$iaMysqli->close(); ->
DOCUMENT_EXAMPLE;
///run ///
echo ($iaMysqli->close() ? 'true' : 'false');
echo '</ol>';
///////// \$iaMysqli->begin(); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_begin'><b>\$iaMysqli->begin(<span class="type">int</span> \$flags <span class="default">= 0</span>) <span>: bool</span></b>
FUNCTIONDEF;
echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Sql\Mysql\IaMysqli", "begin")."</pre>";
echo "<ol class='usage'>";
/// display ///
echo <<< DOCUMENT_EXAMPLE
<li>\$iaMysqli->begin(); ->
DOCUMENT_EXAMPLE;
///run ///
echo ($iaMysqli->begin() ? 'true' : 'false');
echo '</ol>';
///////// \$iaMysqli->commit(); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_commit'><b>\$iaMysqli->commit() <span>: bool</span></b>
FUNCTIONDEF;
echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Sql\Mysql\IaMysqli", "commit")."</pre>";
echo "<ol class='usage'>";
/// display ///
echo <<< DOCUMENT_EXAMPLE
<li>\$iaMysqli->commit(); ->
DOCUMENT_EXAMPLE;
///run ///
echo ($iaMysqli->commit() ? 'true' : 'false');
echo '</ol>';
///////// \$iaMysqli->rollback(); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_rollback'><b>\$iaMysqli->rollback() <span>: bool</span></b>
FUNCTIONDEF;
echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Sql\Mysql\IaMysqli", "rollback")."</pre>";
echo "<ol class='usage'>";
/// display ///
echo <<< DOCUMENT_EXAMPLE
<li>\$iaMysqli->rollback(); ->
DOCUMENT_EXAMPLE;
///run ///
echo ($iaMysqli->rollback() ? 'true' : 'false');
echo '</ol>';
///////// \$iaMysqli->autocommit(true); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_autocommit'><b>\$iaMysqli->autocommit(<span class="type">bool</span> \$mode, <span class="type">string</span> \$comment <span class="default">= ''</span>) <span>: int</span></b>
FUNCTIONDEF;
echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Sql\Mysql\IaMysqli", "autocommit")."</pre>";
echo "<ol class='usage'>";
/// display ///
echo <<< DOCUMENT_EXAMPLE
<li>\$iaMysqli->autocommit(true); ->
DOCUMENT_EXAMPLE;
/// run ///
echo $iaMysqli->autocommit(true);
echo '</ol>';
///////// \$iaMysqli->transaction(['a' => '1', 'b' => '2', 'c' => 3]); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_transaction'><b>\$iaMysqli->transaction(<span class="type">array</span> \$sqlArray) <span>: bool</span></b>
FUNCTIONDEF;
echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Sql\Mysql\IaMysqli", "transaction")."</pre>";
echo "<ol class='usage'>";
/// display ///
echo <<< DOCUMENT_EXAMPLE
<li>\$iaMysqli->transaction(['a' => '1', 'b' => '2', 'c' => 3]); ->
DOCUMENT_EXAMPLE;
///run ///
echo ($iaMysqli->transaction(['a' => '1', 'b' => '2', 'c' => 3]) ? 'true' : 'false');
echo '</ol>';
///////// \$iaMysqli->queryArray(['a' => '1', 'b' => '2', 'c' => 3]); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_queryArray'><b>\$iaMysqli->queryArray(<span class="type">array</span> \$sqlArray) <span>: bool</span></b>
FUNCTIONDEF;
echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Sql\Mysql\IaMysqli", "queryArray")."</pre>";
echo "<ol class='usage'>";
/// display ///
echo <<< DOCUMENT_EXAMPLE
<li>\$iaMysqli->queryArray(['a' => '1', 'b' => '2', 'c' => 3]); ->
DOCUMENT_EXAMPLE;
///run ///
echo ($iaMysqli->queryArray(['a' => '1', 'b' => '2', 'c' => 3]) ? 'true' : 'false');
echo '</ol>';
///////// \$iaMysqli->query('palabra'); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_query'><b>\$iaMysqli->query(<span class="type">string \$sql string:</span> \$sql, <span class="type">int</span> \$resultmode <span class="default">= 0</span>) <span>: mixed</span></b>
FUNCTIONDEF;
echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Sql\Mysql\IaMysqli", "query")."</pre>";
echo "<ol class='usage'>";
/// display ///
echo <<< DOCUMENT_EXAMPLE
<li>\$iaMysqli->query('palabra');
-> </b><br><pre>
DOCUMENT_EXAMPLE;
/// run ///
print_r(
$iaMysqli->query('palabra')
);
echo "</pre>";
echo '</ol>';
///////// \$iaMysqli->insertAndGetId('palabra'); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_insertAndGetId'><b>\$iaMysqli->insertAndGetId(<span class="type">string</span> \$sql) <span>: int</span></b>
FUNCTIONDEF;
echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Sql\Mysql\IaMysqli", "insertAndGetId")."</pre>";
echo "<ol class='usage'>";
/// display ///
echo <<< DOCUMENT_EXAMPLE
<li>\$iaMysqli->insertAndGetId('palabra'); ->
DOCUMENT_EXAMPLE;
/// run ///
echo $iaMysqli->insertAndGetId('palabra');
echo '</ol>';
///////// \$iaMysqli->single_read('palabra'); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_single_read'><b>\$iaMysqli->single_read(<span class="type">string \$sql</span> \$sql, <span class="type">string \$onNotFound on no rows found return</span> \$onNotFound <span class="default">= ''</span>) <span>: string</span></b>
FUNCTIONDEF;
echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Sql\Mysql\IaMysqli", "single_read")."</pre>";
echo "<ol class='usage'>";
/// display ///
echo <<< DOCUMENT_EXAMPLE
<li>\$iaMysqli->single_read('palabra'); ->
DOCUMENT_EXAMPLE;
/// run ///
echo $iaMysqli->single_read('palabra');
echo '</ol>';
///////// \$iaMysqli->singleton('palabra'); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_singleton'><b>\$iaMysqli->singleton(<span class="type">string \$sql</span> \$sql, <span class="type">array \$onNotFound on no rows found return</span> \$onNotFound <span class="default">= []</span>, <span class="type">int</span> \$resultType <span class="default">= 1</span>) <span>: mixed</span></b>
FUNCTIONDEF;
echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Sql\Mysql\IaMysqli", "singleton")."</pre>";
echo "<ol class='usage'>";
/// display ///
echo <<< DOCUMENT_EXAMPLE
<li>\$iaMysqli->singleton('palabra');
-> </b><br><pre>
DOCUMENT_EXAMPLE;
/// run ///
print_r(
$iaMysqli->singleton('palabra')
);
echo "</pre>";
echo '</ol>';
///////// \$iaMysqli->singleton_full('palabra'); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_singleton_full'><b>\$iaMysqli->singleton_full(<span class="type">string \$sql</span> \$sql, <span class="type">mixed</span> \$onNull <span class="default">= ''</span>) <span>: mixed</span></b>
FUNCTIONDEF;
echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Sql\Mysql\IaMysqli", "singleton_full")."</pre>";
echo "<ol class='usage'>";
/// display ///
echo <<< DOCUMENT_EXAMPLE
<li>\$iaMysqli->singleton_full('palabra');
-> </b><br><pre>
DOCUMENT_EXAMPLE;
/// run ///
print_r(
$iaMysqli->singleton_full('palabra')
);
echo "</pre>";
echo '</ol>';
///////// \$iaMysqli->selectVector('palabra'); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_selectVector'><b>\$iaMysqli->selectVector(<span class="type">string \$sql</span> \$sql, <span class="type">mixed \$onNotFound on no rows returned return</span> \$onNotFound <span class="default">= []</span>) <span>: mixed</span></b>
FUNCTIONDEF;
echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Sql\Mysql\IaMysqli", "selectVector")."</pre>";
echo "<ol class='usage'>";
/// display ///
echo <<< DOCUMENT_EXAMPLE
<li>\$iaMysqli->selectVector('palabra');
-> </b><br><pre>
DOCUMENT_EXAMPLE;
/// run ///
print_r(
$iaMysqli->selectVector('palabra')
);
echo "</pre>";
echo '</ol>';
///////// \$iaMysqli->selectKeyValue('palabra'); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_selectKeyValue'><b>\$iaMysqli->selectKeyValue(<span class="type">string \$sql</span> \$sql, <span class="type">mixed \$onNotFound on no rows returned return</span> \$onNotFound <span class="default">= []</span>) <span>: array|bool</span></b>
FUNCTIONDEF;
echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Sql\Mysql\IaMysqli", "selectKeyValue")."</pre>";
echo "<ol class='usage'>";
/// display ///
echo <<< DOCUMENT_EXAMPLE
<li>\$iaMysqli->selectKeyValue('palabra');
-> </b><br><pre>
DOCUMENT_EXAMPLE;
/// run ///
print_r(
$iaMysqli->selectKeyValue('palabra')
);
echo "</pre>";
echo '</ol>';
///////// \$iaMysqli->selectArrayKey('palabra'); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_selectArrayKey'><b>\$iaMysqli->selectArrayKey(<span class="type">string \$sql</span> \$sql, <span class="type">string</span> \$key <span class="default">= 'id'</span>, <span class="type">mixed \$onNotFound on no rows returned return</span> \$onNotFound <span class="default">= []</span>, <span class="type">int</span> \$resultType <span class="default">= 1</span>) <span>: array</span></b>
FUNCTIONDEF;
echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Sql\Mysql\IaMysqli", "selectArrayKey")."</pre>";
echo "<ol class='usage'>";
/// display ///
echo <<< DOCUMENT_EXAMPLE
<li>\$iaMysqli->selectArrayKey('palabra');
-> </b><br><pre>
DOCUMENT_EXAMPLE;
/// run ///
print_r(
$iaMysqli->selectArrayKey('palabra')
);
echo "</pre>";
echo '</ol>';
///////// \$iaMysqli->selectArrayIndex('palabra'); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_selectArrayIndex'><b>\$iaMysqli->selectArrayIndex(<span class="type">string \$sql</span> \$sql, <span class="type">mixed \$onNotFound on no rows returned return</span> \$onNotFound <span class="default">= []</span>, <span class="type">int</span> \$resultType <span class="default">= 1</span>) <span>: mixed</span></b>
FUNCTIONDEF;
echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Sql\Mysql\IaMysqli", "selectArrayIndex")."</pre>";
echo "<ol class='usage'>";
/// display ///
echo <<< DOCUMENT_EXAMPLE
<li>\$iaMysqli->selectArrayIndex('palabra');
-> </b><br><pre>
DOCUMENT_EXAMPLE;
/// run ///
print_r(
$iaMysqli->selectArrayIndex('palabra')
);
echo "</pre>";
echo '</ol>';
///////// \$iaMysqli->valid_unique_key(null /* =* @param \$UniquekeyValue
= */, null /* =* @param \$primaryKeyValue
= */, 'palabra'); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_valid_unique_key'><b>\$iaMysqli->valid_unique_key(<span class="type">* @param \$UniquekeyValue
</span> \$table, <span class="type">* @param \$primaryKeyValue
</span> \$UniquekeyValue, <span class="type">* @param string \$QueryComment
</span> \$primaryKeyValue, <span class="type">string</span> \$QueryComment <span class="default">= '/*valid_unique_key*/'</span>) <span>: string</span></b>
FUNCTIONDEF;
echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Sql\Mysql\IaMysqli", "valid_unique_key")."</pre>";
echo "<ol class='usage'>";
/// display ///
echo <<< DOCUMENT_EXAMPLE
<li>\$iaMysqli->valid_unique_key(null /* =* @param \$UniquekeyValue
= */, null /* =* @param \$primaryKeyValue
= */, 'palabra'); ->
DOCUMENT_EXAMPLE;
/// run ///
echo $iaMysqli->valid_unique_key(null /* =* @param $UniquekeyValue
= */, null /* =* @param $primaryKeyValue
= */, 'palabra');
echo '</ol>';
///////// \$iaMysqli->last_insert_id(); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_last_insert_id'><b>\$iaMysqli->last_insert_id() <span>: int</span></b>
FUNCTIONDEF;
echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Sql\Mysql\IaMysqli", "last_insert_id")."</pre>";
echo "<ol class='usage'>";
/// display ///
echo <<< DOCUMENT_EXAMPLE
<li>\$iaMysqli->last_insert_id(); ->
DOCUMENT_EXAMPLE;
/// run ///
echo $iaMysqli->last_insert_id();
echo '</ol>';
///////// \$iaMysqli->found_rows(); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_found_rows'><b>\$iaMysqli->found_rows() <span>: int</span></b>
FUNCTIONDEF;
echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Sql\Mysql\IaMysqli", "found_rows")."</pre>";
echo "<ol class='usage'>";
/// display ///
echo <<< DOCUMENT_EXAMPLE
<li>\$iaMysqli->found_rows(); ->
DOCUMENT_EXAMPLE;
/// run ///
echo $iaMysqli->found_rows();
echo '</ol>';
///////// \$iaMysqli->metaData_get(); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_metaData_get'><b>\$iaMysqli->metaData_get() <span>: array</span></b>
FUNCTIONDEF;
echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Sql\Mysql\IaMysqli", "metaData_get")."</pre>";
echo "<ol class='usage'>";
/// display ///
echo <<< DOCUMENT_EXAMPLE
<li>\$iaMysqli->metaData_get();
-> </b><br><pre>
DOCUMENT_EXAMPLE;
/// run ///
print_r(
$iaMysqli->metaData_get()
);
echo "</pre>";
echo '</ol>';
///////// \$iaMysqli->metaData_clear(); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_metaData_clear'><b>\$iaMysqli->metaData_clear() <span>: void</span></b>
FUNCTIONDEF;
echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Sql\Mysql\IaMysqli", "metaData_clear")."</pre>";
echo "<ol class='usage'>";
/// display ///
echo <<< DOCUMENT_EXAMPLE
<li>\$iaMysqli->metaData_clear();"
DOCUMENT_EXAMPLE;
/// run ///
echo $iaMysqli->metaData_clear();
echo '</ol>';
///////// \$iaMysqli->throwSqlException_set(3); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_throwSqlException_set'><b>\$iaMysqli->throwSqlException_set(<span class="type">bool|int</span> \$mysqli_report_mode) <span>: void</span></b>
FUNCTIONDEF;
echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Sql\Mysql\IaMysqli", "throwSqlException_set")."</pre>";
echo "<ol class='usage'>";
/// display ///
echo <<< DOCUMENT_EXAMPLE
<li>\$iaMysqli->throwSqlException_set(3);"
DOCUMENT_EXAMPLE;
/// run ///
echo $iaMysqli->throwSqlException_set(3);
echo '</ol>';
///////// \$iaMysqli->throwSqlException_get(); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_throwSqlException_get'><b>\$iaMysqli->throwSqlException_get() <span>: bool</span></b>
FUNCTIONDEF;
echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Sql\Mysql\IaMysqli", "throwSqlException_get")."</pre>";
echo "<ol class='usage'>";
/// display ///
echo <<< DOCUMENT_EXAMPLE
<li>\$iaMysqli->throwSqlException_get(); ->
DOCUMENT_EXAMPLE;
///run ///
echo ($iaMysqli->throwSqlException_get() ? 'true' : 'false');
echo '</ol>';
///////// \$iaMysqli->trace_get(); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_trace_get'><b>\$iaMysqli->trace_get() <span>: array</span></b>
FUNCTIONDEF;
echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Sql\Mysql\IaMysqli", "trace_get")."</pre>";
echo "<ol class='usage'>";
/// display ///
echo <<< DOCUMENT_EXAMPLE
<li>\$iaMysqli->trace_get();
-> </b><br><pre>
DOCUMENT_EXAMPLE;
/// run ///
print_r(
$iaMysqli->trace_get()
);
echo "</pre>";
echo '</ol>';
///////// \$iaMysqli->log_trace('palabra'); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_log_trace'><b>\$iaMysqli->log_trace(<span class="type">string</span> \$sql, <span class="type">int</span> \$retries <span class="default">= 0</span>) <span>: void</span></b>
FUNCTIONDEF;
echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Sql\Mysql\IaMysqli", "log_trace")."</pre>";
echo "<ol class='usage'>";
/// display ///
echo <<< DOCUMENT_EXAMPLE
<li>\$iaMysqli->log_trace('palabra');"
DOCUMENT_EXAMPLE;
/// run ///
echo $iaMysqli->log_trace('palabra');
echo '</ol>';
///////// \$iaMysqli->errorLog_get(); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_errorLog_get'><b>\$iaMysqli->errorLog_get() <span>: array</span></b>
FUNCTIONDEF;
echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Sql\Mysql\IaMysqli", "errorLog_get")."</pre>";
echo "<ol class='usage'>";
/// display ///
echo <<< DOCUMENT_EXAMPLE
<li>\$iaMysqli->errorLog_get();
-> </b><br><pre>
DOCUMENT_EXAMPLE;
/// run ///
print_r(
$iaMysqli->errorLog_get()
);
echo "</pre>";
echo '</ol>';
///////// \$iaMysqli->begins_get(); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_begins_get'><b>\$iaMysqli->begins_get() <span>: int</span></b>
FUNCTIONDEF;
echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Sql\Mysql\IaMysqli", "begins_get")."</pre>";
echo "<ol class='usage'>";
/// display ///
echo <<< DOCUMENT_EXAMPLE
<li>\$iaMysqli->begins_get(); ->
DOCUMENT_EXAMPLE;
/// run ///
echo $iaMysqli->begins_get();
echo '</ol>';
///////// \$iaMysqli->log_sql_error('palabra'); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_log_sql_error'><b>\$iaMysqli->log_sql_error(<span class="type">string \$sql</span> \$sql, <span class="type">int</span> \$retries <span class="default">= 0</span>, <span class="type">bool</span> \$putMysqliError <span class="default">= true</span>) <span>: void</span></b>
FUNCTIONDEF;
echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Sql\Mysql\IaMysqli", "log_sql_error")."</pre>";
echo "<ol class='usage'>";
/// display ///
echo <<< DOCUMENT_EXAMPLE
<li>\$iaMysqli->log_sql_error('palabra');"
DOCUMENT_EXAMPLE;
/// run ///
echo $iaMysqli->log_sql_error('palabra');
echo '</ol>';
///////// \$iaMysqli->selectArrayMultiKey(['a' => '1', 'b' => '2', 'c' => 3], 3); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_selectArrayMultiKey'><b>\$iaMysqli->selectArrayMultiKey(<span class="type">string|array</span> \$sql, <span class="type">int</span> \$numKeys, <span class="type">int</span> \$resultType <span class="default">= 1</span>) <span>: array</span></b>
FUNCTIONDEF;
echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Sql\Mysql\IaMysqli", "selectArrayMultiKey")."</pre>";
echo "<ol class='usage'>";
/// display ///
echo <<< DOCUMENT_EXAMPLE
<li>\$iaMysqli->selectArrayMultiKey(['a' => '1', 'b' => '2', 'c' => 3], 3);
-> </b><br><pre>
DOCUMENT_EXAMPLE;
/// run ///
print_r(
$iaMysqli->selectArrayMultiKey(['a' => '1', 'b' => '2', 'c' => 3], 3)
);
echo "</pre>";
echo '</ol>';
///////// \$iaMysqli->prepare('palabra'); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_prepare'><b>\$iaMysqli->prepare(<span class="type">string</span> \$sql) <span>: bool</span></b>
FUNCTIONDEF;
echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Sql\Mysql\IaMysqli", "prepare")."</pre>";
echo "<ol class='usage'>";
/// display ///
echo <<< DOCUMENT_EXAMPLE
<li>\$iaMysqli->prepare('palabra'); ->
DOCUMENT_EXAMPLE;
///run ///
echo ($iaMysqli->prepare('palabra') ? 'true' : 'false');
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\IaMysqli;
use PHPUnit\Framework\TestCase;
class IaMysqliTest extends TestCase {
/**
* @dataProvider __destruct_Provider
*
*/
public function test___destruct( $expected) {
$iaMysqli = new IaMysqli($host, $username, $passwd, $dbname, $port, $socket);
$this->assertEquals($expected, $iaMysqli->__destruct() );
}
function __destruct_Provider() {
return [
'test 1' => [ '' ],
];
}
/**
* @dataProvider connectionInfo_set_Provider
*
*/
public function test_connectionInfo_set($host, $username, $passwd, $dbname, $port, $socket , $expected) {
$iaMysqli = new IaMysqli($host, $username, $passwd, $dbname, $port, $socket);
$this->assertEquals($expected, $iaMysqli->connectionInfo_set($host, $username, $passwd, $dbname, $port, $socket) );
}
function connectionInfo_set_Provider() {
return [
'test 1' => [ '', '', '', '', '', '', '' ],
];
}
/**
* @dataProvider connect_toString_Provider
*
*/
public function test_connect_toString($con , $expected) {
$iaMysqli = new IaMysqli($host, $username, $passwd, $dbname, $port, $socket);
$this->assertEquals($expected, $iaMysqli->connect_toString($con) );
}
function connect_toString_Provider() {
return [
'test 1' => [ '', '' ],
];
}
/**
* @dataProvider connect_Provider
*
*/
public function test_connect( $expected) {
$iaMysqli = new IaMysqli($host, $username, $passwd, $dbname, $port, $socket);
$this->assertEquals($expected, $iaMysqli->connect() );
}
function connect_Provider() {
return [
'test 1' => [ '' ],
];
}
/**
* @dataProvider reconnect_Provider
*
*/
public function test_reconnect( $expected) {
$iaMysqli = new IaMysqli($host, $username, $passwd, $dbname, $port, $socket);
$this->assertEquals($expected, $iaMysqli->reconnect() );
}
function reconnect_Provider() {
return [
'test 1' => [ '' ],
];
}
/**
* @dataProvider close_Provider
*
*/
public function test_close( $expected) {
$iaMysqli = new IaMysqli($host, $username, $passwd, $dbname, $port, $socket);
$this->assertEquals($expected, $iaMysqli->close() );
}
function close_Provider() {
return [
'test 1' => [ '' ],
];
}
/**
* @dataProvider begin_Provider
*
*/
public function test_begin($flags , $expected) {
$iaMysqli = new IaMysqli($host, $username, $passwd, $dbname, $port, $socket);
$this->assertEquals($expected, $iaMysqli->begin($flags) );
}
function begin_Provider() {
return [
'test 1' => [ '', '' ],
];
}
/**
* @dataProvider commit_Provider
*
*/
public function test_commit( $expected) {
$iaMysqli = new IaMysqli($host, $username, $passwd, $dbname, $port, $socket);
$this->assertEquals($expected, $iaMysqli->commit() );
}
function commit_Provider() {
return [
'test 1' => [ '' ],
];
}
/**
* @dataProvider rollback_Provider
*
*/
public function test_rollback( $expected) {
$iaMysqli = new IaMysqli($host, $username, $passwd, $dbname, $port, $socket);
$this->assertEquals($expected, $iaMysqli->rollback() );
}
function rollback_Provider() {
return [
'test 1' => [ '' ],
];
}
/**
* @dataProvider autocommit_Provider
*
*/
public function test_autocommit($mode, $comment , $expected) {
$iaMysqli = new IaMysqli($host, $username, $passwd, $dbname, $port, $socket);
$this->assertEquals($expected, $iaMysqli->autocommit($mode, $comment) );
}
function autocommit_Provider() {
return [
'test 1' => [ '', '', '' ],
];
}
/**
* @dataProvider transaction_Provider
*
*/
public function test_transaction($sqlArray , $expected) {
$iaMysqli = new IaMysqli($host, $username, $passwd, $dbname, $port, $socket);
$this->assertEquals($expected, $iaMysqli->transaction($sqlArray) );
}
function transaction_Provider() {
return [
'test 1' => [ '', '' ],
];
}
/**
* @dataProvider queryArray_Provider
*
*/
public function test_queryArray($sqlArray , $expected) {
$iaMysqli = new IaMysqli($host, $username, $passwd, $dbname, $port, $socket);
$this->assertEquals($expected, $iaMysqli->queryArray($sqlArray) );
}
function queryArray_Provider() {
return [
'test 1' => [ '', '' ],
];
}
/**
* @dataProvider query_Provider
*
*/
public function test_query($sql, $resultmode , $expected) {
$iaMysqli = new IaMysqli($host, $username, $passwd, $dbname, $port, $socket);
$this->assertEquals($expected, $iaMysqli->query($sql, $resultmode) );
}
function query_Provider() {
return [
'test 1' => [ '', '', '' ],
];
}
/**
* @dataProvider insertAndGetId_Provider
*
*/
public function test_insertAndGetId($sql , $expected) {
$iaMysqli = new IaMysqli($host, $username, $passwd, $dbname, $port, $socket);
$this->assertEquals($expected, $iaMysqli->insertAndGetId($sql) );
}
function insertAndGetId_Provider() {
return [
'test 1' => [ '', '' ],
];
}
/**
* @dataProvider single_read_Provider
*
*/
public function test_single_read($sql, $onNotFound , $expected) {
$iaMysqli = new IaMysqli($host, $username, $passwd, $dbname, $port, $socket);
$this->assertEquals($expected, $iaMysqli->single_read($sql, $onNotFound) );
}
function single_read_Provider() {
return [
'test 1' => [ '', '', '' ],
];
}
/**
* @dataProvider singleton_Provider
*
*/
public function test_singleton($sql, $onNotFound, $resultType , $expected) {
$iaMysqli = new IaMysqli($host, $username, $passwd, $dbname, $port, $socket);
$this->assertEquals($expected, $iaMysqli->singleton($sql, $onNotFound, $resultType) );
}
function singleton_Provider() {
return [
'test 1' => [ '', '', '', '' ],
];
}
/**
* @dataProvider singleton_full_Provider
*
*/
public function test_singleton_full($sql, $onNull , $expected) {
$iaMysqli = new IaMysqli($host, $username, $passwd, $dbname, $port, $socket);
$this->assertEquals($expected, $iaMysqli->singleton_full($sql, $onNull) );
}
function singleton_full_Provider() {
return [
'test 1' => [ '', '', '' ],
];
}
/**
* @dataProvider selectVector_Provider
*
*/
public function test_selectVector($sql, $onNotFound , $expected) {
$iaMysqli = new IaMysqli($host, $username, $passwd, $dbname, $port, $socket);
$this->assertEquals($expected, $iaMysqli->selectVector($sql, $onNotFound) );
}
function selectVector_Provider() {
return [
'test 1' => [ '', '', '' ],
];
}
/**
* @dataProvider selectKeyValue_Provider
*
*/
public function test_selectKeyValue($sql, $onNotFound , $expected) {
$iaMysqli = new IaMysqli($host, $username, $passwd, $dbname, $port, $socket);
$this->assertEquals($expected, $iaMysqli->selectKeyValue($sql, $onNotFound) );
}
function selectKeyValue_Provider() {
return [
'test 1' => [ '', '', '' ],
];
}
/**
* @dataProvider selectArrayKey_Provider
*
*/
public function test_selectArrayKey($sql, $key, $onNotFound, $resultType , $expected) {
$iaMysqli = new IaMysqli($host, $username, $passwd, $dbname, $port, $socket);
$this->assertEquals($expected, $iaMysqli->selectArrayKey($sql, $key, $onNotFound, $resultType) );
}
function selectArrayKey_Provider() {
return [
'test 1' => [ '', '', '', '', '' ],
];
}
/**
* @dataProvider selectArrayIndex_Provider
*
*/
public function test_selectArrayIndex($sql, $onNotFound, $resultType , $expected) {
$iaMysqli = new IaMysqli($host, $username, $passwd, $dbname, $port, $socket);
$this->assertEquals($expected, $iaMysqli->selectArrayIndex($sql, $onNotFound, $resultType) );
}
function selectArrayIndex_Provider() {
return [
'test 1' => [ '', '', '', '' ],
];
}
/**
* @dataProvider valid_unique_key_Provider
*
*/
public function test_valid_unique_key($table, $UniquekeyValue, $primaryKeyValue, $QueryComment , $expected) {
$iaMysqli = new IaMysqli($host, $username, $passwd, $dbname, $port, $socket);
$this->assertEquals($expected, $iaMysqli->valid_unique_key($table, $UniquekeyValue, $primaryKeyValue, $QueryComment) );
}
function valid_unique_key_Provider() {
return [
'test 1' => [ '', '', '', '', '' ],
];
}
/**
* @dataProvider last_insert_id_Provider
*
*/
public function test_last_insert_id( $expected) {
$iaMysqli = new IaMysqli($host, $username, $passwd, $dbname, $port, $socket);
$this->assertEquals($expected, $iaMysqli->last_insert_id() );
}
function last_insert_id_Provider() {
return [
'test 1' => [ '' ],
];
}
/**
* @dataProvider found_rows_Provider
*
*/
public function test_found_rows( $expected) {
$iaMysqli = new IaMysqli($host, $username, $passwd, $dbname, $port, $socket);
$this->assertEquals($expected, $iaMysqli->found_rows() );
}
function found_rows_Provider() {
return [
'test 1' => [ '' ],
];
}
/**
* @dataProvider metaData_get_Provider
*
*/
public function test_metaData_get( $expected) {
$iaMysqli = new IaMysqli($host, $username, $passwd, $dbname, $port, $socket);
$this->assertEquals($expected, $iaMysqli->metaData_get() );
}
function metaData_get_Provider() {
return [
'test 1' => [ '' ],
];
}
/**
* @dataProvider metaData_clear_Provider
*
*/
public function test_metaData_clear( $expected) {
$iaMysqli = new IaMysqli($host, $username, $passwd, $dbname, $port, $socket);
$this->assertEquals($expected, $iaMysqli->metaData_clear() );
}
function metaData_clear_Provider() {
return [
'test 1' => [ '' ],
];
}
/**
* @dataProvider throwSqlException_set_Provider
*
*/
public function test_throwSqlException_set($mysqli_report_mode , $expected) {
$iaMysqli = new IaMysqli($host, $username, $passwd, $dbname, $port, $socket);
$this->assertEquals($expected, $iaMysqli->throwSqlException_set($mysqli_report_mode) );
}
function throwSqlException_set_Provider() {
return [
'test 1' => [ '', '' ],
];
}
/**
* @dataProvider throwSqlException_get_Provider
*
*/
public function test_throwSqlException_get( $expected) {
$iaMysqli = new IaMysqli($host, $username, $passwd, $dbname, $port, $socket);
$this->assertEquals($expected, $iaMysqli->throwSqlException_get() );
}
function throwSqlException_get_Provider() {
return [
'test 1' => [ '' ],
];
}
/**
* @dataProvider trace_get_Provider
*
*/
public function test_trace_get( $expected) {
$iaMysqli = new IaMysqli($host, $username, $passwd, $dbname, $port, $socket);
$this->assertEquals($expected, $iaMysqli->trace_get() );
}
function trace_get_Provider() {
return [
'test 1' => [ '' ],
];
}
/**
* @dataProvider log_trace_Provider
*
*/
public function test_log_trace($sql, $retries , $expected) {
$iaMysqli = new IaMysqli($host, $username, $passwd, $dbname, $port, $socket);
$this->assertEquals($expected, $iaMysqli->log_trace($sql, $retries) );
}
function log_trace_Provider() {
return [
'test 1' => [ '', '', '' ],
];
}
/**
* @dataProvider errorLog_get_Provider
*
*/
public function test_errorLog_get( $expected) {
$iaMysqli = new IaMysqli($host, $username, $passwd, $dbname, $port, $socket);
$this->assertEquals($expected, $iaMysqli->errorLog_get() );
}
function errorLog_get_Provider() {
return [
'test 1' => [ '' ],
];
}
/**
* @dataProvider begins_get_Provider
*
*/
public function test_begins_get( $expected) {
$iaMysqli = new IaMysqli($host, $username, $passwd, $dbname, $port, $socket);
$this->assertEquals($expected, $iaMysqli->begins_get() );
}
function begins_get_Provider() {
return [
'test 1' => [ '' ],
];
}
/**
* @dataProvider log_sql_error_Provider
*
*/
public function test_log_sql_error($sql, $retries, $putMysqliError , $expected) {
$iaMysqli = new IaMysqli($host, $username, $passwd, $dbname, $port, $socket);
$this->assertEquals($expected, $iaMysqli->log_sql_error($sql, $retries, $putMysqliError) );
}
function log_sql_error_Provider() {
return [
'test 1' => [ '', '', '', '' ],
];
}
/**
* @dataProvider selectArrayMultiKey_Provider
*
*/
public function test_selectArrayMultiKey($sql, $numKeys, $resultType , $expected) {
$iaMysqli = new IaMysqli($host, $username, $passwd, $dbname, $port, $socket);
$this->assertEquals($expected, $iaMysqli->selectArrayMultiKey($sql, $numKeys, $resultType) );
}
function selectArrayMultiKey_Provider() {
return [
'test 1' => [ '', '', '', '' ],
];
}
/**
* @dataProvider prepare_Provider
*
*/
public function test_prepare($sql , $expected) {
$iaMysqli = new IaMysqli($host, $username, $passwd, $dbname, $port, $socket);
$this->assertEquals($expected, $iaMysqli->prepare($sql) );
}
function prepare_Provider() {
return [
'test 1' => [ '', '' ],
];
}
}
ia Doc
ia doc & examples: templates
Documentation
Index
Examples List