#65 adding analytics to number types

Author: creecros

Diff for: Analytics/CustomFieldAnalytics.php

@@ -0,0 +1,57 @@
+<?php
+
+namespace Kanboard\Plugin\MetaMagik\Analytics;
+
+use Kanboard\Core\Base;
+use Kanboard\Model\TaskMetadataModel;
+use Kanboard\Model\TaskFinderModel;
+use Kanboard\Plugin\MetaMagik\Model\MetadataTypeModel;
+
+/**
+ * Custom Field Numeric Total Analytic Distribution
+ *
+ * @package  MetaMagik
+ * @author   Craig Crosby
+ */
+class CustomFieldAnalytics extends Base
+{
+
+    public function build($project_id)
+    {
+        $metrics = array();
+        $total = 0;
+        $fields = $this->metadataTypeModel->getAllInScope($project_id);
+        $tasks = $this->taskFinderModel->getAll($project_id);
+
+        foreach ($fields as $field) {
+            
+        $field_total = 0;
+            
+            foreach ($tasks as $task) {
+                if (!empty($this->taskMetadataModel->get($task['id'], $field['human_name'], '')) && $field['data_type'] === 'number' ) {
+                    $field_total += $this->taskMetadataModel->get($task['id'], $field['human_name'], '');
+                    $total += $this->taskMetadataModel->get($task['id'], $field['human_name'], '');
+                }
+
+            }
+            
+            if ($field_total !== 0) {
+                $metrics[] = array(
+                    'column_title' => $field['human_name'],
+                    'nb_tasks' => $field_total,
+                );
+            }
+            
+        }
+
+        if ($total === 0) {
+            return array();
+        }
+
+        foreach ($metrics as &$metric) {
+            $metric['percentage'] = round(($metric['nb_tasks'] * 100) / $total, 2);
+        }
+
+        return $metrics;
+    }
+}

Diff for: Controller/AnalyticExtensionController.php

@@ -0,0 +1,34 @@
+<?php
+
+namespace Kanboard\Plugin\MetaMagik\Controller;
+
+use Kanboard\Filter\TaskProjectFilter;
+use Kanboard\Model\TaskModel;
+use Kanboard\Plugin\MetaMagik\Analytics\CustomFieldAnalytics;
+use Kanboard\Controller\BaseController;
+
+/**
+ * Project Analytic Controller
+ *
+ * @package  Kanboard\Controller
+ * @author   Frederic Guillot
+ */
+class AnalyticExtensionController extends BaseController
+{
+    /**
+     * Show tasks distribution graph
+     *
+     * @access public
+     */
+    public function fieldTotalDistribution()
+    {
+        
+        $project = $this->getProject();
+        
+        $this->response->html($this->helper->layout->analytic('metaMagik:analytic/custom_field_totals', array(
+            'project' => $project,
+            'metrics' => $this->customFieldAnalytics->build($project['id']),
+            'title' => t('Custom Field Total distribution'),
+        )));
+    }
+}

Diff for: Plugin.php

@@ -11,6 +11,7 @@
 use Kanboard\Plugin\MetaMagik\Model\NewTaskCreationModel;
 use Kanboard\Plugin\MetaMagik\Model\NewTaskDuplicationModel;
 use Kanboard\Plugin\MetaMagik\Model\NewTaskProjectDuplicationModel;
+use Kanboard\Plugin\MetaMagik\Analytics\CustomFieldAnalytics;
 use Kanboard\Plugin\MetaMagik\Validator\NewTaskValidator;
 use Kanboard\Plugin\MetaMagik\Filter\MetaFieldFilter;
 use Kanboard\Plugin\MetaMagik\Filter\MetaValueFilter;
@@ -56,6 +57,9 @@ public function initialize()
         $this->template->hook->attach('template:task:form:second-column', 'metaMagik:task/rendermeta2');
         $this->template->hook->attach('template:task:form:third-column', 'metaMagik:task/rendermeta3');
         $this->template->hook->attach('template:task:details:bottom', 'metaMagik:task/metasummary');
+        $this->template->hook->attach('template:analytic:sidebar', 'metaMagik:analytic/layout_hook');
+        
+        
 
         $this->template->setTemplateOverride('export/tasks', 'metaMagik:export/tasks');
 
@@ -106,6 +110,9 @@ public function getClasses()
             'Plugin\MetaMagik\Export' => [
                 'MetaTaskExport',
             ],
+            'Plugin\MetaMagik\Analytics' => [
+                'CustomFieldAnalytics',
+            ],
         ];
     }
 

Diff for: Template/analytic/custom_field_totals.php

@@ -0,0 +1,34 @@
+<?php if (! $is_ajax): ?>
+    <div class="page-header">
+        <h2><?= t('Custom Field Total distribution') ?></h2>
+    </div>
+<?php endif ?>
+
+<?php if (empty($metrics)): ?>
+    <p class="alert"><?= t('Not enough data to show the graph.') ?></p>
+<?php else: ?>
+    <?= $this->app->component('chart-project-task-distribution', array(
+        'metrics' => $metrics,
+    )) ?>
+
+    <table class="table-striped">
+        <tr>
+            <th><?= t('Custom Field') ?></th>
+            <th><?= t('Total Value') ?></th>
+            <th><?= t('Percentage') ?></th>
+        </tr>
+        <?php foreach ($metrics as $metric): ?>
+        <tr>
+            <td>
+                <?= $this->text->e($metric['column_title']) ?>
+            </td>
+            <td>
+                <?= $metric['nb_tasks'] ?>
+            </td>
+            <td>
+                <?= n($metric['percentage']) ?>%
+            </td>
+        </tr>
+        <?php endforeach ?>
+    </table>
+<?php endif ?>

Diff for: Template/analytic/layout_hook.php

@@ -0,0 +1,3 @@
+        <li <?= $this->app->checkMenuSelection('AnalyticExtensionController', 'fieldTotalDistribution', 'metaMagik') ?>>
+            <?= $this->modal->replaceLink(t('Custom field total distribution'), 'AnalyticExtensionController', 'fieldTotalDistribution', array('plugin' => 'metaMagik', 'project_id' => $project['id'])) ?>
+        </li>