/iaLib/ia_examples/iaSqlite_example.php
<?php
$ia_example = [
'title' => 'iaSqlite', // fully qualified className
'summary' => '', // class summary
'full_example' => '', // full usage example, relative path from ia_examples, blank '' not shown.
'example_file' => 'code/iaSqlite_example_code.php', // method by method example, blank '' not shown.
];
include( __DIR__ . '/template/ia_example_class.php');
/iaLib/ia_examples/code/iaSqlite_example_code.php
/**
* Usage examples for iaSqlite
* @version 1.0
* @date 2026-01
*/
use ia\DocumentIt\DocumentIt;
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>
/*
\$iaSqlite = new iaSqlite();
*/
\$iaSqlite = new iaSqlite();
</pre>
CONSTRUCTOR_PROTOTYPE;
$iaSqlite = new iaSqlite();
echo '<ul class="usage">';
///////// \$iaSqlite->openOrCreate(null /* == */); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_openOrCreate'><b>\$iaSqlite->openOrCreate(<span class="type"></span> \$fileName) <span>: </span></b>
FUNCTIONDEF;
echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("iaSqlite", "openOrCreate")."</pre>";
echo "<ol class='usage'>";
/// display ///
echo <<< DOCUMENT_EXAMPLE
<li>\$iaSqlite->openOrCreate(null /* == */);
-> </b><br><pre>
DOCUMENT_EXAMPLE;
/// run ///
print_r(
$iaSqlite->openOrCreate(null /* == */)
);
echo "</pre>";
echo '</ol>';
///////// \$iaSqlite->exec(null /* == */); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_exec'><b>\$iaSqlite->exec(<span class="type"></span> \$query) <span>: </span></b>
FUNCTIONDEF;
echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("iaSqlite", "exec")."</pre>";
echo "<ol class='usage'>";
/// display ///
echo <<< DOCUMENT_EXAMPLE
<li>\$iaSqlite->exec(null /* == */);
-> </b><br><pre>
DOCUMENT_EXAMPLE;
/// run ///
print_r(
$iaSqlite->exec(null /* == */)
);
echo "</pre>";
echo '</ol>';
///////// \$iaSqlite->selectArrayIndex(null /* == */); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_selectArrayIndex'><b>\$iaSqlite->selectArrayIndex(<span class="type"></span> \$query) <span>: </span></b>
FUNCTIONDEF;
echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("iaSqlite", "selectArrayIndex")."</pre>";
echo "<ol class='usage'>";
/// display ///
echo <<< DOCUMENT_EXAMPLE
<li>\$iaSqlite->selectArrayIndex(null /* == */);
-> </b><br><pre>
DOCUMENT_EXAMPLE;
/// run ///
print_r(
$iaSqlite->selectArrayIndex(null /* == */)
);
echo "</pre>";
echo '</ol>';
///////// \$iaSqlite->single_read(null /* == */); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_single_read'><b>\$iaSqlite->single_read(<span class="type"></span> \$query) <span>: </span></b>
FUNCTIONDEF;
echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("iaSqlite", "single_read")."</pre>";
echo "<ol class='usage'>";
/// display ///
echo <<< DOCUMENT_EXAMPLE
<li>\$iaSqlite->single_read(null /* == */);
-> </b><br><pre>
DOCUMENT_EXAMPLE;
/// run ///
print_r(
$iaSqlite->single_read(null /* == */)
);
echo "</pre>";
echo '</ol>';
///////// \$iaSqlite->begin(); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_begin'><b>\$iaSqlite->begin() <span>: </span></b>
FUNCTIONDEF;
echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("iaSqlite", "begin")."</pre>";
echo "<ol class='usage'>";
/// display ///
echo <<< DOCUMENT_EXAMPLE
<li>\$iaSqlite->begin();
-> </b><br><pre>
DOCUMENT_EXAMPLE;
/// run ///
print_r(
$iaSqlite->begin()
);
echo "</pre>";
echo '</ol>';
///////// \$iaSqlite->commit(); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_commit'><b>\$iaSqlite->commit() <span>: </span></b>
FUNCTIONDEF;
echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("iaSqlite", "commit")."</pre>";
echo "<ol class='usage'>";
/// display ///
echo <<< DOCUMENT_EXAMPLE
<li>\$iaSqlite->commit();
-> </b><br><pre>
DOCUMENT_EXAMPLE;
/// run ///
print_r(
$iaSqlite->commit()
);
echo "</pre>";
echo '</ol>';
///////// \$iaSqlite->rollback(); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_rollback'><b>\$iaSqlite->rollback() <span>: </span></b>
FUNCTIONDEF;
echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("iaSqlite", "rollback")."</pre>";
echo "<ol class='usage'>";
/// display ///
echo <<< DOCUMENT_EXAMPLE
<li>\$iaSqlite->rollback();
-> </b><br><pre>
DOCUMENT_EXAMPLE;
/// run ///
print_r(
$iaSqlite->rollback()
);
echo "</pre>";
echo '</ol>';
///////// \$iaSqlite->close(); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_close'><b>\$iaSqlite->close() <span>: </span></b>
FUNCTIONDEF;
echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("iaSqlite", "close")."</pre>";
echo "<ol class='usage'>";
/// display ///
echo <<< DOCUMENT_EXAMPLE
<li>\$iaSqlite->close();
-> </b><br><pre>
DOCUMENT_EXAMPLE;
/// run ///
print_r(
$iaSqlite->close()
);
echo "</pre>";
echo '</ol>';
///////// \$iaSqlite->getColNames(null /* == */); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_getColNames'><b>\$iaSqlite->getColNames(<span class="type"></span> \$table) <span>: </span></b>
FUNCTIONDEF;
echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("iaSqlite", "getColNames")."</pre>";
echo "<ol class='usage'>";
/// display ///
echo <<< DOCUMENT_EXAMPLE
<li>\$iaSqlite->getColNames(null /* == */);
-> </b><br><pre>
DOCUMENT_EXAMPLE;
/// run ///
print_r(
$iaSqlite->getColNames(null /* == */)
);
echo "</pre>";
echo '</ol>';
///////// \$iaSqlite->lastErrorCode(); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_lastErrorCode'><b>\$iaSqlite->lastErrorCode() <span>: </span></b>
FUNCTIONDEF;
echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("iaSqlite", "lastErrorCode")."</pre>";
echo "<ol class='usage'>";
/// display ///
echo <<< DOCUMENT_EXAMPLE
<li>\$iaSqlite->lastErrorCode();
-> </b><br><pre>
DOCUMENT_EXAMPLE;
/// run ///
print_r(
$iaSqlite->lastErrorCode()
);
echo "</pre>";
echo '</ol>';
///////// \$iaSqlite->lastErrorMsg(); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_lastErrorMsg'><b>\$iaSqlite->lastErrorMsg() <span>: </span></b>
FUNCTIONDEF;
echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("iaSqlite", "lastErrorMsg")."</pre>";
echo "<ol class='usage'>";
/// display ///
echo <<< DOCUMENT_EXAMPLE
<li>\$iaSqlite->lastErrorMsg();
-> </b><br><pre>
DOCUMENT_EXAMPLE;
/// run ///
print_r(
$iaSqlite->lastErrorMsg()
);
echo "</pre>";
echo '</ol>';
///////// \$iaSqlite->geto_version(); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_geto_version'><b>\$iaSqlite->geto_version() <span>: </span></b>
FUNCTIONDEF;
echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("iaSqlite", "geto_version")."</pre>";
echo "<ol class='usage'>";
/// display ///
echo <<< DOCUMENT_EXAMPLE
<li>\$iaSqlite->geto_version();
-> </b><br><pre>
DOCUMENT_EXAMPLE;
/// run ///
print_r(
$iaSqlite->geto_version()
);
echo "</pre>";
echo '</ol>';
///////// \$iaSqlite->get_sqlite3(); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_get_sqlite3'><b>\$iaSqlite->get_sqlite3() <span>: </span></b>
FUNCTIONDEF;
echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("iaSqlite", "get_sqlite3")."</pre>";
echo "<ol class='usage'>";
/// display ///
echo <<< DOCUMENT_EXAMPLE
<li>\$iaSqlite->get_sqlite3();
-> </b><br><pre>
DOCUMENT_EXAMPLE;
/// run ///
print_r(
$iaSqlite->get_sqlite3()
);
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 iaSqlite;
use PHPUnit\Framework\TestCase;
class iaSqliteTest extends TestCase {
/**
* @dataProvider openOrCreate_Provider
*
*/
public function test_openOrCreate($fileName , $expected) {
$iaSqlite = new iaSqlite();
$this->assertEquals($expected, $iaSqlite->openOrCreate($fileName) );
}
function openOrCreate_Provider() {
return [
'test 1' => [ '', '' ],
];
}
/**
* @dataProvider exec_Provider
*
*/
public function test_exec($query , $expected) {
$iaSqlite = new iaSqlite();
$this->assertEquals($expected, $iaSqlite->exec($query) );
}
function exec_Provider() {
return [
'test 1' => [ '', '' ],
];
}
/**
* @dataProvider selectArrayIndex_Provider
*
*/
public function test_selectArrayIndex($query , $expected) {
$iaSqlite = new iaSqlite();
$this->assertEquals($expected, $iaSqlite->selectArrayIndex($query) );
}
function selectArrayIndex_Provider() {
return [
'test 1' => [ '', '' ],
];
}
/**
* @dataProvider single_read_Provider
*
*/
public function test_single_read($query , $expected) {
$iaSqlite = new iaSqlite();
$this->assertEquals($expected, $iaSqlite->single_read($query) );
}
function single_read_Provider() {
return [
'test 1' => [ '', '' ],
];
}
/**
* @dataProvider begin_Provider
*
*/
public function test_begin( $expected) {
$iaSqlite = new iaSqlite();
$this->assertEquals($expected, $iaSqlite->begin() );
}
function begin_Provider() {
return [
'test 1' => [ '' ],
];
}
/**
* @dataProvider commit_Provider
*
*/
public function test_commit( $expected) {
$iaSqlite = new iaSqlite();
$this->assertEquals($expected, $iaSqlite->commit() );
}
function commit_Provider() {
return [
'test 1' => [ '' ],
];
}
/**
* @dataProvider rollback_Provider
*
*/
public function test_rollback( $expected) {
$iaSqlite = new iaSqlite();
$this->assertEquals($expected, $iaSqlite->rollback() );
}
function rollback_Provider() {
return [
'test 1' => [ '' ],
];
}
/**
* @dataProvider close_Provider
*
*/
public function test_close( $expected) {
$iaSqlite = new iaSqlite();
$this->assertEquals($expected, $iaSqlite->close() );
}
function close_Provider() {
return [
'test 1' => [ '' ],
];
}
/**
* @dataProvider getColNames_Provider
*
*/
public function test_getColNames($table , $expected) {
$iaSqlite = new iaSqlite();
$this->assertEquals($expected, $iaSqlite->getColNames($table) );
}
function getColNames_Provider() {
return [
'test 1' => [ '', '' ],
];
}
/**
* @dataProvider lastErrorCode_Provider
*
*/
public function test_lastErrorCode( $expected) {
$iaSqlite = new iaSqlite();
$this->assertEquals($expected, $iaSqlite->lastErrorCode() );
}
function lastErrorCode_Provider() {
return [
'test 1' => [ '' ],
];
}
/**
* @dataProvider lastErrorMsg_Provider
*
*/
public function test_lastErrorMsg( $expected) {
$iaSqlite = new iaSqlite();
$this->assertEquals($expected, $iaSqlite->lastErrorMsg() );
}
function lastErrorMsg_Provider() {
return [
'test 1' => [ '' ],
];
}
/**
* @dataProvider geto_version_Provider
*
*/
public function test_geto_version( $expected) {
$iaSqlite = new iaSqlite();
$this->assertEquals($expected, $iaSqlite->geto_version() );
}
function geto_version_Provider() {
return [
'test 1' => [ '' ],
];
}
/**
* @dataProvider get_sqlite3_Provider
*
*/
public function test_get_sqlite3( $expected) {
$iaSqlite = new iaSqlite();
$this->assertEquals($expected, $iaSqlite->get_sqlite3() );
}
function get_sqlite3_Provider() {
return [
'test 1' => [ '' ],
];
}
}
ia Doc
ia doc & examples: templates
Documentation
Index
Examples List