PhonegapManager Class Reference

Provides support for managing Phonegap apps. More...

Public Member Functions
	PhonegapManager ()

Static Public Member Functions
static	setDefaults ()
static	detectPhonegap ()
	Detects whether a phonegap / cordova app is being used to access the current page. More...
static	hasPhonegap ()
static	showVersion ()
static	getOS ()
	Retrieve the current client device's OS (assuming it is running in Phonegap / Cordova) More...
static	addScript ($script)
static	registerPhonegapFile ($platform, $version, $file)
static	getPhonegapFile ($platform, $version)
static	registerPhonegapAppScript ($platform, $version, $file)
static	getPhonegapAppScript ($platform, $version)
static	registerPhonegapSupportScript ($s)
static	defaultSupportScripts ()

Static Public Attributes
static	$phonegapFiles = array()
static	$appScripts = array()
static	$supportScripts = array()

Detailed Description

Provides support for managing Phonegap apps.

Author

andy

Definition at line 19 of file phonegap_manager.inc.

Member Function Documentation

addScript()

static PhonegapManager::addScript (   $script )

static

Definition at line 119 of file phonegap_manager.inc.

     {
          global $phonegap;
          global $phonegap_csp;
          
          if (PhonegapManager::hasPhonegap())
          {
               ComponentManager::fireEvent("RegisterPhonegapFiles");
               ComponentManager::fireEvent("RegisterPhonegapAppScripts");
               ComponentManager::fireEvent("RegisterPhonegapSupportScripts");
               
               $os = PhonegapManager::getOS();
               
               //AJG: Do not add phonegap script references if we do not definitively know the OS
               if (!$os) return $script;
               
               trace(print_r(PhonegapManager::$appScripts, true), 3);
               
               $file = PhonegapManager::getPhonegapFile($os, $_SESSION["phonegap_version"]);
               $app  = PhonegapManager::getPhonegapAppScript($os, $_SESSION["phonegap_version"]);
               
               if ($app)
               {
                    $phonegap = "<script type='text/javascript' src='{$app}'></script>\n".$phonegap;
               }
 
               if (Settings::getValue("phonegap", "use_local_phonegap_files"))
               {
                    $phonegap_csp = "gap: cdvfile:";
                    $phonegap = "<script type='text/javascript' src='cdvfile://localhost/bundle/www/cordova.js'></script>".$phonegap;
               }
               else
               {
                    $phonegap_csp = "gap:";
                    $phonegap = "<script type='text/javascript' src='{$file}'></script>\n".$phonegap;
               }         
               foreach(PhonegapManager::$supportScripts as $supportScript => $dummy)
               {
                    $phonegap .= "<script type='text/javascript' src='{$supportScript}'></script>\n";
               }
          }
          else
          {
               $phonegap = "";
          }
          
          return $script;
     }

defaultSupportScripts()

static PhonegapManager::defaultSupportScripts ( )

static

Definition at line 221 of file phonegap_manager.inc.

     {
          PhonegapManager::registerPhonegapSupportScript("/components/phonegap/js/photo_uploader.js");
          PhonegapManager::registerPhonegapSupportScript("/components/phonegap/js/photo_attachment_uploader.js");  
     }

detectPhonegap()

static PhonegapManager::detectPhonegap ( )

static

Detects whether a phonegap / cordova app is being used to access the current page.

Definition at line 42 of file phonegap_manager.inc.

     {
          global $script;
          
          trace("Detecting PhoneGap", 4);
          
          if ($_SESSION["phonegap"]) 
          {
               if ($_SESSION["phonegap_os"] != "" && $_SESSION["phonegap_version"] != "") 
               {
                    return;
               }
               else
               {
                    trace("Phonegap flag without OS or version detected in session for {$_SERVER["REMOTE_ADDR"]} - resetting", 2);
                    $_SESSION["phonegap"] = false;
               }
          }
          
          $matches = array();
          if (preg_match("/PhoneGap\\/Cordova (\\w+) (\\d+\\.\\d+\\.\\d+)/i", $_SERVER['HTTP_USER_AGENT'], $matches))
          {
               $_SESSION["phonegap"] = true; 
               $_SESSION["phonegap_os"] = $matches[1];
               $_SESSION["phonegap_version"] = $matches[2];
 
               trace("PhoneGap {$_SESSION["phonegap_version"]} for {$_SESSION["phonegap_os"]} enabled for {$_SERVER["REMOTE_ADDR"]} via User Agent", 2);
          }
          else if ($_POST["phonegap"] && $_POST["phonegap_version"] != "" && $_POST["phonegap_os"] != "")
          {
               $_SESSION["phonegap"] = true;
               $_SESSION["phonegap_version"] = $_POST["phonegap_version"];
               $_SESSION["phonegap_os"] = $_POST["phonegap_os"];
               
               trace("PhoneGap {$_SESSION["phonegap_version"]} for {$_SESSION["phonegap_os"]} enabled for {$_SERVER["REMOTE_ADDR"]} via POST", 2);
          }    
          else if (Settings::getValue("phonegap", "enable_phonegap_debugging") && $_GET["phonegap"])
          {
               $_SESSION["phonegap"] = true;
               $_SESSION["phonegap_version"] = Settings::getValue("phonegap", "phonegap_debug_version");
               $_SESSION["phonegap_os"] = Settings::getValue("phonegap", "phonegap_debug_os");
               
               trace("PhoneGap {$_SESSION["phonegap_version"]} for {$_SESSION["phonegap_os"]} enabled for {$_SERVER["REMOTE_ADDR"]} in debugging mode", 2);
          }
          
          if ($_SESSION["phonegap_os"] == "droid") $_SESSION["phonegap_os"] = "android";
     }

