CORE POS - Fannie
The CORE POS back end
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
FanniePage Class Reference
Inheritance diagram for FanniePage:
FannieRESTfulPage AddCashierPage AddPatronageEntryPage addShelfTag AdvancedBatchEditor AdvancedItemSearch AllocatePatronagePage AnnualMeetingDetailPage AuthBarcodePage AuthChangePassword AuthClassesPage AuthGroupsPage AuthPagePermissions AuthPosePage AuthUsersPage BadScanTool BaseItemAjax BatchFromSearch BatchImportExportPage BatchListPage BatchSignStylesPage CalendarAttendedEventPage CalendarDeletePage CalendarFeed CashierBarGraphs CheckCouponMailing CloneItemPage ConsistencyRulesPage CoopDealsLookupPage CoopDealsMergePage COREPOS\Fannie\API\FannieCRUDPage COREPOS\Fannie\API\FannieReadOnlyPage CpwInvoiceImport CreatePatronageSnapshot CWMemberSummaryReport DashBoard DataImportIndex DateCountPage DeleteItemPage DeleteTenderPage DeleteVendorPage DeliCateringOrdersPage DepartmentDiscrepancyNew DepartmentEditor ECouponReport EditBatchPage EditItemsFromSearch EditManyPurchaseOrders EditOnePurchaseOrder EditShelfTags EditVendorItems EdlpBatchPage EmailReport EndItemSale FannieAuthLoginPage FbeProcessQueuePage GenericBillingPage genLabels GumDefaultRatesPage GumEmailPage GumEquityPayoffPage GumIssueDividendPage GumLoanPayoffPage GumMainPage GumPromissoryPage GumReportIndex GumSchedulePage GumSearchPage GumSettingsPage GumTaxIdPage GumValidTermsPage IgnoredBarcodeEditor InactiveReasonEditor IncompleteItemsPage InvCountPage ItemStatusPage LaneTextStringPage ManualPurchaseOrderPage ManualSignsPage MarginToolFromSearch MemArTransferTool MemberPreferences MemberTypeEditor MemPurchasesPage MetaRules NewSpecialOrdersPage NutriFacts ObfCategoriesPage ObfCategoriesPageV2 ObfIndexPage ObfIndexPageV2 ObfMappingPage ObfQuarterEntryPage ObfWeekEntryPage ObfWeekEntryPageV2 OpenRingReceipts OrderAjax OrderDeptMap OrderDiscountsPage OrderReviewPage OrderViewPage OriginEditor OrphanedItemsPage OverShortMAS PatronageCalcNet PatronageCalcRewards PatronageChecks PatronageGrossPurchases PatronageIndexPage PaymentPlanEditor PIApply PIKillerPage PISignaturePage PluRangePage PriceDiscrepancyPage ProdLocationEditor PurchasingIndexPage PurchasingSearchPage QrTagPage RecalculateVendorSRPs RenameVendorPage RestrictCouponPage ReverseTransPage SaMenuPage SaPriceChangePage ScaleEditor ScheduledEmailTemplatePage ShrinkEditor ShrinkIndex ShrinkReasonEditor ShrinkTool SiteMap SiteSearch SkuMapPage SpecialOrderTags StaffArAccountsPage StaffArDatesPage StatementsPluginBusiness StatementsPluginIndex StatementsPluginPostCards StatementsPluginTerm SyncFromSearch TaxRateEditor TenderEditor TransferPurchaseOrder TsEmployeesEditor UnitBreakdownPage VendorIndexPage VendorMarginsPage VendorPricingBatchPage ViewCashiersPage ViewPurchaseOrders WaybackMachine WfcHtChangeIdPage WfcHtEvalList WfcHtEvalView WicableByDepartment WicUpdatePage

Public Member Functions

 preprocess ()
 
 getHeader ()
 
 addBootstrap ()
 
 addJQuery ()
 
 get_header ()
 
 getFooter ()
 
 get_footer ()
 
 loginRedirect ()
 
 login_redirect ()
 
 checkAuth ()
 
 check_auth ()
 
 helpContent ()
 
 preFlight ()
 
 postFlight ()
 
 setPermissions ($p)
 

Public Attributes

 $themed = true
 

Protected Member Functions

 lineaJS ()
 
 helpModal ()
 

Protected Attributes

 $must_authenticate = false
 
 $current_user = false
 
 $auth_classes = array()
 
 $title = 'Page window title'
 
 $header = 'Page displayed header'
 
 $enable_linea = false
 

Detailed Description

Class for drawing screens

Member Function Documentation

FanniePage::addBootstrap ( )

Add css and js files required for bootstrap. If a version installed via composer is present, that is the version used.

Returns
[boolean] success
FanniePage::addJQuery ( )

Add jquery js file to the page If present, the version installed via composer is used

Returns
[boolean] success
FanniePage::checkAuth ( )

Check if the user is logged in

FanniePage::getFooter ( )

Get the standard footer

Returns
An HTML string
FanniePage::getHeader ( )

Get the standard header

Returns
An HTML string
FanniePage::helpContent ( )

User-facing help text explaining how to use a page.

Returns
[string] html content
FanniePage::helpModal ( )
protected

Helper method to wrap helpContent() in markup for a bootstrap modal dialog.

FanniePage::lineaJS ( )
protected

Enable linea scanner on page

Parameters
selector- jQuery selector for the element where barcode data should be entered
callback[optional] function called after barcode scan

If the callback is omitted, the parent <form> of the selector's element is submitted.

FanniePage::loginRedirect ( )

Send user to login page

FanniePage::preprocess ( )

Global setting overrides default behavior to force the menu to appear.

Member Data Documentation

FanniePage::$auth_classes = array()
protected

list of either auth_class(es) or array(auth_class, start, end) tuple(s)

FanniePage::$current_user = false
protected

name of the logged in user (or False is no one is logged in)

FanniePage::$enable_linea = false
protected

Include javascript necessary to integrate linea scanner device

FanniePage::$must_authenticate = false
protected

force users to login immediately

FanniePage::$themed = true

Page uses newer bootstrap based UI


The documentation for this class was generated from the following files: