/iaLib/ia_examples/ia/Util/Str_example.php
<?php
$ia_example = [
'title' => 'ia\Util\Str', // fully qualified className
'summary' => '', // class summary
'full_example' => '', // full usage example, relative path from ia_examples, blank '' not shown.
'example_file' => 'code/ia/Util/Str_example_code.php', // method by method example, blank '' not shown.
];
include( __DIR__ . '/../../template/ia_example_class.php');
/iaLib/ia_examples/code/ia/Util/Str_example_code.php
use ia\Util\Str;
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 '<ul class="usage">';
///////// Str::strim('palabra'); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_strim'><b>Str::strim(<span class="type">string</span> \$str) <span>: string</span></b>
FUNCTIONDEF;
echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Util\Str", "strim")."</pre>";
echo "<ol class='usage'>";
/// display ///
echo <<< DOCUMENT_EXAMPLE
<li>Str::strim('palabra'); ->
DOCUMENT_EXAMPLE;
/// run ///
echo Str::strim('palabra');
echo '</ol>';
///////// Str::jsStrIt(null /* == */); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_jsStrIt'><b>Str::jsStrIt(<span class="type"></span> \$s) <span>: </span></b>
FUNCTIONDEF;
echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Util\Str", "jsStrIt")."</pre>";
echo "<ol class='usage'>";
/// display ///
echo <<< DOCUMENT_EXAMPLE
<li>Str::jsStrIt(null /* == */);
-> </b><br><pre>
DOCUMENT_EXAMPLE;
/// run ///
print_r(
Str::jsStrIt(null /* == */)
);
echo "</pre>";
echo '</ol>';
///////// Str::replacePos('palabra', 'palabra', 3); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_replacePos'><b>Str::replacePos(<span class="type">string</span> \$palabra, <span class="type">string</span> \$replaceChar, <span class="type">int</span> \$n) <span>: string</span></b>
FUNCTIONDEF;
echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Util\Str", "replacePos")."</pre>";
echo "<ol class='usage'>";
/// display ///
echo <<< DOCUMENT_EXAMPLE
<li>Str::replacePos('palabra', 'palabra', 3); ->
DOCUMENT_EXAMPLE;
/// run ///
echo Str::replacePos('palabra', 'palabra', 3);
echo '</ol>';
///////// Str::camel2Words(null /* == */); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_camel2Words'><b>Str::camel2Words(<span class="type"></span> \$s) <span>: </span></b>
FUNCTIONDEF;
echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Util\Str", "camel2Words")."</pre>";
echo "<ol class='usage'>";
/// display ///
echo <<< DOCUMENT_EXAMPLE
<li>Str::camel2Words(null /* == */);
-> </b><br><pre>
DOCUMENT_EXAMPLE;
/// run ///
print_r(
Str::camel2Words(null /* == */)
);
echo "</pre>";
echo '</ol>';
///////// Str::camel2snake(null /* == */); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_camel2snake'><b>Str::camel2snake(<span class="type"></span> \$s) <span>: </span></b>
FUNCTIONDEF;
echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Util\Str", "camel2snake")."</pre>";
echo "<ol class='usage'>";
/// display ///
echo <<< DOCUMENT_EXAMPLE
<li>Str::camel2snake(null /* == */);
-> </b><br><pre>
DOCUMENT_EXAMPLE;
/// run ///
print_r(
Str::camel2snake(null /* == */)
);
echo "</pre>";
echo '</ol>';
///////// Str::snake2camel(null /* == */); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_snake2camel'><b>Str::snake2camel(<span class="type"></span> \$s) <span>: </span></b>
FUNCTIONDEF;
echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Util\Str", "snake2camel")."</pre>";
echo "<ol class='usage'>";
/// display ///
echo <<< DOCUMENT_EXAMPLE
<li>Str::snake2camel(null /* == */);
-> </b><br><pre>
DOCUMENT_EXAMPLE;
/// run ///
print_r(
Str::snake2camel(null /* == */)
);
echo "</pre>";
echo '</ol>';
///////// Str::toLabel(null /* == */); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_toLabel'><b>Str::toLabel(<span class="type"></span> \$s) <span>: </span></b>
FUNCTIONDEF;
echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Util\Str", "toLabel")."</pre>";
echo "<ol class='usage'>";
/// display ///
echo <<< DOCUMENT_EXAMPLE
<li>Str::toLabel(null /* == */);
-> </b><br><pre>
DOCUMENT_EXAMPLE;
/// run ///
print_r(
Str::toLabel(null /* == */)
);
echo "</pre>";
echo '</ol>';
///////// Str::standardize('palabra'); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_standardize'><b>Str::standardize(<span class="type">string</span> \$palabra) <span>: string</span></b>
FUNCTIONDEF;
echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Util\Str", "standardize")."</pre>";
echo "<ol class='usage'>";
/// display ///
echo <<< DOCUMENT_EXAMPLE
<li>Str::standardize('palabra'); ->
DOCUMENT_EXAMPLE;
/// run ///
echo Str::standardize('palabra');
echo '</ol>';
///////// Str::strit('palabra'); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_strit'><b>Str::strit(<span class="type">string</span> \$str, <span class="type">integer</span> \$maxLength <span class="default">= 0</span>, <span class="type">bool</span> \$maxLengthInCharacters <span class="default">= true</span>) <span>: string</span></b>
FUNCTIONDEF;
echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Util\Str", "strit")."</pre>";
echo "<ol class='usage'>";
/// display ///
echo <<< DOCUMENT_EXAMPLE
<li>Str::strit('palabra'); ->
DOCUMENT_EXAMPLE;
/// run ///
echo Str::strit('palabra');
echo '</ol>';
///////// Str::stritc('palabra'); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_stritc'><b>Str::stritc(<span class="type">string</span> \$str, <span class="type">integer</span> \$maxLength <span class="default">= 0</span>, <span class="type">bool</span> \$maxLengthInCharacters <span class="default">= true</span>) <span>: string</span></b>
FUNCTIONDEF;
echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Util\Str", "stritc")."</pre>";
echo "<ol class='usage'>";
/// display ///
echo <<< DOCUMENT_EXAMPLE
<li>Str::stritc('palabra'); ->
DOCUMENT_EXAMPLE;
/// run ///
echo Str::stritc('palabra');
echo '</ol>';
///////// Str::strlike('palabra'); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_strlike'><b>Str::strlike(<span class="type">string</span> \$str) <span>: string</span></b>
FUNCTIONDEF;
echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Util\Str", "strlike")."</pre>";
echo "<ol class='usage'>";
/// display ///
echo <<< DOCUMENT_EXAMPLE
<li>Str::strlike('palabra'); ->
DOCUMENT_EXAMPLE;
/// run ///
echo Str::strlike('palabra');
echo '</ol>';
///////// Str::fieldit('palabra'); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_fieldit'><b>Str::fieldit(<span class="type">string</span> \$fieldName) <span>: string</span></b>
FUNCTIONDEF;
echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Util\Str", "fieldit")."</pre>";
echo "<ol class='usage'>";
/// display ///
echo <<< DOCUMENT_EXAMPLE
<li>Str::fieldit('palabra'); ->
DOCUMENT_EXAMPLE;
/// run ///
echo Str::fieldit('palabra');
echo '</ol>';
///////// Str::sqlNormalized('palabra'); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_sqlNormalized'><b>Str::sqlNormalized(<span class="type">string</span> \$sql) <span>: string</span></b>
FUNCTIONDEF;
echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Util\Str", "sqlNormalized")."</pre>";
echo "<ol class='usage'>";
/// display ///
echo <<< DOCUMENT_EXAMPLE
<li>Str::sqlNormalized('palabra'); ->
DOCUMENT_EXAMPLE;
/// run ///
echo Str::sqlNormalized('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\Util\Str;
use PHPUnit\Framework\TestCase;
class StrTest extends TestCase {
/**
* @dataProvider strim_Provider
*
*/
public function test_strim($str , $expected) {
$this->assertEquals($expected, Str::strim($str) );
}
function strim_Provider() {
return [
'test 1' => [ '', '' ],
];
}
/**
* @dataProvider jsStrIt_Provider
*
*/
public function test_jsStrIt($s , $expected) {
$this->assertEquals($expected, Str::jsStrIt($s) );
}
function jsStrIt_Provider() {
return [
'test 1' => [ '', '' ],
];
}
/**
* @dataProvider replacePos_Provider
*
*/
public function test_replacePos($palabra, $replaceChar, $n , $expected) {
$this->assertEquals($expected, Str::replacePos($palabra, $replaceChar, $n) );
}
function replacePos_Provider() {
return [
'test 1' => [ '', '', '', '' ],
];
}
/**
* @dataProvider camel2Words_Provider
*
*/
public function test_camel2Words($s , $expected) {
$this->assertEquals($expected, Str::camel2Words($s) );
}
function camel2Words_Provider() {
return [
'test 1' => [ '', '' ],
];
}
/**
* @dataProvider camel2snake_Provider
*
*/
public function test_camel2snake($s , $expected) {
$this->assertEquals($expected, Str::camel2snake($s) );
}
function camel2snake_Provider() {
return [
'test 1' => [ '', '' ],
];
}
/**
* @dataProvider snake2camel_Provider
*
*/
public function test_snake2camel($s , $expected) {
$this->assertEquals($expected, Str::snake2camel($s) );
}
function snake2camel_Provider() {
return [
'test 1' => [ '', '' ],
];
}
/**
* @dataProvider toLabel_Provider
*
*/
public function test_toLabel($s , $expected) {
$this->assertEquals($expected, Str::toLabel($s) );
}
function toLabel_Provider() {
return [
'test 1' => [ '', '' ],
];
}
/**
* @dataProvider standardize_Provider
*
*/
public function test_standardize($palabra , $expected) {
$this->assertEquals($expected, Str::standardize($palabra) );
}
function standardize_Provider() {
return [
'test 1' => [ '', '' ],
];
}
/**
* @dataProvider strit_Provider
*
*/
public function test_strit($str, $maxLength, $maxLengthInCharacters , $expected) {
$this->assertEquals($expected, Str::strit($str, $maxLength, $maxLengthInCharacters) );
}
function strit_Provider() {
return [
'test 1' => [ '', '', '', '' ],
];
}
/**
* @dataProvider stritc_Provider
*
*/
public function test_stritc($str, $maxLength, $maxLengthInCharacters , $expected) {
$this->assertEquals($expected, Str::stritc($str, $maxLength, $maxLengthInCharacters) );
}
function stritc_Provider() {
return [
'test 1' => [ '', '', '', '' ],
];
}
/**
* @dataProvider strlike_Provider
*
*/
public function test_strlike($str , $expected) {
$this->assertEquals($expected, Str::strlike($str) );
}
function strlike_Provider() {
return [
'test 1' => [ '', '' ],
];
}
/**
* @dataProvider fieldit_Provider
*
*/
public function test_fieldit($fieldName , $expected) {
$this->assertEquals($expected, Str::fieldit($fieldName) );
}
function fieldit_Provider() {
return [
'test 1' => [ '', '' ],
];
}
/**
* @dataProvider sqlNormalized_Provider
*
*/
public function test_sqlNormalized($sql , $expected) {
$this->assertEquals($expected, Str::sqlNormalized($sql) );
}
function sqlNormalized_Provider() {
return [
'test 1' => [ '', '' ],
];
}
}
ia Doc