/iaLib/ia_examples/ia/Util/FileIt_example.php

<?php

    $ia_example = [
        'title' => 'ia\Util\FileIt', // fully qualified className
        'summary' => '', // class summary
        'full_example' => '', // full usage example, relative path from ia_examples, blank '' not shown.
        'example_file' => 'code/ia/Util/FileIt_example_code.php', // method by method example, blank '' not shown.
    ];
     include( __DIR__ . '/../../template/ia_example_class.php');

/iaLib/ia_examples/code/ia/Util/FileIt_example_code.php

use ia\Util\FileIt;
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">';



///////// FileIt::jsonFileSave('palabra', ['a' => '1', 'b' => '2', 'c' => 3]); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_jsonFileSave'><b>FileIt::jsonFileSave(<span class="type">string</span> \$fullFileName, <span class="type">array</span> \$array, <span class="type">int</span> \$jsonOptions <span class="default">= 8</span>) <span>: bool</span></b>
FUNCTIONDEF;

echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Util\FileIt", "jsonFileSave")."</pre>";

echo "<ol class='usage'>";



    /// display ///
    echo <<< DOCUMENT_EXAMPLE
        <li>FileIt::jsonFileSave('palabra', ['a' => '1', 'b' => '2', 'c' => 3]); -&gt;&nbsp;
DOCUMENT_EXAMPLE;
    ///run ///
     echo (FileIt::jsonFileSave('palabra', ['a' => '1', 'b' => '2', 'c' => 3]) ? 'true' : 'false');


	echo '</ol>';


///////// FileIt::fileNameSanitize('palabra'); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_fileNameSanitize'><b>FileIt::fileNameSanitize(<span class="type">string</span> \$fileName) <span>: string</span></b>
FUNCTIONDEF;

echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Util\FileIt", "fileNameSanitize")."</pre>";

echo "<ol class='usage'>";


    /// display ///
    echo <<< DOCUMENT_EXAMPLE
        <li>FileIt::fileNameSanitize('palabra'); -&gt;&nbsp;
DOCUMENT_EXAMPLE;
    /// run ///
         echo FileIt::fileNameSanitize('palabra');

	echo '</ol>';


///////// FileIt::fileNameValid('palabra'); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_fileNameValid'><b>FileIt::fileNameValid(<span class="type">string</span> \$fileName) <span>: bool</span></b>
FUNCTIONDEF;

echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Util\FileIt", "fileNameValid")."</pre>";

echo "<ol class='usage'>";



    /// display ///
    echo <<< DOCUMENT_EXAMPLE
        <li>FileIt::fileNameValid('palabra'); -&gt;&nbsp;
DOCUMENT_EXAMPLE;
    ///run ///
     echo (FileIt::fileNameValid('palabra') ? 'true' : 'false');


	echo '</ol>';


///////// FileIt::fileNameValidExtension('palabra', ['a' => '1', 'b' => '2', 'c' => 3]); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_fileNameValidExtension'><b>FileIt::fileNameValidExtension(<span class="type">string</span> \$fileName, <span class="type">array</span> \$allowedExtensions) <span>: bool</span></b>
FUNCTIONDEF;

echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Util\FileIt", "fileNameValidExtension")."</pre>";

echo "<ol class='usage'>";



    /// display ///
    echo <<< DOCUMENT_EXAMPLE
        <li>FileIt::fileNameValidExtension('palabra', ['a' => '1', 'b' => '2', 'c' => 3]); -&gt;&nbsp;
DOCUMENT_EXAMPLE;
    ///run ///
     echo (FileIt::fileNameValidExtension('palabra', ['a' => '1', 'b' => '2', 'c' => 3]) ? 'true' : 'false');


	echo '</ol>';


///////// FileIt::fileExists('palabra'); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_fileExists'><b>FileIt::fileExists(<span class="type">string</span> \$fileNamePath) <span>: bool</span></b>
FUNCTIONDEF;

echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Util\FileIt", "fileExists")."</pre>";

echo "<ol class='usage'>";



    /// display ///
    echo <<< DOCUMENT_EXAMPLE
        <li>FileIt::fileExists('palabra'); -&gt;&nbsp;
DOCUMENT_EXAMPLE;
    ///run ///
     echo (FileIt::fileExists('palabra') ? 'true' : 'false');


	echo '</ol>';


///////// FileIt::fileNameNextVersion('palabra', 'palabra'); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_fileNameNextVersion'><b>FileIt::fileNameNextVersion(<span class="type">string</span> \$dirPath, <span class="type">string</span> \$fileName) <span>: string</span></b>
FUNCTIONDEF;

echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Util\FileIt", "fileNameNextVersion")."</pre>";

echo "<ol class='usage'>";


    /// display ///
    echo <<< DOCUMENT_EXAMPLE
        <li>FileIt::fileNameNextVersion('palabra', 'palabra'); -&gt;&nbsp;
DOCUMENT_EXAMPLE;
    /// run ///
         echo FileIt::fileNameNextVersion('palabra', 'palabra');

	echo '</ol>';


