WURFL
[ class tree: WURFL ] [ index: WURFL ] [ all elements ]
Packages:
WURFL
WURFL_Cache
WURFL_Configuration
WURFL_Handlers
WURFL_Handlers_Matcher
WURFL_Logger
WURFL_Reloader
WURFL_Request
WURFL_Request_UserAgentNormalizer
WURFL_Request_UserAgentNormalizer_Generic
WURFL_Request_UserAgentNormalizer_Specific
WURFL_Storage
WURFL_Xml


Files:
Application.php
CapabilityService.php
ClassLoader.php
Constants.php
Context.php
CustomDevice.php
CustomDeviceRepository.php
Device.php
DeviceRepository.php
DeviceRepositoryBuilder.php
FileUtils.php
Matcher.php
UserAgentHandlerChain.php
UserAgentHandlerChainFactory.php
Utils.php
WURFLException.php
WURFLManager.php
WURFLManagerFactory.php
WURFLService.php
WURFLUtils.php

Interfaces:
WURFL_DeviceRepository
WURFL_Handlers_Matcher
WURFL_Storage
Classes:
WURFL_CapabilitiesHolder
WURFL_CapabilityService
WURFL_ClassLoader
WURFL_Constants
WURFL_Context
WURFL_CustomDevice
WURFL_CustomDeviceRepository
WURFL_Device
WURFL_DeviceRepositoryBuilder
WURFL_FileUtils
WURFL_Handlers_Utils
WURFL_UserAgentHandlerChain
WURFL_UserAgentHandlerChainFactory
WURFL_WURFLException
WURFL_WURFLManager
WURFL_WURFLManagerFactory
WURFL_WURFLService
WURFL_WURFLUtils

Class: WURFL_CustomDevice

Source Location: /CustomDevice.php

Class Overview




WURFL Custom Device - this is the core class that is used by developers to access the  properties and capabilities of a mobile device




Author(s):


    
                          





                

        






Methods
























Class Details



[line 44]

WURFL Custom Device - this is the core class that is used by developers to access the  properties and capabilities of a mobile device

Examples:  
  1.  // Create a WURFL Manager and detect device first
    2. 

  2.  $wurflManagerFactory = new WURFL_WURFLManagerFactory($wurflConfig);
    3. 

  3.  $wurflManager = $wurflManagerFactory->create();
    4. 

  4.  $device = $wurflManager->getDeviceForHttpRequest($_SERVER);
    5. 

  5.  
    6. 

  6.  // Example 1: Get display resolution from device
    7. 

  7.  $width = $device->getCapability('resolution_width');
    8. 

  8.  $height = $device->getCapability('resolution_height');
    9. 

  9.  echo "Resolution: $width x $height <br/>";
    10. 

  10.  
    11. 

  11.  // Example 2: Get the WURFL ID of the device
    12. 

  12.  $wurflID = $device->id;
    13. 






Tags:





  

    property-read:  string $id: WURFL Device ID
  

  

    property-read:  string $userAgent: User Agent
  

  

    property-read:  string $fallBack: Fallback Device ID
  

  

    property-read:  bool $actualDeviceRoot: true if device is an actual root device
  










[ Top ]








Class Methods




  

	
	
constructor __construct [line 61]

	

    

    

		WURFL_CustomDevice __construct(
array
$modelDevices, [WURFL_Request_MatchInfo
$matchInfo = null])
    

    


	
		



Tags:





  

    throws:  InvalidArgumentException if $modelDevices is not an array of at least one WURFL_Xml_ModelDevice
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        array  
        $modelDevices  
        Array of WURFL_Xml_ModelDevice objects
      

          

        WURFL_Request_MatchInfo  
        $matchInfo  
        
      

        

    


        
[ Top ]

  

  

	
	
method getActualDeviceRootAncestor [line 138]

	

    

    

		WURFL_Xml_ModelDevice getActualDeviceRootAncestor(
)
    

    


	
		Returns the nearest actual device root in the fall back tree.  If this device is a device root itself,  it is returned.  Some devices have no device roots in their fall back tree, like generic_android, since  no devices above it (itself included) are real devices (actual device roots).





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getAllCapabilities [line 177]

	

    

    

		array getAllCapabilities(
)
    

    


	
		Returns capabilities and their values for the current device





Tags:





  

    return:  Device capabilities array
  

  

    see:  WURFL_Xml_ModelDevice::getCapabilities()
  

  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getCapability [line 114]

	

    

    

		string getCapability(
string
$capabilityName)
    

    


	
		Returns the value of a given capability name  for the current device





Tags:





  

    return:  Capability value
  

  

    see:  WURFL_Xml_ModelDevice::getCapability()
  

  

    throws:  InvalidArgumentException The $capabilityName is is not defined in the loaded WURFL.
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $capabilityName  
        must be a valid capability name
      

        

    


        
[ Top ]

  

  

	
	
method getFallBackDevices [line 159]

	

    

    

		array getFallBackDevices(
)
    

    


	
		Returns an array with all the fall back devices, from the matched device to the root device ('generic')





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getMatchInfo [line 151]

	

    

    

		WURFL_Request_MatchInfo getMatchInfo(
)
    

    


	
		Returns the match info for this device





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method isSpecific [line 96]

	

    

    

		bool isSpecific(
)
    

    


	
		Device is a specific or actual WURFL device as defined by its capabilities





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method __get [line 75]

	

    

    

		string __get(
string
$name)
    

    


	
		Magic Method





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $name  
        
      

        

    


        
[ Top ]

  






        

		    

		    Documentation generated on Fri, 30 Mar 2012 17:16:58 -0400 by phpDocumentor 1.4.4