Word Correction Tool - warwickfoster/qurantools GitHub Wiki

File: app/library/admin/customer_statistics.php

Purpose

  • To provide a mechanism for retrieving customer activity and login statistics over different time periods.

CustomerStatistics Class

This PHP class extends the Statistics class and is specifically designed to generate customer statistics.

Key Features

  • Allows users to specify the period type (six months or four weeks) and statistic type (logins, new users, or activity).
  • Provides methods to generate the statistics header, data, and individual customer statistics.
  • Retrieves customer data from the database.

Class Structure

  • Constructor Initializes the period type, statistic type, and entity type.
  • get_statistics() Returns an array containing the statistics header and data.
  • get_statistics_header() Returns an array of column headings for the statistics table.
  • get_statistics_data() Generates an array of data rows for each customer, containing their statistics for each period.
  • get_statistic() Retrieves a specific statistic for a given customer and period.
  • get_customers_as_array() Returns an array of customer data.

Usage

// Create an instance of CustomerStatistics with six months of login statistics
$customer_statistics = new CustomerStatistics(
    Statistics::PERIOD_TYPE_SIX_MONTHS,
    Statistics::STATISTIC_TYPE_LOGINS
);

// Get the statistics as an array
$statistics = $customer_statistics->get_statistics();

// Encode the statistics as JSON
echo json_encode($statistics);

Additional Notes

  • The db_query(), db_rowcount(), and db_return_row() functions are assumed to be defined elsewhere and provide database access.
  • The specific SQL queries used to retrieve the statistics are based on the statistic_type property.
  • The get_period_headers() method is assumed to be implemented in the Statistics class.