Feature/refactor totals by DarkSide666 · Pull Request #286 · atk4/ui

DarkSide666 · 2017-12-09T17:01:06Z

Total support in Grid is currently quite basic, implementing ability to add up numeric values, define per-column strategies and format the footer.

This PR offers many enhancements:

Ability to add multiple Total lines

Sometimes you would want to define multiple total lines, for instance - SubTotals and Totals. They will be increased simultaneously, but will output in 2 separate lines. They will also have separate strategy.

However SubTotals need ability to be "inserted" multiple times too, which we can implement using hook beforeRow (#277).

$table->addTotals([
   'name'=>'Totals for {$category}',
   'category'=>false,  // will not output and will use colspan
   'amount'=>'sum'
], 'sub');

$last_category = null;
$table->beforeRow(function($row) use ($table) {
    if ($last_category == null) { 
      $last_category = $row['category'];
    } elseif ($last_category != $row['category']) {
      $table->renderTotals('sub', ['category'=>$last_category]);
    }
});

Advanced calculation strategies

Here for the data that contains various dates, we find and display date range in the bottom: "1 Jul - 20 Aug"

$table->addTotals([
  'date'=>[
    'default'=> [null, null],
    'row'=>function($v, $prev) {
        return [min($prev[0], $v), max($prev[1], $v]
    },
    'total'=>function($v) {
        return $v[0]->format('M d').' - '.$v[1]->format('M d');
    },
    'format' => false, // to not use date column formatter
]);

DarkSide666 · 2017-12-09T17:17:00Z

Need to add tests for all different kinds of totals.

romaninsh · 2017-12-10T12:04:04Z

wow relally good PR but do I have to write all the docs myself again ? 👍

DarkSide666 · 2017-12-11T21:47:15Z

Tomorrow I will add one more feature there. I have it now (idea) written down on paper but to sleepy to implement it now :)
Also I will write docs with examples tomorrow.

romaninsh · 2017-12-12T09:07:59Z

something that came to my mind was ability to specify 'name' for the total rows, e.g. addTotals('row2'), then it is safer for you to modify it. Obviously should be optional.

DarkSide666 · 2017-12-12T19:22:30Z

Also it would be better to move all that totals functionality outside Table in separate class Totals.
That's better because:

make Table class simpler
easier to extend just Totals class and make some changes there
Totals class should be added to Table invisibly for user, so user still will call Table->addTotals(...) and that will do $table->totals_plan[] = new Totals(...);

DarkSide666 · 2018-05-14T11:11:53Z

demos/table.php

            return strlen($value) > strlen($total) ? $value : $total;
        },
+        'title'=>function ($total, $model) {
+            return "Shortes is: ".$total;


longest not shortest

DarkSide666 · 2018-05-14T11:21:13Z

docs/table.rst

+    $table->addField('no');
+
+    $table->addHook('beforeRow', function($table)) {
+        $table->model['no'] = @++$t->npk;


what is $t? Probably $table->nkp, right?

DarkSide666 · 2018-05-16T08:25:11Z

docs/table.rst

+`update` can be string. Supported built-ins are:
+
+ - min
+ - inc


inc or incr ?

DarkSide666 · 2018-05-16T08:27:00Z

docs/table.rst

+ - avg
+
+You can use a callable which gives you an option to perform update yourself. Also, make note that `inc`
+will ONLY increment when value of the column it's associated with is not empty. If you need to get


please be more specific what "empty" means here. Is 0 empty? Is empty string empty? Or is it just null. I think that 0 is not empty, but empty string is empty.

DarkSide666 · 2018-05-16T08:28:18Z

docs/table.rst

 reference other fields too. A benefit for using template is that type formatting is done automatically
 for you.

+If `format` set to `null` or omitted then default action will be used which is to display totals only


I didn't understand this sentence.

DarkSide666 · 2018-05-16T08:29:22Z

docs/table.rst

+        // $total is previous value 
+        // $value is value of the column
+        // $model will be loaded to current column
+    }


please add return statement here to make things clearer

romaninsh · 2017-12-10T12:06:40Z

src/Table.php

                        case 'sum':
-                            $this->totals[$key] += $this->model[$key];
+                            // set initial value
+                            $t[$key] = ($t[$key] === null ? 0 : $t[$key]);


looks like you over-engineer here, how about this

$t[$key] = (int)$t[$key] + $this->model[$key];

actually might be tricky because of (int) and (float)

https://stackoverflow.com/a/16606419/204819

ok, how about this:

$t[$key] = $t[$key]===null ? 0 : ($t[$key] + $this->model[$key]);

romaninsh · 2017-12-10T12:13:55Z

src/Table.php

+                // should return new total value (for example, current value + current field value)
+                // NOTE: Keep in mind, that current total value initially will be null !
+                if (is_callable($f)) {
+                    $t[$key] = call_user_func_array($f, [$t[$key], $this->model[$key], $key, $this]);


no change needed, but just note on the existence of http://php.net/manual/en/language.oop5.magic.php#language.oop5.magic.invoke

mvorisek · 2023-04-29T18:46:39Z

I have rebased 56da26e 1:1 and simplified the history as much as possible (by squashing CS fixer for example) into d34d398. The diff shows zero changes.

Then I have reverted the changed file paths (files) on the latest develop and rebased the changes again (now with paths matching the current develop): all original changed: c75b7ae...d34d398

* add ability to add multiple total plans.

* few other fixes

…afterRow hook

mvorisek · 2024-11-23T00:42:23Z

Hi @DarkSide666, in my post above there is a link to view the real diff - what features/fixes are missing and can you rebase them on the latest develop?

DarkSide666 added in progress Refactor labels Dec 9, 2017

DarkSide666 requested a review from romaninsh December 10, 2017 00:06

DarkSide666 added in review and removed in progress labels Dec 10, 2017

DarkSide666 self-assigned this Dec 12, 2017

DarkSide666 added in progress and removed in review labels Dec 13, 2017

romaninsh added this to the Someday Maybe milestone Jan 18, 2018

romaninsh mentioned this pull request Jan 23, 2018

Add documentation for 'Table Totals' #180

Closed

DarkSide666 added the Sponsored 💰 label Apr 21, 2018

DarkSide666 commented May 14, 2018

View reviewed changes

DarkSide666 commented May 16, 2018

View reviewed changes

romaninsh mentioned this pull request Mar 12, 2020

Implement average for table totals #973

Closed

romaninsh requested changes Mar 12, 2020

View reviewed changes

DarkSide666 added enhancement 👍 and removed in progress labels Apr 14, 2020

mvorisek marked this pull request as draft April 29, 2020 13:47

mvorisek closed this May 15, 2020

mvorisek reopened this May 15, 2020

atk4 deleted a comment from codecov bot Dec 8, 2020

mvorisek added the waiting for author label May 12, 2021

mvorisek removed this from the Someday Maybe milestone Apr 24, 2022

mvorisek removed the sponsored 💰 label Apr 29, 2023

mvorisek force-pushed the feature/refactor-totals branch 2 times, most recently from d43f6e4 to d34d398 Compare April 29, 2023 18:45

mvorisek force-pushed the feature/refactor-totals branch from d34d398 to 4f7b418 Compare April 29, 2023 18:57

Merge branch 'develop' into develop_old

7e409cd

mvorisek force-pushed the feature/refactor-totals branch 2 times, most recently from 19f7999 to fe8a82f Compare April 29, 2023 19:29

Merge branch 'develop' into develop_old

2702fc0

mvorisek force-pushed the feature/refactor-totals branch from fe8a82f to bc2c0e5 Compare August 12, 2023 21:02

mvorisek and others added 15 commits August 13, 2023 00:17

REVERT originally changed files - for 4f7b418

fa17deb

FIX REVERT to match new file paths

32d9b7e

few simplifications

94fafb4

* refactor totals

d55a1b4

* add ability to add multiple total plans.

Avoid unused local variables

7a42c2a

totals default value now will be null instead of 0

3f3050b

just some work in progress

5c1cd09

fix merge to match orig PR

653ee6e

paginator is only supported for SQL persistence

cfa3bf8

refactor a lot in table totals

c8eb573

* implement {$_row_count}

ed18ece

* few other fixes

bugfix

a671ea1

misc

98e0f5c

making totals more usable, extended doc, work in progress

fe9214c

Added lots of documentation for table and particularly totals. added …

e53fa7b

…afterRow hook

mvorisek force-pushed the feature/refactor-totals branch from bc2c0e5 to e53fa7b Compare August 12, 2023 23:39

mvorisek removed the Refactor label Nov 23, 2024

Conversation

DarkSide666 commented Dec 9, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Ability to add multiple Total lines

Advanced calculation strategies

Uh oh!

DarkSide666 commented Dec 9, 2017

Uh oh!

romaninsh commented Dec 10, 2017

Uh oh!

DarkSide666 commented Dec 11, 2017

Uh oh!

romaninsh commented Dec 12, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

DarkSide666 commented Dec 12, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mvorisek commented Apr 29, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mvorisek commented Nov 23, 2024

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

3 participants

DarkSide666 commented Dec 9, 2017 •

edited

Loading

romaninsh commented Dec 12, 2017 •

edited

Loading

mvorisek commented Apr 29, 2023 •

edited

Loading