/iaLib/ia_examples/ia/Math/StatsTotalIt_example.php

<?php

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

/iaLib/ia_examples/code/ia/Math/StatsTotalIt_example_code.php

use ia\Math\StatsTotalIt;
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>
/**
     *
     * @param array \$consolidateByKeys ['totalsBy_1','subtotalsBy_2',...]
     * @param array \$valuesKeyedBy Keys for values to generate totals & subtotals ['value_1',...]
     * @param integer \$decimals 2
     * @param integer \$exceptions How to manage missing, null, N/A & not numeric. ia\Math\Stats::MISSING_ ia\Math\Stats::NA_ default Asume set to 0.00
     * @return void
     */
/*
 \$statsTotalIt = new StatsTotalIt(<span class="type">array</span> \$consolidateByKeys, <span class="type">array</span> \$valuesKeyedBy, <span class="type">integer</span> \$decimals <span class="default">= 2</span>, <span class="type">integer</span> \$exceptions <span class="default">= 8</span>);
*/

\$statsTotalIt = new StatsTotalIt(['a' => '1', 'b' => '2', 'c' => 3], ['a' => '1', 'b' => '2', 'c' => 3]);

</pre>
CONSTRUCTOR_PROTOTYPE;

$statsTotalIt = new StatsTotalIt(['a' => '1', 'b' => '2', 'c' => 3], ['a' => '1', 'b' => '2', 'c' => 3]);


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



///////// \$statsTotalIt->arrayAdd(['a' => '1', 'b' => '2', 'c' => 3]); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_arrayAdd'><b>\$statsTotalIt->arrayAdd(<span class="type">array</span> \$arrayOfDataPoints) <span>: void</span></b>
FUNCTIONDEF;

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

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



    /// display ///
    echo <<< DOCUMENT_EXAMPLE
        <li>\$statsTotalIt->arrayAdd(['a' => '1', 'b' => '2', 'c' => 3]);"
DOCUMENT_EXAMPLE;
    /// run ///
         echo $statsTotalIt->arrayAdd(['a' => '1', 'b' => '2', 'c' => 3]);


	echo '</ol>';


///////// \$statsTotalIt->dataAdd(['a' => '1', 'b' => '2', 'c' => 3]); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_dataAdd'><b>\$statsTotalIt->dataAdd(<span class="type">array</span> \$dataPoint) <span>: void</span></b>
FUNCTIONDEF;

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

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



    /// display ///
    echo <<< DOCUMENT_EXAMPLE
        <li>\$statsTotalIt->dataAdd(['a' => '1', 'b' => '2', 'c' => 3]);"
DOCUMENT_EXAMPLE;
    /// run ///
         echo $statsTotalIt->dataAdd(['a' => '1', 'b' => '2', 'c' => 3]);


	echo '</ol>';


///////// \$statsTotalIt->get_stat(); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_get_stat'><b>\$statsTotalIt->get_stat(<span class="type">string</span> \$statName <span class="default">= 'sum'</span>) <span>: array</span></b>
FUNCTIONDEF;

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

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



    /// display ///
    echo <<< DOCUMENT_EXAMPLE
        <li>\$statsTotalIt->get_stat();
        -&gt;&nbsp; </b><br><pre>
DOCUMENT_EXAMPLE;
    /// run ///
        print_r(
        $statsTotalIt->get_stat()
        );
        echo "</pre>";


	echo '</ol>';


///////// \$statsTotalIt->get_statHeirarchy(); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_get_statHeirarchy'><b>\$statsTotalIt->get_statHeirarchy(<span class="type">string</span> \$statName <span class="default">= 'sum'</span>) <span>: array</span></b>
FUNCTIONDEF;

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

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



    /// display ///
    echo <<< DOCUMENT_EXAMPLE
        <li>\$statsTotalIt->get_statHeirarchy();
        -&gt;&nbsp; </b><br><pre>
DOCUMENT_EXAMPLE;
    /// run ///
        print_r(
        $statsTotalIt->get_statHeirarchy()
        );
        echo "</pre>";


	echo '</ol>';


///////// \$statsTotalIt->get_basicStats(); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_get_basicStats'><b>\$statsTotalIt->get_basicStats() <span>: array</span></b>
FUNCTIONDEF;

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

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



    /// display ///
    echo <<< DOCUMENT_EXAMPLE
        <li>\$statsTotalIt->get_basicStats();
        -&gt;&nbsp; </b><br><pre>