getOS()

static PhonegapManager::getOS ( )

static

Retrieve the current client device's OS (assuming it is running in Phonegap / Cordova)

Returns

string the device OS

Definition at line 112 of file phonegap_manager.inc.

     {
          $os = $_SESSION["phonegap_os"];
          if ($os == "droid") $os = "android";
          return $os;
     }

getPhonegapAppScript()

static PhonegapManager::getPhonegapAppScript (   $platform,   $version  )

static

Definition at line 194 of file phonegap_manager.inc.

     {
          $key = "{$platform}-{$version}";
          if (array_key_exists($key, PhonegapManager::$appScripts))
          {
               return PhonegapManager::$appScripts[$key];
          }
          
          $key = "*-{$version}";
          if (array_key_exists($key, PhonegapManager::$appScripts))
          {
               return PhonegapManager::$appScripts[$key];
          }
          
          if (array_key_exists("*-*", PhonegapManager::$appScripts))
          {
               return PhonegapManager::$appScripts["*-*"];
          }
          
          return "";
     }

getPhonegapFile()

static PhonegapManager::getPhonegapFile (   $platform,   $version  )

static

Definition at line 175 of file phonegap_manager.inc.

     {
          $key = "{$platform}-{$version}";
          if (array_key_exists($key, PhonegapManager::$phonegapFiles))
          {
               // Send the registered configured file for the platform and version
               return PhonegapManager::$phonegapFiles[$key];
          }
          
          // Send default file with no plugins
          return "/components/phonegap/js/{$platform}/cordova-{$version}.js";
     }

hasPhonegap()

static PhonegapManager::hasPhonegap ( )

static

Definition at line 90 of file phonegap_manager.inc.

     {
          if (!Settings::getValue("phonegap", "enable_phonegap")) return false;
          return (isset($_SESSION["phonegap"]) && $_SESSION["phonegap"] == true) || stripos($_SERVER['HTTP_USER_AGENT'], "PhoneGap/Cordova") !== false;
     }    

PhonegapManager()

PhonegapManager::PhonegapManager

(

)

Definition at line 25 of file phonegap_manager.inc.

     {
 
     }

registerPhonegapAppScript()

static PhonegapManager::registerPhonegapAppScript (   $platform,   $version,   $file  )

static

Definition at line 188 of file phonegap_manager.inc.

     {
          trace("Registering Phonegap App Script for $platform $version: $file", 3);
          PhonegapManager::$appScripts["{$platform}-{$version}"] = $file;
     }

registerPhonegapFile()

static PhonegapManager::registerPhonegapFile (   $platform,   $version,   $file  )

static

Definition at line 168 of file phonegap_manager.inc.

     {
          trace("Registering Phonegap file for $platform $version: $file", 3);
          
          PhonegapManager::$phonegapFiles["{$platform}-{$version}"] = $file;
     }

registerPhonegapSupportScript()

static PhonegapManager::registerPhonegapSupportScript (   $s )

static

Definition at line 216 of file phonegap_manager.inc.

     {
          PhonegapManager::$supportScripts[$s] = $s;
     }

setDefaults()

static PhonegapManager::setDefaults ( )

static

Definition at line 30 of file phonegap_manager.inc.

     {
          Settings::setDefaultValue("phonegap", "enable_phonegap", true, Boolean, "Enables support for Phonegap/Cordova applications");
          Settings::setDefaultValue("phonegap", "enable_phonegap_debugging", false, Boolean, "Enables PhoneGap debugging mode - append phonegap=1 to any URL in your desktop browser to turn on PhoneGap mode");       
          Settings::setDefaultValue("phonegap", "phonegap_debug_version", "2.4.0", String, "The version of Phonegap that is assumed in debugging mode");
          Settings::setDefaultValue("phonegap", "phonegap_debug_os", "android", String, "The OS of Phonegap that is assumed in debugging mode");
          Settings::setDefaultValue("phonegap", "use_local_phonegap_files", false, Boolean, "Check this box to pull the local cordova files in the packaged app, instead of pulling them from the server (EXPERIMENTAL)");
     }

showVersion()

static PhonegapManager::showVersion ( )

static

Definition at line 96 of file phonegap_manager.inc.

     {
          if ($_SESSION["phonegap"])
          {
               echo "<p>Using Phonegap version ".$_SESSION["phonegap_version"]." on ".$_SESSION["phonegap_os"]."</p>";
          }
          else
          {
               echo "<p>Not using Phonegap</p>";
          }
     }

Member Data Documentation

$appScripts

PhonegapManager::$appScripts = array()

static

Definition at line 22 of file phonegap_manager.inc.

$phonegapFiles

PhonegapManager::$phonegapFiles = array()

static

Definition at line 21 of file phonegap_manager.inc.

$supportScripts

PhonegapManager::$supportScripts = array()

static

Definition at line 23 of file phonegap_manager.inc.

---

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

• C:/code/cms.sonjara.com/cms/components/phonegap/phonegap_manager.inc