/iaLib/ia_examples/ia/Lib/iaFiller_example.php
<?php
$ia_example = [
'title' => 'ia\Lib\iaFiller', // fully qualified className
'summary' => '', // class summary
'full_example' => '', // full usage example, relative path from ia_examples, blank '' not shown.
'example_file' => 'code/ia/Lib/iaFiller_example_code.php', // method by method example, blank '' not shown.
];
include( __DIR__ . '/../../template/ia_example_class.php');
/iaLib/ia_examples/code/ia/Lib/iaFiller_example_code.php
use ia\Lib\iaFiller;
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>
/**
* iaFiller::__construct()
*
* @param mixed \$db
* @param mixed \$tag
* @param mixed \$mayEdit
* @param mixed \$webRoot
* @return
*/
/*
\$iaFiller = new iaFiller(<span class="type">mixed</span> \$db, <span class="type">mixed</span> \$tag, <span class="type">mixed</span> \$mayEdit <span class="default">= null</span>, <span class="type">mixed</span> \$webRoot <span class="default">= null</span>);
*/
\$iaFiller = new iaFiller(null /* =mixed= */, null /* =mixed= */);
</pre>
CONSTRUCTOR_PROTOTYPE;
$iaFiller = new iaFiller(null /* =mixed= */, null /* =mixed= */);
echo '<ul class="usage">';
///////// \$iaFiller->htmlHead(); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_htmlHead'><b>\$iaFiller->htmlHead(<span class="type">string</span> \$dataContainerSelector <span class="default">= '#iaFilterForm'</span>, <span class="type">string</span> \$iaFillerSelector <span class="default">= '#iaFiller'</span>, <span class="type">string</span> \$ajaUrl <span class="default">= ''</span>) <span>: </span></b>
FUNCTIONDEF;
echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Lib\iaFiller", "htmlHead")."</pre>";
echo "<ol class='usage'>";
/// display ///
echo <<< DOCUMENT_EXAMPLE
<li>\$iaFiller->htmlHead();
-> </b><br><pre>
DOCUMENT_EXAMPLE;
/// run ///
print_r(
$iaFiller->htmlHead()
);
echo "</pre>";
echo '</ol>';
///////// \$iaFiller->css(); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_css'><b>\$iaFiller->css() <span>: </span></b>
FUNCTIONDEF;
echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Lib\iaFiller", "css")."</pre>";
echo "<ol class='usage'>";
/// display ///
echo <<< DOCUMENT_EXAMPLE
<li>\$iaFiller->css();
-> </b><br><pre>
DOCUMENT_EXAMPLE;
/// run ///
print_r(
$iaFiller->css()
);
echo "</pre>";
echo '</ol>';
///////// \$iaFiller->js_lib(); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_js_lib'><b>\$iaFiller->js_lib() <span>: </span></b>
FUNCTIONDEF;
echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Lib\iaFiller", "js_lib")."</pre>";
echo "<ol class='usage'>";
/// display ///
echo <<< DOCUMENT_EXAMPLE
<li>\$iaFiller->js_lib();
-> </b><br><pre>
DOCUMENT_EXAMPLE;
/// run ///
print_r(
$iaFiller->js_lib()
);
echo "</pre>";
echo '</ol>';
///////// \$iaFiller->jsInit(); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_jsInit'><b>\$iaFiller->jsInit(<span class="type">string</span> \$dataContainerSelector <span class="default">= '#iaFilterForm'</span>, <span class="type">string</span> \$fillerSelector <span class="default">= '#iaFiller'</span>, <span class="type">string</span> \$ajaxUrl <span class="default">= ''</span>) <span>: </span></b>
FUNCTIONDEF;
echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Lib\iaFiller", "jsInit")."</pre>";
echo "<ol class='usage'>";
/// display ///
echo <<< DOCUMENT_EXAMPLE
<li>\$iaFiller->jsInit();
-> </b><br><pre>
DOCUMENT_EXAMPLE;
/// run ///
print_r(
$iaFiller->jsInit()
);
echo "</pre>";
echo '</ol>';
///////// \$iaFiller->lista(); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_lista'><b>\$iaFiller->lista() <span>: array</span></b>
FUNCTIONDEF;
echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Lib\iaFiller", "lista")."</pre>";
echo "<ol class='usage'>";
/// display ///
echo <<< DOCUMENT_EXAMPLE
<li>\$iaFiller->lista();
-> </b><br><pre>
DOCUMENT_EXAMPLE;
/// run ///
print_r(
$iaFiller->lista()
);
echo "</pre>";
echo '</ol>';
///////// \$iaFiller->delete(null /* =mixed= */); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_delete'><b>\$iaFiller->delete(<span class="type">mixed</span> \$iaFiller_id) <span>: </span></b>
FUNCTIONDEF;
echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Lib\iaFiller", "delete")."</pre>";
echo "<ol class='usage'>";
/// display ///
echo <<< DOCUMENT_EXAMPLE
<li>\$iaFiller->delete(null /* =mixed= */);
-> </b><br><pre>
DOCUMENT_EXAMPLE;
/// run ///
print_r(
$iaFiller->delete(null /* =mixed= */)
);
echo "</pre>";
echo '</ol>';
///////// \$iaFiller->save(3, 'palabra', 'palabra', 'palabra', 'palabra'); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_save'><b>\$iaFiller->save(<span class="type">int</span> \$iaFiller_id, <span class="type">string \$nombre</span> \$nombre, <span class="type">string</span> \$descripcion, <span class="type">string</span> \$color, <span class="type">string</span> \$vals) <span>: string</span></b>
FUNCTIONDEF;
echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Lib\iaFiller", "save")."</pre>";
echo "<ol class='usage'>";
/// display ///
echo <<< DOCUMENT_EXAMPLE
<li>\$iaFiller->save(3, 'palabra', 'palabra', 'palabra', 'palabra'); ->
DOCUMENT_EXAMPLE;
/// run ///
echo $iaFiller->save(3, 'palabra', 'palabra', 'palabra', 'palabra');
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\iaFiller;
use PHPUnit\Framework\TestCase;
class iaFillerTest extends TestCase {
/**
* @dataProvider htmlHead_Provider
*
*/
public function test_htmlHead($dataContainerSelector, $iaFillerSelector, $ajaUrl , $expected) {
$iaFiller = new iaFiller($db, $tag, $mayEdit, $webRoot);
$this->assertEquals($expected, $iaFiller->htmlHead($dataContainerSelector, $iaFillerSelector, $ajaUrl) );
}
function htmlHead_Provider() {
return [
'test 1' => [ '', '', '', '' ],
];
}
/**
* @dataProvider css_Provider
*
*/
public function test_css( $expected) {
$iaFiller = new iaFiller($db, $tag, $mayEdit, $webRoot);
$this->assertEquals($expected, $iaFiller->css() );
}
function css_Provider() {
return [
'test 1' => [ '' ],
];
}
/**
* @dataProvider js_lib_Provider
*
*/
public function test_js_lib( $expected) {
$iaFiller = new iaFiller($db, $tag, $mayEdit, $webRoot);
$this->assertEquals($expected, $iaFiller->js_lib() );
}
function js_lib_Provider() {
return [
'test 1' => [ '' ],
];
}
/**
* @dataProvider jsInit_Provider
*
*/
public function test_jsInit($dataContainerSelector, $fillerSelector, $ajaxUrl , $expected) {
$iaFiller = new iaFiller($db, $tag, $mayEdit, $webRoot);
$this->assertEquals($expected, $iaFiller->jsInit($dataContainerSelector, $fillerSelector, $ajaxUrl) );
}
function jsInit_Provider() {
return [
'test 1' => [ '', '', '', '' ],
];
}
/**
* @dataProvider lista_Provider
*
*/
public function test_lista( $expected) {
$iaFiller = new iaFiller($db, $tag, $mayEdit, $webRoot);
$this->assertEquals($expected, $iaFiller->lista() );
}
function lista_Provider() {
return [
'test 1' => [ '' ],
];
}
/**
* @dataProvider delete_Provider
*
*/
public function test_delete($iaFiller_id , $expected) {
$iaFiller = new iaFiller($db, $tag, $mayEdit, $webRoot);
$this->assertEquals($expected, $iaFiller->delete($iaFiller_id) );
}
function delete_Provider() {
return [
'test 1' => [ '', '' ],
];
}
/**
* @dataProvider save_Provider
*
*/
public function test_save($iaFiller_id, $nombre, $descripcion, $color, $vals , $expected) {
$iaFiller = new iaFiller($db, $tag, $mayEdit, $webRoot);
$this->assertEquals($expected, $iaFiller->save($iaFiller_id, $nombre, $descripcion, $color, $vals) );
}
function save_Provider() {
return [
'test 1' => [ '', '', '', '', '', '' ],
];
}
}
ia Doc