Browse Sura - warwickfoster/qurantools GitHub Wiki

File: app/admin/verse_search_logs.php

Purpose

The provided PHP code is a web page that displays a table of log entries related to verses and searches. The page allows users to filter and navigate the logs based on various criteria.

Key Features

• Displays a table of log entries, including the date and time, user, referred page, looked up content, and type (verse or search).
• Allows users to filter the logs by user, date range, referred page, and content type.
• Provides pagination for navigating through multiple pages of log entries.
• Can be displayed in two modes: table view and chart view.
• Shows additional information about the user, such as their name and administrator status.

Code Structure

The code is structured as follows:

• Header Includes necessary HTML, CSS, and JavaScript files.
• Body
  • Creates a table of log entries based on the filter criteria.
  • Implements a page navigator for navigating through multiple pages.
  • Provides a chart view option.
• Footer Includes the website footer.

Functions

• print_page_navigator(): Function to generate the page navigator.
• show_value_or_missing(): Function to display the user name or "Missing User" if the name is missing.
• move_back_to_top_button(): Function to adjust the position of the "Back to Top" button.

Variables

• $MODE: Indicates the current view mode (table or chart).
• $filterLogs: Filter criteria for the log entries.
• $CURRENT_PAGE: Current page number.
• $ITEMS_PER_PAGE: Number of items per page.

Usage

• The page can be accessed by a user with appropriate permissions.
• Users can use the filter options to refine the displayed log entries.
• The chart view option allows users to view the log data in a graphical format.

Benefits

• Provides a comprehensive view of verse and search logs.
• Enables users to analyze and filter the data based on their needs.
• Supports multiple view modes for user convenience.