TeraWurflUtils
[ class tree: TeraWurflUtils ] [ index: TeraWurflUtils ] [ all elements ]
Packages:
TeraWurfl
TeraWurflAdmin
TeraWurflDatabase
TeraWurflRemoteClient
TeraWurflUserAgentMatchers
TeraWurflUtils
TeraWurflXMLParser

Source for file TeraWurflDeviceImage.php

Documentation is available at TeraWurflDeviceImage.php

  1. <?php
  2. /**
  3.  * Tera_WURFL - PHP MySQL driven WURFL
  4.  * 
  5.  * Tera-WURFL was written by Steve Kamerman, and is based on the
  6.  * Java WURFL Evolution package by Luca Passani and WURFL PHP Tools by Andrea Trassati.
  7.  * This version uses a MySQL database to store the entire WURFL file, multiple patch
  8.  * files, and a persistent caching mechanism to provide extreme performance increases.
  9.  * 
  10.  * @package TeraWurfl
  11.  * @author Steve Kamerman <stevekamerman AT gmail.com>
  12.  * @version Stable 2.1.3 $Date: 2010/09/18 15:43:21
  13.  * @license http://www.mozilla.org/MPL/ MPL Vesion 1.1
  14.  */
  15. /**
  16.  * Finds an image for devices detected with Tera-WURFL
  17.  * @package TeraWurflUtils
  18.  * 
  19.  */
  20. class TeraWurflDeviceImage {
  21.     
  22.     protected $baseURL;
  23.     protected $imagesDirectory;
  24.     protected $wurfl;
  25.     protected $deviceID;
  26.     protected $imageExt = '.gif';
  27.     protected $image;
  28.     protected $descend = true;
  29.     
  30.     /**
  31.      * Creates a new TeraWurflDeviceImage
  32.      * @param TeraWurfl The instance of TeraWurfl (or TeraWurflRemoteClient) that detected the device
  33.      * @return void 
  34.      */
  35.     public function __construct(&$wurfl){
  36.         $this->wurfl = $wurfl;
  37.         $this->deviceID = ($this->wurfl->getDeviceCapability('actual_root_device'))? $this->wurfl->getDeviceCapability('actual_root_device'): false;
  38.         $this->baseURL = '';
  39.         $this->imagesDirectory = dirname(__FILE__) . '/device_pix/';
  40.     }
  41.     /**
  42.      * Sets the base URL of the device images
  43.      * Must end with "/".
  44.      * @param string Web-accessible location of the device images  (e.g. "http://domain.com/device_pix/" or "../device_pix/")
  45.      * @return void 
  46.      */
  47.     public function setBaseURL($baseURL){
  48.         $this->baseURL = $baseURL;
  49.     }
  50.     /**
  51.      * Sets the local directoy of the device images on the filesystem
  52.      * @param string Local filesystem directory where the device images are located (e.g. "C:/device_pix/" or "../../device_pix/")
  53.      * @return void 
  54.      */
  55.     public function setImagesDirectory($dir){
  56.         $this->imagesDirectory = $dir;
  57.     }
  58.     /**
  59.      * If you set the BaseURL, returns the path and filename of the device image (http://domain.com/device_pix/apple_iphone_ver1.gif),
  60.      * otherwise returns only the filename (apple_iphone_ver1.gif)
  61.      * @return string Device image filename
  62.      */
  63.     public function getImage(){
  64.         if(is_null($this->image)) $this->setImage();
  65.         return $this->image;
  66.     }
  67.     /**
  68.      * Set to false to prevent the image searching function from looking through the device's parent devices to find
  69.      * a very similar device image if the exact device image is not found.
  70.      * @param bool false prevents using the device image from a different version of the device
  71.      * @return void 
  72.      */
  73.     public function setDescendToFindImage($descend){
  74.         $this->descend = (bool)$descend;
  75.     }
  76.     /**
  77.      * Sets the internal $this->image var with the complete path to the device image
  78.      * @return void 
  79.      */
  80.     protected function setImage(){
  81.         if($this->deviceID === false){
  82.             $this->image = null;
  83.             return;
  84.         }
  85.         if(!file_exists($this->imagesDirectory)){
  86.             $realpath = @realpath($this->imagesDirectory);
  87.             if(!$realpath){
  88.                 if($this->imagesDirectory[0]=='.'){
  89.                     throw new Exception("Error: the local images directory was specified as a relative path ($this->imagesDirectory), but could not be resolved.  Current directory: ".getcwd());
  90.                     exit(1);
  91.                 }else{
  92.                     throw new Exception("Error: the local images directory specified does not exist: ".$this->imagesDirectory);
  93.                     exit(1);
  94.                 }
  95.             }
  96.         }
  97.         if(!$this->imageExists($this->deviceID)){
  98.             if($this->descend){
  99.                 // Check fall back tree for an alternate image, starting at the current device, working back to generic
  100.                 foreach(array_reverse(explode(',',$this->wurfl->capabilities['tera_wurfl']['fall_back_tree'])) as $parentID){
  101.                     if($this->imageExists($parentID)){
  102.                         $this->image = $this->baseURL . $parentID . $this->imageExt;
  103.                         return;
  104.                     }
  105.                 }
  106.             }
  107.             $this->image = null;
  108.             return;
  109.         }
  110.         $this->image = $this->baseURL . $this->deviceID . $this->imageExt;
  111.     }
  112.     /**
  113.      * Check if a device image exists for the given deviceID
  114.      * @param string Device ID (WURFL ID)
  115.      * @return bool Device image exists
  116.      */
  117.     protected function imageExists($deviceID){
  118.         return file_exists(realpath($this->imagesDirectory) . DIRECTORY_SEPARATOR . $deviceID . $this->imageExt);
  119.     }
  120.     public function __toString(){
  121.         return $this->getImage();
  122.     }
  123. }
Documentation generated on Sun, 19 Sep 2010 00:16:02 +0000 by phpDocumentor 1.4.3