/iaLib/ia_examples/ia/DocumentIt/DocumentIt_example.php

<?php

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

/iaLib/ia_examples/code/ia/DocumentIt/DocumentIt_example_code.php

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



///////// DocumentIt::document_class('palabra'); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_document_class'><b>DocumentIt::document_class(<span class="type">string</span> \$className) <span>: string</span></b>
FUNCTIONDEF;

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

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


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

	echo '</ol>';


///////// DocumentIt::parameters(null /* =ReflectionFunction|ReflectionMethod= */, 'palabra'); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_parameters'><b>DocumentIt::parameters(<span class="type">ReflectionFunction|ReflectionMethod</span> \$function, <span class="type">string docBlock for the function or method
</span> \$functionDocBlock) <span>: array</span></b>
FUNCTIONDEF;

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

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



    /// display ///
    echo <<< DOCUMENT_EXAMPLE
        <li>DocumentIt::parameters(null /* =ReflectionFunction|ReflectionMethod= */, 'palabra');
        -&gt;&nbsp; </b><br><pre>
DOCUMENT_EXAMPLE;
    /// run ///
        print_r(
        DocumentIt::parameters(null /* =ReflectionFunction|ReflectionMethod= */, 'palabra')
        );
        echo "</pre>";


	echo '</ol>';


///////// DocumentIt::parametersInfo(null /* =ReflectionFunction|ReflectionMethod= */, 'palabra'); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_parametersInfo'><b>DocumentIt::parametersInfo(<span class="type">ReflectionFunction|ReflectionMethod</span> \$function, <span class="type">string docBlock for the function or method
</span> \$functionDocBlock) <span>: array</span></b>
FUNCTIONDEF;

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

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



    /// display ///
    echo <<< DOCUMENT_EXAMPLE
        <li>DocumentIt::parametersInfo(null /* =ReflectionFunction|ReflectionMethod= */, 'palabra');
        -&gt;&nbsp; </b><br><pre>
DOCUMENT_EXAMPLE;
    /// run ///
        print_r(
        DocumentIt::parametersInfo(null /* =ReflectionFunction|ReflectionMethod= */, 'palabra')
        );
        echo "</pre>";


	echo '</ol>';


///////// DocumentIt::deduceReturnTypeFromDockBlock('palabra'); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_deduceReturnTypeFromDockBlock'><b>DocumentIt::deduceReturnTypeFromDockBlock(<span class="type">string</span> \$functionDocBlock) <span>: string</span></b>
FUNCTIONDEF;

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

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


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

	echo '</ol>';


///////// DocumentIt::changa(null /* == */, null /* == */); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_changa'><b>DocumentIt::changa(<span class="type"></span> \$className, <span class="type"></span> \$fileName) <span>: </span></b>
FUNCTIONDEF;

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

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



    /// display ///
    echo <<< DOCUMENT_EXAMPLE
        <li>DocumentIt::changa(null /* == */, null /* == */);
        -&gt;&nbsp; </b><br><pre>
DOCUMENT_EXAMPLE;
    /// run ///
        print_r(
        DocumentIt::changa(null /* == */, null /* == */)
        );
        echo "</pre>";


	echo '</ol>';


///////// DocumentIt::callsTo(null /* == */); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_callsTo'><b>DocumentIt::callsTo(<span class="type"></span> \$fileName) <span>: </span></b>
FUNCTIONDEF;

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

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



    /// display ///
    echo <<< DOCUMENT_EXAMPLE
        <li>DocumentIt::callsTo(null /* == */);
        -&gt;&nbsp; </b><br><pre>
DOCUMENT_EXAMPLE;
    /// run ///
        print_r(
        DocumentIt::callsTo(null /* == */)
        );
        echo "</pre>";


	echo '</ol>';


///////// DocumentIt::changos(null /* == */); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_changos'><b>DocumentIt::changos(<span class="type"></span> \$classes) <span>: </span></b>
FUNCTIONDEF;

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

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



    /// display ///
    echo <<< DOCUMENT_EXAMPLE
        <li>DocumentIt::changos(null /* == */);
        -&gt;&nbsp; </b><br><pre>
DOCUMENT_EXAMPLE;
    /// run ///
        print_r(
        DocumentIt::changos(null /* == */)
        );
        echo "</pre>";


	echo '</ol>';


///////// DocumentIt::relations(null /* == */); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_relations'><b>DocumentIt::relations(<span class="type"></span> \$classes) <span>: </span></b>
FUNCTIONDEF;

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

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



    /// display ///
    echo <<< DOCUMENT_EXAMPLE
        <li>DocumentIt::relations(null /* == */);
        -&gt;&nbsp; </b><br><pre>