///////// FileIt::directoryPathSlashEnd('palabra'); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_directoryPathSlashEnd'><b>FileIt::directoryPathSlashEnd(<span class="type">string</span> \$dirPath) <span>: string</span></b>
FUNCTIONDEF;

echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Util\FileIt", "directoryPathSlashEnd")."</pre>";

echo "<ol class='usage'>";


    /// display ///
    echo <<< DOCUMENT_EXAMPLE
        <li>FileIt::directoryPathSlashEnd('palabra'); -&gt;&nbsp;
DOCUMENT_EXAMPLE;
    /// run ///
         echo FileIt::directoryPathSlashEnd('palabra');

	echo '</ol>';


///////// FileIt::directoryEnsureExists('palabra'); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_directoryEnsureExists'><b>FileIt::directoryEnsureExists(<span class="type">string</span> \$dirPath, <span class="type">int</span> \$permission <span class="default">= 432</span>) <span>: bool</span></b>
FUNCTIONDEF;

echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("ia\Util\FileIt", "directoryEnsureExists")."</pre>";

echo "<ol class='usage'>";



    /// display ///
    echo <<< DOCUMENT_EXAMPLE
        <li>FileIt::directoryEnsureExists('palabra'); -&gt;&nbsp;
DOCUMENT_EXAMPLE;
    ///run ///
     echo (FileIt::directoryEnsureExists('palabra') ? 'true' : 'false');


	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\FileIt;
use PHPUnit\Framework\TestCase;

class FileItTest extends TestCase {



    /**
     * @dataProvider jsonFileSave_Provider
     *
     */
    public function test_jsonFileSave($fullFileName, $array, $jsonOptions , $expected) {
        
        $this->assertEquals($expected, FileIt::jsonFileSave($fullFileName, $array, $jsonOptions) );
    }

        function jsonFileSave_Provider() {
            return [
                'test 1' => [ '', '', '', '' ],
            ];
        }



    /**
     * @dataProvider fileNameSanitize_Provider
     *
     */
    public function test_fileNameSanitize($fileName , $expected) {
        
        $this->assertEquals($expected, FileIt::fileNameSanitize($fileName) );
    }

        function fileNameSanitize_Provider() {
            return [
                'test 1' => [ '', '' ],
            ];
        }



    /**
     * @dataProvider fileNameValid_Provider
     *
     */
    public function test_fileNameValid($fileName , $expected) {
        
        $this->assertEquals($expected, FileIt::fileNameValid($fileName) );
    }

        function fileNameValid_Provider() {
            return [
                'test 1' => [ '', '' ],
            ];
        }



    /**
     * @dataProvider fileNameValidExtension_Provider
     *
     */
    public function test_fileNameValidExtension($fileName, $allowedExtensions , $expected) {
        
        $this->assertEquals($expected, FileIt::fileNameValidExtension($fileName, $allowedExtensions) );
    }

        function fileNameValidExtension_Provider() {
            return [
                'test 1' => [ '', '', '' ],
            ];
        }



    /**
     * @dataProvider fileExists_Provider
     *
     */
    public function test_fileExists($fileNamePath , $expected) {
        
        $this->assertEquals($expected, FileIt::fileExists($fileNamePath) );
    }

        function fileExists_Provider() {
            return [
                'test 1' => [ '', '' ],
            ];
        }



    /**
     * @dataProvider fileNameNextVersion_Provider
     *
     */
    public function test_fileNameNextVersion($dirPath, $fileName , $expected) {
        
        $this->assertEquals($expected, FileIt::fileNameNextVersion($dirPath, $fileName) );
    }

        function fileNameNextVersion_Provider() {
            return [
                'test 1' => [ '', '', '' ],
            ];
        }



    /**
     * @dataProvider directoryPathSlashEnd_Provider
     *
     */
    public function test_directoryPathSlashEnd($dirPath , $expected) {
        
        $this->assertEquals($expected, FileIt::directoryPathSlashEnd($dirPath) );
    }

        function directoryPathSlashEnd_Provider() {
            return [
                'test 1' => [ '', '' ],
            ];
        }



    /**
     * @dataProvider directoryEnsureExists_Provider
     *
     */
    public function test_directoryEnsureExists($dirPath, $permission , $expected) {
        
        $this->assertEquals($expected, FileIt::directoryEnsureExists($dirPath, $permission) );
    }

        function directoryEnsureExists_Provider() {
            return [
                'test 1' => [ '', '', '' ],
            ];
        }


}

ia Doc

AesCipher ^🔧
iaLibAutoLoader ^🔧
iaSqlite ^🔧
ia
- Data
  - MexicoEstados ^🔧
- Date
- DevTools
  - iaTimer ^🔧
- DocumentIt
  - DocumentIt ^🔧
  - PerfilExample ^🔧
- JqGrid
  - Filter2where ^🔧
  - JqGridRead ^🔧
- Lib
- Math
- Sql
  - Mysql
- Util
- Work
  - WorkDay
  - Workflow
PushId ^🔧
URLify ^🔧
XLSXWriter ^🔧