DOCUMENT_EXAMPLE;
    /// run ///
        print_r(
        $statsTotalIt->get_basicStats()
        );
        echo "</pre>";


	echo '</ol>';


///////// \$statsTotalIt->get_basicStatsFlat(); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_get_basicStatsFlat'><b>\$statsTotalIt->get_basicStatsFlat() <span>: array</span></b>
FUNCTIONDEF;

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

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



    /// display ///
    echo <<< DOCUMENT_EXAMPLE
        <li>\$statsTotalIt->get_basicStatsFlat();
        -&gt;&nbsp; </b><br><pre>
DOCUMENT_EXAMPLE;
    /// run ///
        print_r(
        $statsTotalIt->get_basicStatsFlat()
        );
        echo "</pre>";


	echo '</ol>';


///////// \$statsTotalIt->get_basicStatsHeirarchy(); //////////////////////////////////////////////////
echo <<< FUNCTIONDEF
<li id='u_get_basicStatsHeirarchy'><b>\$statsTotalIt->get_basicStatsHeirarchy() <span>: array</span></b>
FUNCTIONDEF;

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

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



    /// display ///
    echo <<< DOCUMENT_EXAMPLE
        <li>\$statsTotalIt->get_basicStatsHeirarchy();
        -&gt;&nbsp; </b><br><pre>
DOCUMENT_EXAMPLE;
    /// run ///
        print_r(
        $statsTotalIt->get_basicStatsHeirarchy()
        );
        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\Math\StatsTotalIt;
use PHPUnit\Framework\TestCase;

class StatsTotalItTest extends TestCase {



    /**
     * @dataProvider arrayAdd_Provider
     *
     */
    public function test_arrayAdd($arrayOfDataPoints , $expected) {
        $statsTotalIt = new StatsTotalIt($consolidateByKeys, $valuesKeyedBy, $decimals, $exceptions);
        $this->assertEquals($expected, $statsTotalIt->arrayAdd($arrayOfDataPoints) );
    }

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



    /**
     * @dataProvider dataAdd_Provider
     *
     */
    public function test_dataAdd($dataPoint , $expected) {
        $statsTotalIt = new StatsTotalIt($consolidateByKeys, $valuesKeyedBy, $decimals, $exceptions);
        $this->assertEquals($expected, $statsTotalIt->dataAdd($dataPoint) );
    }

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



    /**
     * @dataProvider get_stat_Provider
     *
     */
    public function test_get_stat($statName , $expected) {
        $statsTotalIt = new StatsTotalIt($consolidateByKeys, $valuesKeyedBy, $decimals, $exceptions);
        $this->assertEquals($expected, $statsTotalIt->get_stat($statName) );
    }

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



    /**
     * @dataProvider get_statHeirarchy_Provider
     *
     */
    public function test_get_statHeirarchy($statName , $expected) {
        $statsTotalIt = new StatsTotalIt($consolidateByKeys, $valuesKeyedBy, $decimals, $exceptions);
        $this->assertEquals($expected, $statsTotalIt->get_statHeirarchy($statName) );
    }

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



    /**
     * @dataProvider get_basicStats_Provider
     *
     */
    public function test_get_basicStats(  $expected) {
        $statsTotalIt = new StatsTotalIt($consolidateByKeys, $valuesKeyedBy, $decimals, $exceptions);
        $this->assertEquals($expected, $statsTotalIt->get_basicStats() );
    }

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



    /**
     * @dataProvider get_basicStatsFlat_Provider
     *
     */
    public function test_get_basicStatsFlat(  $expected) {
        $statsTotalIt = new StatsTotalIt($consolidateByKeys, $valuesKeyedBy, $decimals, $exceptions);
        $this->assertEquals($expected, $statsTotalIt->get_basicStatsFlat() );
    }

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



    /**
     * @dataProvider get_basicStatsHeirarchy_Provider
     *
     */
    public function test_get_basicStatsHeirarchy(  $expected) {
        $statsTotalIt = new StatsTotalIt($consolidateByKeys, $valuesKeyedBy, $decimals, $exceptions);
        $this->assertEquals($expected, $statsTotalIt->get_basicStatsHeirarchy() );
    }

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