XDLibsPHP:Home

This article documents features that are still in development.

Information may change rapidly as the event progresses, or if requirements change. The last updates to this article may not reflect the most current information.

---

XcelData PHP Libs

A collection of php classes that make the system work.

API

• MetalPrices - metal-prices/metal-prices.php
  • MetalPrices::GetLatestDataFromDatabase()
  • MetalPrices::GetLatestDataListFromDatabase($limit=10)
  • MetalPrices::GetLatestDeltaFromDatabase()
  • MetalPrices::PullMetalFeedAndAddToDatabase($cacheFile, $debug=false)

• Pawn2MEAPI - xceldata-api.1.0.class.php
  • Pawn2MEAPI::sendAlertSMS($toNumber, $fromNumber, $message)
  • Pawn2MEAPI::sendSystemSMS($toNumber, $message) [could be broken, seems unused]
  • Pawn2MEAPI::DoActivationLinkSMS($USER_PHONE, $COMPANY_ID, $STORE_ID)

• XDAppCache - xceldata-recache-helper.1.0.class.php
  • XDAppCache::DoAll()
  • XDAppCache::WelcomePage($debug=false)
  • XDAppCache::WelcomePageData()

• XDBilling - xceldata-billing-helper.1.0.class.php
  • XDBilling::GetStoreElectronicRatesForMonth($storeID, $PREV_MONTH_DATE)
  • XDBilling::GetStoreElectronicUsageForMonth($storeID, $START_DATE)
  • XDBilling::GenerateBillingForAllCompanies($date=null)
  • XDBilling::CalculateBillingNavigationForDate($date=null)
  • XDBilling::GenerateBillingForCompany($company, $date=null)

• XDCompany - xceldata-company-helper.1.0.class.php
  • XDCompany::GetStores($companyID, $doExpensiveThings=false) [should be deprecated]
  • XDCompany::GetStores2($companyID, $doExpensiveThings=false) [needs to be renamed :/]
  • XDCompany::GetArchivedStores($companyID)
  • XDCompany::GetStoreByID($storeID, $doExpensiveThings=false)
  • XDCompany::GetStoreByKey($storeKey, $doExpensiveThings=false)
  • XDCompany::GetStoreByKeyWithMetalSettings($storeKey)

• XDDBHelper - xceldata-database-helper.1.0.class.php
  • XDDBHelper::FixDate(&$field)
  • XDDBHelper::FixDateToRaw(&$field)
  • XDDBHelper::FuxDate(&$field)
  • XDDBHelper::DateFromRaw(&$field)
  • XDDBHelper::FixDateRaw(&$field)
  • XDDBHelper::FuxDateRaw(&$field)

• XDGBase - xceldata-static-maps.1.0.class.php
  • XDGeocode($address)
    • GetURLParts()
    • GetData()
  • XDStaticMap()
    • setCenter($marker)
    • setSize($width, $height)
    • setScale($scale)
    • addVisible($marker)
    • addMarker($marker)
    • setStyle($style)
    • GetURLParts()

• XDGlobalSettings - xceldata-settings-helper.1.0.class.php
  • XDGlobalSettings::$timeZones
  • XDGlobalSettings::$siteThemes

• XDLang - xceldata-lang-helper.1.0.class.php
  • XDLang::timeago($date, $fixDate = true)

• XDNotes - xceldata-notes-helper.1.0.class.php
  • XDNotes::newNote($objectKey, $message, $userID)
  • XDNotes::getNotesCount($objectKey, $limit=10, $offset=0)
  • XDNotes::getNotesSummary($objectKey)
  • XDNotes::getNotes($objectKey, $limit=10, $offset=0)

• XDTwilio - xceldata-twilio-helper.1.0.class.php
  • XDTwilio::GetRawRates($phoneNumber, $country, $adj=0)
  • XDTwilio::GetRates($adj=0)
  • XDTwilio::GetMessage($messageID)
  • XDTwilio::SyncTwilio($companyID = null)

• XDUser - xceldata-user-helper.1.0.class.php
  • XDUser::CanUserMakePermission($permission)
  • XDUser::MergeSession($newInfo)
  • XDUser::ID()
  • XDUser::Name()
  • XDUser::InternalKey()
  • XDUser::PublicKey()
  • XDUser::Email()
  • XDUser::SMS()
  • XDUser::MarkActiveNow($url)
  • XDUser::Tags()
  • XDUser::HasTag($tag)
  • XDUser::HasRankLevel($rank)
  • XDUser::GetRankLevel($tag)
  • XDUser::UserRankLevel()
  • XDUser::Try_HasTag($tag)

From Composer

• klein/klein ^2.1
• sergeytsalkov/meekrodb *
• pug-php/pug ^2.7
• picqer/php-barcode-generator ^0.2.2
• twilio/sdk ^5.18

3rd Party

• FPDF
  • FPDF_Clipping