/iaLib/ia_examples/ia/Lib/iaUploadFile_example.php
<?php
$ia_example = [
'title' => 'ia\Lib\iaUploadFile', // fully qualified className
'summary' => '', // class summary
'full_example' => '', // full usage example, relative path from ia_examples, blank '' not shown.
'example_file' => 'code/ia/Lib/iaUploadFile_example_code.php', // method by method example, blank '' not shown.
];
include( __DIR__ . '/../../template/ia_example_class.php');
/iaLib/ia_examples/code/ia/Lib/iaUploadFile_example_code.php
use ia\Lib\iaUploadFile;
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>
/*
\$iaUploadFile = new iaUploadFile(<span class="type"></span> \$fsWebroot <span class="default">= null</span>, <span class="type"></span> \$allowOverwrite <span class="default">= false</span>);
*/
\$iaUploadFile = new iaUploadFile();
</pre>
CONSTRUCTOR_PROTOTYPE;
$iaUploadFile = new iaUploadFile();
echo '<ul class="usage">';
///////// \$iaUploadFile->get_result(); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_get_result'><b>\$iaUploadFile->get_result() <span>: </span></b>
FUNCTIONDEF;
echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Lib\iaUploadFile", "get_result")."</pre>";
echo "<ol class='usage'>";
/// display ///
echo <<< DOCUMENT_EXAMPLE
<li>\$iaUploadFile->get_result();
-> </b><br><pre>
DOCUMENT_EXAMPLE;
/// run ///
print_r(
$iaUploadFile->get_result()
);
echo "</pre>";
echo '</ol>';
///////// \$iaUploadFile->uploadToDir(null /* == */, null /* == */, null /* == */); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_uploadToDir'><b>\$iaUploadFile->uploadToDir(<span class="type"></span> \$uploadKeys, <span class="type"></span> \$webDir, <span class="type"></span> \$fileTypes, <span class="type"></span> \$generateUniqueName <span class="default">= false</span>) <span>: </span></b>
FUNCTIONDEF;
echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Lib\iaUploadFile", "uploadToDir")."</pre>";
echo "<ol class='usage'>";
/// display ///
echo <<< DOCUMENT_EXAMPLE
<li>\$iaUploadFile->uploadToDir(null /* == */, null /* == */, null /* == */);
-> </b><br><pre>
DOCUMENT_EXAMPLE;
/// run ///
print_r(
$iaUploadFile->uploadToDir(null /* == */, null /* == */, null /* == */)
);
echo "</pre>";
echo '</ol>';
///////// \$iaUploadFile->filename_sanitize(null /* == */); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_filename_sanitize'><b>\$iaUploadFile->filename_sanitize(<span class="type"></span> \$fileName) <span>: </span></b>
FUNCTIONDEF;
echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Lib\iaUploadFile", "filename_sanitize")."</pre>";
echo "<ol class='usage'>";
/// display ///
echo <<< DOCUMENT_EXAMPLE
<li>\$iaUploadFile->filename_sanitize(null /* == */);
-> </b><br><pre>
DOCUMENT_EXAMPLE;
/// run ///
print_r(
$iaUploadFile->filename_sanitize(null /* == */)
);
echo "</pre>";
echo '</ol>';
///////// \$iaUploadFile->dirnameNoTrailingSlash(null /* == */); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_dirnameNoTrailingSlash'><b>\$iaUploadFile->dirnameNoTrailingSlash(<span class="type"></span> \$dir) <span>: </span></b>
FUNCTIONDEF;
echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Lib\iaUploadFile", "dirnameNoTrailingSlash")."</pre>";
echo "<ol class='usage'>";
/// display ///
echo <<< DOCUMENT_EXAMPLE
<li>\$iaUploadFile->dirnameNoTrailingSlash(null /* == */);
-> </b><br><pre>
DOCUMENT_EXAMPLE;
/// run ///
print_r(
$iaUploadFile->dirnameNoTrailingSlash(null /* == */)
);
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\iaUploadFile;
use PHPUnit\Framework\TestCase;
class iaUploadFileTest extends TestCase {
/**
* @dataProvider get_result_Provider
*
*/
public function test_get_result( $expected) {
$iaUploadFile = new iaUploadFile($fsWebroot, $allowOverwrite);
$this->assertEquals($expected, $iaUploadFile->get_result() );
}
function get_result_Provider() {
return [
'test 1' => [ '' ],
];
}
/**
* @dataProvider uploadToDir_Provider
*
*/
public function test_uploadToDir($uploadKeys, $webDir, $fileTypes, $generateUniqueName , $expected) {
$iaUploadFile = new iaUploadFile($fsWebroot, $allowOverwrite);
$this->assertEquals($expected, $iaUploadFile->uploadToDir($uploadKeys, $webDir, $fileTypes, $generateUniqueName) );
}
function uploadToDir_Provider() {
return [
'test 1' => [ '', '', '', '', '' ],
];
}
/**
* @dataProvider filename_sanitize_Provider
*
*/
public function test_filename_sanitize($fileName , $expected) {
$iaUploadFile = new iaUploadFile($fsWebroot, $allowOverwrite);
$this->assertEquals($expected, $iaUploadFile->filename_sanitize($fileName) );
}
function filename_sanitize_Provider() {
return [
'test 1' => [ '', '' ],
];
}
/**
* @dataProvider dirnameNoTrailingSlash_Provider
*
*/
public function test_dirnameNoTrailingSlash($dir , $expected) {
$iaUploadFile = new iaUploadFile($fsWebroot, $allowOverwrite);
$this->assertEquals($expected, $iaUploadFile->dirnameNoTrailingSlash($dir) );
}
function dirnameNoTrailingSlash_Provider() {
return [
'test 1' => [ '', '' ],
];
}
}
ia Doc