/iaLib/ia_examples/ia/Lib/Synonyms_example.php
<?php
$ia_example = [
'title' => 'ia\Lib\Synonyms', // fully qualified className
'summary' => '', // class summary
'full_example' => '', // full usage example, relative path from ia_examples, blank '' not shown.
'example_file' => 'code/ia/Lib/Synonyms_example_code.php', // method by method example, blank '' not shown.
];
include( __DIR__ . '/../../template/ia_example_class.php');
/iaLib/ia_examples/code/ia/Lib/Synonyms_example_code.php
use ia\Lib\Synonyms;
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>
/**
* Synonyms::__construct()
*
* @param bool \$tryPluralSingular
* @param string \$parent_id
* @param string \$parent_table
* @return
*/
/*
\$synonyms = new Synonyms(<span class="type">bool</span> \$tryPluralSingular <span class="default">= true</span>, <span class="type">string</span> \$parent_id <span class="default">= ''</span>, <span class="type">string</span> \$parent_table <span class="default">= ''</span>);
*/
\$synonyms = new Synonyms();
</pre>
CONSTRUCTOR_PROTOTYPE;
$synonyms = new Synonyms();
echo '<ul class="usage">';
///////// \$synonyms->is_inDictionary('palabra'); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_is_inDictionary'><b>\$synonyms->is_inDictionary(<span class="type">string</span> \$alternativeName, <span class="type">string|null</span> \$parent_id <span class="default">= null</span>, <span class="type">string|null</span> \$parent_table <span class="default">= null</span>) <span>: bool</span></b>
FUNCTIONDEF;
echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Lib\Synonyms", "is_inDictionary")."</pre>";
echo "<ol class='usage'>";
/// display ///
echo <<< DOCUMENT_EXAMPLE
<li>\$synonyms->is_inDictionary('palabra'); ->
DOCUMENT_EXAMPLE;
///run ///
echo ($synonyms->is_inDictionary('palabra') ? 'true' : 'false');
echo '</ol>';
///////// \$synonyms->get_originalName('palabra'); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_get_originalName'><b>\$synonyms->get_originalName(<span class="type">string</span> \$alternativeName, <span class="type">string|null</span> \$parent_id <span class="default">= null</span>, <span class="type">string|null</span> \$parent_table <span class="default">= null</span>) <span>: string|null</span></b>
FUNCTIONDEF;
echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Lib\Synonyms", "get_originalName")."</pre>";
echo "<ol class='usage'>";
/// display ///
echo <<< DOCUMENT_EXAMPLE
<li>\$synonyms->get_originalName('palabra');
-> </b><br><pre>
DOCUMENT_EXAMPLE;
/// run ///
print_r(
$synonyms->get_originalName('palabra')
);
echo "</pre>";
echo '</ol>';
///////// \$synonyms->get_original_id('palabra'); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_get_original_id'><b>\$synonyms->get_original_id(<span class="type">string</span> \$alternativeName, <span class="type">string|null</span> \$parent_id <span class="default">= null</span>, <span class="type">string|null</span> \$parent_table <span class="default">= null</span>) <span>: string|null</span></b>
FUNCTIONDEF;
echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Lib\Synonyms", "get_original_id")."</pre>";
echo "<ol class='usage'>";
/// display ///
echo <<< DOCUMENT_EXAMPLE
<li>\$synonyms->get_original_id('palabra');
-> </b><br><pre>
DOCUMENT_EXAMPLE;
/// run ///
print_r(
$synonyms->get_original_id('palabra')
);
echo "</pre>";
echo '</ol>';
///////// \$synonyms->addSynonymsArray(['a' => '1', 'b' => '2', 'c' => 3]); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_addSynonymsArray'><b>\$synonyms->addSynonymsArray(<span class="type">array</span> \$synonyms, <span class="type">string|null</span> \$parent_id <span class="default">= null</span>, <span class="type">string|null</span> \$parent_table <span class="default">= null</span>) <span>: </span></b>
FUNCTIONDEF;
echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Lib\Synonyms", "addSynonymsArray")."</pre>";
echo "<ol class='usage'>";
/// display ///
echo <<< DOCUMENT_EXAMPLE
<li>\$synonyms->addSynonymsArray(['a' => '1', 'b' => '2', 'c' => 3]);
-> </b><br><pre>
DOCUMENT_EXAMPLE;
/// run ///
print_r(
$synonyms->addSynonymsArray(['a' => '1', 'b' => '2', 'c' => 3])
);
echo "</pre>";
echo '</ol>';
///////// \$synonyms->addSynonym('palabra', 'palabra'); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_addSynonym'><b>\$synonyms->addSynonym(<span class="type">string</span> \$alternativeName, <span class="type">string</span> \$original, <span class="type">string</span> \$original_id <span class="default">= null</span>, <span class="type">string|null</span> \$parent_id <span class="default">= null</span>, <span class="type">string|null</span> \$parent_table <span class="default">= null</span>) <span>: </span></b>
FUNCTIONDEF;
echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Lib\Synonyms", "addSynonym")."</pre>";
echo "<ol class='usage'>";
/// display ///
echo <<< DOCUMENT_EXAMPLE
<li>\$synonyms->addSynonym('palabra', 'palabra');
-> </b><br><pre>
DOCUMENT_EXAMPLE;
/// run ///
print_r(
$synonyms->addSynonym('palabra', 'palabra')
);
echo "</pre>";
echo '</ol>';
///////// \$synonyms->dbLoadSynonyms(\$gSqlClass, 'palabra', 'palabra'); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_dbLoadSynonyms'><b>\$synonyms->dbLoadSynonyms(<span class="type">IaMysqli</span> \$db, <span class="type">string</span> \$parent_id, <span class="type">string</span> \$parent_table) <span>: bool</span></b>
FUNCTIONDEF;
echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Lib\Synonyms", "dbLoadSynonyms")."</pre>";
echo "<ol class='usage'>";
/// display ///
echo <<< DOCUMENT_EXAMPLE
<li>\$synonyms->dbLoadSynonyms(\$gSqlClass, 'palabra', 'palabra'); ->
DOCUMENT_EXAMPLE;
///run ///
echo ($synonyms->dbLoadSynonyms($gSqlClass, 'palabra', 'palabra') ? 'true' : 'false');
echo '</ol>';
///////// \$synonyms->dbAddSynonymsArray(\$gSqlClass, ['a' => '1', 'b' => '2', 'c' => 3]); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_dbAddSynonymsArray'><b>\$synonyms->dbAddSynonymsArray(<span class="type">IaMysqli</span> \$db, <span class="type">array</span> \$synonyms, <span class="type">string|null</span> \$parent_id <span class="default">= null</span>, <span class="type">string|null</span> \$parent_table <span class="default">= null</span>) <span>: true</span></b>
FUNCTIONDEF;
echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Lib\Synonyms", "dbAddSynonymsArray")."</pre>";
echo "<ol class='usage'>";
/// display ///
echo <<< DOCUMENT_EXAMPLE
<li>\$synonyms->dbAddSynonymsArray(\$gSqlClass, ['a' => '1', 'b' => '2', 'c' => 3]);
-> </b><br><pre>
DOCUMENT_EXAMPLE;
/// run ///
print_r(
$synonyms->dbAddSynonymsArray($gSqlClass, ['a' => '1', 'b' => '2', 'c' => 3])
);
echo "</pre>";
echo '</ol>';
///////// Synonyms::queryUpdateOriginal('palabra', 'palabra', 'palabra', 'palabra'); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_queryUpdateOriginal'><b>Synonyms::queryUpdateOriginal(<span class="type">string|null</span> \$parent_table, <span class="type">string|null</span> \$parent_id, <span class="type">string</span> \$original, <span class="type">string</span> \$newOriginal) <span>: bool</span></b>
FUNCTIONDEF;
echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Lib\Synonyms", "queryUpdateOriginal")."</pre>";
echo "<ol class='usage'>";
/// display ///
echo <<< DOCUMENT_EXAMPLE
<li>Synonyms::queryUpdateOriginal('palabra', 'palabra', 'palabra', 'palabra'); ->
DOCUMENT_EXAMPLE;
///run ///
echo (Synonyms::queryUpdateOriginal('palabra', 'palabra', 'palabra', 'palabra') ? 'true' : 'false');
echo '</ol>';
///////// Synonyms::queryUpdateOriginalById('palabra', 'palabra', 'palabra', 'palabra'); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_queryUpdateOriginalById'><b>Synonyms::queryUpdateOriginalById(<span class="type">string|null</span> \$parent_table, <span class="type">string|null</span> \$parent_id, <span class="type">string</span> \$original_id, <span class="type">string</span> \$newOriginal) <span>: bool</span></b>
FUNCTIONDEF;
echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Lib\Synonyms", "queryUpdateOriginalById")."</pre>";
echo "<ol class='usage'>";
/// display ///
echo <<< DOCUMENT_EXAMPLE
<li>Synonyms::queryUpdateOriginalById('palabra', 'palabra', 'palabra', 'palabra'); ->
DOCUMENT_EXAMPLE;
///run ///
echo (Synonyms::queryUpdateOriginalById('palabra', 'palabra', 'palabra', 'palabra') ? 'true' : 'false');
echo '</ol>';
///////// Synonyms::queryDeleteSynonym('palabra', 'palabra', 'palabra'); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_queryDeleteSynonym'><b>Synonyms::queryDeleteSynonym(<span class="type">string|null</span> \$parent_table, <span class="type">string|null</span> \$parent_id, <span class="type">string</span> \$synonym) <span>: bool</span></b>
FUNCTIONDEF;
echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Lib\Synonyms", "queryDeleteSynonym")."</pre>";
echo "<ol class='usage'>";
/// display ///
echo <<< DOCUMENT_EXAMPLE
<li>Synonyms::queryDeleteSynonym('palabra', 'palabra', 'palabra'); ->
DOCUMENT_EXAMPLE;
///run ///
echo (Synonyms::queryDeleteSynonym('palabra', 'palabra', 'palabra') ? 'true' : 'false');
echo '</ol>';
///////// Synonyms::queryDeleteOriginal('palabra', 'palabra', 'palabra'); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_queryDeleteOriginal'><b>Synonyms::queryDeleteOriginal(<span class="type">string|null</span> \$parent_table, <span class="type">string|null</span> \$parent_id, <span class="type">string</span> \$original) <span>: bool</span></b>
FUNCTIONDEF;
echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Lib\Synonyms", "queryDeleteOriginal")."</pre>";
echo "<ol class='usage'>";
/// display ///
echo <<< DOCUMENT_EXAMPLE
<li>Synonyms::queryDeleteOriginal('palabra', 'palabra', 'palabra'); ->
DOCUMENT_EXAMPLE;
///run ///
echo (Synonyms::queryDeleteOriginal('palabra', 'palabra', 'palabra') ? 'true' : 'false');
echo '</ol>';
///////// Synonyms::queryDeleteOriginal_id('palabra', 'palabra', null /* == */); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_queryDeleteOriginal_id'><b>Synonyms::queryDeleteOriginal_id(<span class="type">string|null</span> \$parent_table, <span class="type">string|null</span> \$parent_id, <span class="type"></span> \$original_id) <span>: bool</span></b>
FUNCTIONDEF;
echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Lib\Synonyms", "queryDeleteOriginal_id")."</pre>";
echo "<ol class='usage'>";
/// display ///
echo <<< DOCUMENT_EXAMPLE
<li>Synonyms::queryDeleteOriginal_id('palabra', 'palabra', null /* == */); ->
DOCUMENT_EXAMPLE;
///run ///
echo (Synonyms::queryDeleteOriginal_id('palabra', 'palabra', null /* == */) ? 'true' : 'false');
echo '</ol>';
///////// \$synonyms->dbReadSynonymOriginal(\$gSqlClass); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_dbReadSynonymOriginal'><b>\$synonyms->dbReadSynonymOriginal(<span class="type">IaMysqli</span> \$db, <span class="type">string</span> \$parent_id <span class="default">= null</span>, <span class="type">string</span> \$parent_table <span class="default">= null</span>) <span>: array|bool</span></b>
FUNCTIONDEF;
echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Lib\Synonyms", "dbReadSynonymOriginal")."</pre>";
echo "<ol class='usage'>";
/// display ///
echo <<< DOCUMENT_EXAMPLE
<li>\$synonyms->dbReadSynonymOriginal(\$gSqlClass);
-> </b><br><pre>
DOCUMENT_EXAMPLE;
/// run ///
print_r(
$synonyms->dbReadSynonymOriginal($gSqlClass)
);
echo "</pre>";
echo '</ol>';
///////// \$synonyms->dbReadSynonymOriginal_id(\$gSqlClass); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_dbReadSynonymOriginal_id'><b>\$synonyms->dbReadSynonymOriginal_id(<span class="type">IaMysqli</span> \$db, <span class="type">string</span> \$parent_id <span class="default">= null</span>, <span class="type">string</span> \$parent_table <span class="default">= null</span>) <span>: array|bool</span></b>
FUNCTIONDEF;
echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Lib\Synonyms", "dbReadSynonymOriginal_id")."</pre>";
echo "<ol class='usage'>";
/// display ///
echo <<< DOCUMENT_EXAMPLE
<li>\$synonyms->dbReadSynonymOriginal_id(\$gSqlClass);
-> </b><br><pre>
DOCUMENT_EXAMPLE;
/// run ///
print_r(
$synonyms->dbReadSynonymOriginal_id($gSqlClass)
);
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\Lib\Synonyms;
use PHPUnit\Framework\TestCase;
class SynonymsTest extends TestCase {
/**
* @dataProvider is_inDictionary_Provider
*
*/
public function test_is_inDictionary($alternativeName, $parent_id, $parent_table , $expected) {
$synonyms = new Synonyms($tryPluralSingular, $parent_id, $parent_table);
$this->assertEquals($expected, $synonyms->is_inDictionary($alternativeName, $parent_id, $parent_table) );
}
function is_inDictionary_Provider() {
return [
'test 1' => [ '', '', '', '' ],
];
}
/**
* @dataProvider get_originalName_Provider
*
*/
public function test_get_originalName($alternativeName, $parent_id, $parent_table , $expected) {
$synonyms = new Synonyms($tryPluralSingular, $parent_id, $parent_table);
$this->assertEquals($expected, $synonyms->get_originalName($alternativeName, $parent_id, $parent_table) );
}
function get_originalName_Provider() {
return [
'test 1' => [ '', '', '', '' ],
];
}
/**
* @dataProvider get_original_id_Provider
*
*/
public function test_get_original_id($alternativeName, $parent_id, $parent_table , $expected) {
$synonyms = new Synonyms($tryPluralSingular, $parent_id, $parent_table);
$this->assertEquals($expected, $synonyms->get_original_id($alternativeName, $parent_id, $parent_table) );
}
function get_original_id_Provider() {
return [
'test 1' => [ '', '', '', '' ],
];
}
/**
* @dataProvider addSynonymsArray_Provider
*
*/
public function test_addSynonymsArray($synonyms, $parent_id, $parent_table , $expected) {
$synonyms = new Synonyms($tryPluralSingular, $parent_id, $parent_table);
$this->assertEquals($expected, $synonyms->addSynonymsArray($synonyms, $parent_id, $parent_table) );
}
function addSynonymsArray_Provider() {
return [
'test 1' => [ '', '', '', '' ],
];
}
/**
* @dataProvider addSynonym_Provider
*
*/
public function test_addSynonym($alternativeName, $original, $original_id, $parent_id, $parent_table , $expected) {
$synonyms = new Synonyms($tryPluralSingular, $parent_id, $parent_table);
$this->assertEquals($expected, $synonyms->addSynonym($alternativeName, $original, $original_id, $parent_id, $parent_table) );
}
function addSynonym_Provider() {
return [
'test 1' => [ '', '', '', '', '', '' ],
];
}
/**
* @dataProvider dbLoadSynonyms_Provider
*
*/
public function test_dbLoadSynonyms($db, $parent_id, $parent_table , $expected) {
$synonyms = new Synonyms($tryPluralSingular, $parent_id, $parent_table);
$this->assertEquals($expected, $synonyms->dbLoadSynonyms($db, $parent_id, $parent_table) );
}
function dbLoadSynonyms_Provider() {
return [
'test 1' => [ '', '', '', '' ],
];
}
/**
* @dataProvider dbAddSynonymsArray_Provider
*
*/
public function test_dbAddSynonymsArray($db, $synonyms, $parent_id, $parent_table , $expected) {
$synonyms = new Synonyms($tryPluralSingular, $parent_id, $parent_table);
$this->assertEquals($expected, $synonyms->dbAddSynonymsArray($db, $synonyms, $parent_id, $parent_table) );
}
function dbAddSynonymsArray_Provider() {
return [
'test 1' => [ '', '', '', '', '' ],
];
}
/**
* @dataProvider queryUpdateOriginal_Provider
*
*/
public function test_queryUpdateOriginal($parent_table, $parent_id, $original, $newOriginal , $expected) {
$this->assertEquals($expected, Synonyms::queryUpdateOriginal($parent_table, $parent_id, $original, $newOriginal) );
}
function queryUpdateOriginal_Provider() {
return [
'test 1' => [ '', '', '', '', '' ],
];
}
/**
* @dataProvider queryUpdateOriginalById_Provider
*
*/
public function test_queryUpdateOriginalById($parent_table, $parent_id, $original_id, $newOriginal , $expected) {
$this->assertEquals($expected, Synonyms::queryUpdateOriginalById($parent_table, $parent_id, $original_id, $newOriginal) );
}
function queryUpdateOriginalById_Provider() {
return [
'test 1' => [ '', '', '', '', '' ],
];
}
/**
* @dataProvider queryDeleteSynonym_Provider
*
*/
public function test_queryDeleteSynonym($parent_table, $parent_id, $synonym , $expected) {
$this->assertEquals($expected, Synonyms::queryDeleteSynonym($parent_table, $parent_id, $synonym) );
}
function queryDeleteSynonym_Provider() {
return [
'test 1' => [ '', '', '', '' ],
];
}
/**
* @dataProvider queryDeleteOriginal_Provider
*
*/
public function test_queryDeleteOriginal($parent_table, $parent_id, $original , $expected) {
$this->assertEquals($expected, Synonyms::queryDeleteOriginal($parent_table, $parent_id, $original) );
}
function queryDeleteOriginal_Provider() {
return [
'test 1' => [ '', '', '', '' ],
];
}
/**
* @dataProvider queryDeleteOriginal_id_Provider
*
*/
public function test_queryDeleteOriginal_id($parent_table, $parent_id, $original_id , $expected) {
$this->assertEquals($expected, Synonyms::queryDeleteOriginal_id($parent_table, $parent_id, $original_id) );
}
function queryDeleteOriginal_id_Provider() {
return [
'test 1' => [ '', '', '', '' ],
];
}
/**
* @dataProvider dbReadSynonymOriginal_Provider
*
*/
public function test_dbReadSynonymOriginal($db, $parent_id, $parent_table , $expected) {
$synonyms = new Synonyms($tryPluralSingular, $parent_id, $parent_table);
$this->assertEquals($expected, $synonyms->dbReadSynonymOriginal($db, $parent_id, $parent_table) );
}
function dbReadSynonymOriginal_Provider() {
return [
'test 1' => [ '', '', '', '' ],
];
}
/**
* @dataProvider dbReadSynonymOriginal_id_Provider
*
*/
public function test_dbReadSynonymOriginal_id($db, $parent_id, $parent_table , $expected) {
$synonyms = new Synonyms($tryPluralSingular, $parent_id, $parent_table);
$this->assertEquals($expected, $synonyms->dbReadSynonymOriginal_id($db, $parent_id, $parent_table) );
}
function dbReadSynonymOriginal_id_Provider() {
return [
'test 1' => [ '', '', '', '' ],
];
}
}
ia Doc
ia doc & examples: templates
Documentation
Index
Examples List