\WHSales

Customizable warehouse items sales report

Synopsis

class WHSales {

• // constants
• const TABLE_SUBREPORTS = 'wh_salesreports';
• const TABLE_REPORT_ITEMS = 'wh_salesitems';
• const RIGHT_EDIT = 'WAREHOUSEDIR';
• const URL_ME = '?module=whsales';
• const ROUTE_REPORT_RENDER = 'viewreport';
• const ROUTE_REPORT_EDIT = 'editreportid';
• const ROUTE_REPORT_DEL = 'deletereportid';
• const ROUTE_ITEM_DEL = 'deletereportitemid';
• const PROUTE_NEWREPORT = 'newreportname';
• const PROUTE_EDITREPORTNAME = 'editreportname';
• const PROUTE_NEWREPORTITEM = 'addnewitemtoreportid';
• const PROUTE_NEWREPORTITEMID = 'addthisitemtoreport';
• const PROUTE_YEAR = 'settargetyear';
• // members
• protected  $warehouse = '';
• protected  $messages = '';
• protected  $reportsDb = '';
• protected  $reportItemsDb = '';
• protected array $allItemTypes = ;
• protected array $allItemTypeNames = ;
• protected array $allItemCategories = ;
• protected array $allReports = ;
• protected array $allReportNames = ;
• protected string $showYear = '';
• // methods
• public void __construct()
• protected void initWarehouse()
• protected void initMessages()
• protected void initReportsDb()
• protected void setYear()
• protected void initReportsItemsDb()
• protected void loadItemTypes()
• protected void loadReports()
• public string renderReportsList()
• public void/string createReport()
• public void/string renameReport()
• public void/error deleteReport()
• public string renderCreationForm()
• protected string renderItemTypeAddForm()
• protected string getItemName()
• public void deleteReportItem()
• public void/string addReportItem()
• protected string renderRenameForm()
• public string renderEditForm()
• public string getReportName()
• protected array filterOutcomes()
• protected string renderYearSelector()
• protected array getItemTypeStat()
• protected string renderChartCount()
• protected string renderChartProfit()
• public string renderReport()
}


Constants

Name	Value
TABLE_SUBREPORTS	'wh_salesreports'
TABLE_REPORT_ITEMS	'wh_salesitems'
RIGHT_EDIT	'WAREHOUSEDIR'
URL_ME	'?module=whsales'
ROUTE_REPORT_RENDER	'viewreport'
ROUTE_REPORT_EDIT	'editreportid'
ROUTE_REPORT_DEL	'deletereportid'
ROUTE_ITEM_DEL	'deletereportitemid'
PROUTE_NEWREPORT	'newreportname'
PROUTE_EDITREPORTNAME	'editreportname'
PROUTE_NEWREPORTITEM	'addnewitemtoreportid'
PROUTE_NEWREPORTITEMID	'addthisitemtoreport'
PROUTE_YEAR	'settargetyear'

Members

protected

• $allItemCategories — array
  Contains all item types categories as itemtypeId=>categoryName
• $allItemTypeNames — array
  Contains all available item type names as id=>itemTypeName
• $allItemTypes — array
  Contains all available warehouse item types as id=>itemtypeData
• $allReportNames — array
  Contains all available sales sub-reports names as id=>name
• $allReports — array
  Contains all available sales sub-reports as id=>reportItemTypes[itemTypeId]=>recordId
• $messages —
  System messages helper instance placeholder
• $reportItemsDb —
  Sub-reports itemtypes abstraction layer
• $reportsDb —
  Sub-reports database abstraction layer
• $showYear — int
  Contains year to render data
• $warehouse —
  Warehouse instance placeholder

Methods

protected

• filterOutcomes() — Removes from outcomes non rendered years, move operations, not report itemtypes, etc
• getItemName() — Returns item type name by its ID if it exists
• getItemTypeStat() — Returns selling stats by some itemTypeID from outcomes array
• initMessages() — Inits message helper
• initReportsDb() — Inits sub-reports database layer
• initReportsItemsDb() — Inits sub-reports database layer
• initWarehouse() — Inits warehouse instance for further usage
• loadItemTypes() — Loads all existing itemtypes and categories from warehouse
• loadReports() — Loads all existing reports
• renderChartCount() — Render sold items year chart
• renderChartProfit() — Render sold items year profit chart
• renderItemTypeAddForm() — Renders form for addition some new item type to existing report
• renderRenameForm() — Renders report rename form
• renderYearSelector() — Renders year selector form
• setYear() — Sets current instance target year

public

• __construct()
• addReportItem() — Appends some itemtype record to existing report
• createReport() — Creates new sales sub-report in database
• deleteReport() — Deletes existing report from database
• deleteReportItem() — Deletes some itemtype record ID from database
• getReportName() — Returns existing report name by its ID
• renameReport() — Renames sales sub-report in database
• renderCreationForm() — Renders new report creation form
• renderEditForm() — Renders existing report editing form
• renderReport() — Renders existing sales report
• renderReportsList() — Renders available sub-reports list with some controls