DOCUMENT_EXAMPLE;
    /// run ///
        print_r(
        DocumentIt::relations(null /* == */)
        );
        echo "</pre>";


	echo '</ol>';


///////// DocumentIt::expandKeyToArray(['a' => '1', 'b' => '2', 'c' => 3], 'palabra', 'palabra'); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_expandKeyToArray'><b>DocumentIt::expandKeyToArray(<span class="type">array</span> \$array, <span class="type">string</span> \$separator, <span class="type">string</span> \$baseWebPath) <span>: array</span></b>
FUNCTIONDEF;

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

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



    /// display ///
    echo <<< DOCUMENT_EXAMPLE
        <li>DocumentIt::expandKeyToArray(['a' => '1', 'b' => '2', 'c' => 3], 'palabra', 'palabra');
        -&gt;&nbsp; </b><br><pre>
DOCUMENT_EXAMPLE;
    /// run ///
        print_r(
        DocumentIt::expandKeyToArray(['a' => '1', 'b' => '2', 'c' => 3], 'palabra', 'palabra')
        );
        echo "</pre>";


	echo '</ol>';


///////// DocumentIt::methodDocBlockProtected(null /* == */, null /* == */); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_methodDocBlockProtected'><b>DocumentIt::methodDocBlockProtected(<span class="type"></span> \$className, <span class="type"></span> \$methodName) <span>: </span></b>
FUNCTIONDEF;

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

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



    /// display ///
    echo <<< DOCUMENT_EXAMPLE
        <li>DocumentIt::methodDocBlockProtected(null /* == */, null /* == */);
        -&gt;&nbsp; </b><br><pre>
DOCUMENT_EXAMPLE;
    /// run ///
        print_r(
        DocumentIt::methodDocBlockProtected(null /* == */, 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\DocumentIt\DocumentIt;
use PHPUnit\Framework\TestCase;

class DocumentItTest extends TestCase {



    /**
     * @dataProvider document_class_Provider
     *
     */
    public function test_document_class($className , $expected) {
        
        $this->assertEquals($expected, DocumentIt::document_class($className) );
    }

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



    /**
     * @dataProvider parameters_Provider
     *
     */
    public function test_parameters($function, $functionDocBlock , $expected) {
        
        $this->assertEquals($expected, DocumentIt::parameters($function, $functionDocBlock) );
    }

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



    /**
     * @dataProvider parametersInfo_Provider
     *
     */
    public function test_parametersInfo($function, $functionDocBlock , $expected) {
        
        $this->assertEquals($expected, DocumentIt::parametersInfo($function, $functionDocBlock) );
    }

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



    /**
     * @dataProvider deduceReturnTypeFromDockBlock_Provider
     *
     */
    public function test_deduceReturnTypeFromDockBlock($functionDocBlock , $expected) {
        
        $this->assertEquals($expected, DocumentIt::deduceReturnTypeFromDockBlock($functionDocBlock) );
    }

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



    /**
     * @dataProvider changa_Provider
     *
     */
    public function test_changa($className, $fileName , $expected) {
        
        $this->assertEquals($expected, DocumentIt::changa($className, $fileName) );
    }

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



    /**
     * @dataProvider callsTo_Provider
     *
     */
    public function test_callsTo($fileName , $expected) {
        
        $this->assertEquals($expected, DocumentIt::callsTo($fileName) );
    }

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



    /**
     * @dataProvider changos_Provider
     *
     */
    public function test_changos($classes , $expected) {
        
        $this->assertEquals($expected, DocumentIt::changos($classes) );
    }

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



    /**
     * @dataProvider relations_Provider
     *
     */
    public function test_relations($classes , $expected) {
        
        $this->assertEquals($expected, DocumentIt::relations($classes) );
    }

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



    /**
     * @dataProvider expandKeyToArray_Provider
     *
     */
    public function test_expandKeyToArray($array, $separator, $baseWebPath , $expected) {
        
        $this->assertEquals($expected, DocumentIt::expandKeyToArray($array, $separator, $baseWebPath) );
    }

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



    /**
     * @dataProvider methodDocBlockProtected_Provider
     *
     */
    public function test_methodDocBlockProtected($className, $methodName , $expected) {
        
        $this->assertEquals($expected, DocumentIt::methodDocBlockProtected($className, $methodName) );
    }

        function methodDocBlockProtected_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 ^🔧