apidoc
[ class tree: apidoc ] [ index: apidoc ] [ all elements ]
Packages:
Net_SMS


Classes:
Net_SMS
   Net_SMS_Exception
   Net_SMS_Factory

Class: Net_SMS_Factory

Source Location: /Net_SMS-0.2.1/Net/SMS/Factory.php

Class Overview



















Methods
















Inherited Variables





Inherited Methods














Class Details



[line 4]






[ Top ]








Method Detail



	
	
build   [line 18]

	

    

    

		Net_SMS build(
string
$driver, [array
$params = array()])
    

    


	
		Attempts to return a concrete Gateway instance based on $driver.


    

  • Return: The newly created concrete Gateway instance or false on                   an error.
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $driver  
        — 
        The type of concrete Gateway subclass to return.                         This is based on the gateway driver ($driver).                         The code is dynamically included.
      

          

        array  
        $params  
        — 
        A hash containing any additional configuration or                         connection parameters a subclass might need.
      

        

    


        
[ Top ]

  

  
  
	
	
getDefaultSendParams   [line 182]

	

    

    

		array getDefaultSendParams(
string
$gateway)
    

    


	
		Returns send parameters for a gateway from the driver subclass  getDefaultSendParams()function. These are parameters which are available  to the user during sending, such as setting a time for delivery, or type  of SMS (normal text or flash), or source address, etc.


    

  • Return: An array of available send parameters.
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $gateway  
        — 
        The name of the gateway driver for which to return the                 send parameters.
      

        

    


        
[ Top ]

  

  
  
	
	
getDrivers   [line 147]

	

    

    

		array getDrivers(
)
    

    


	
		Returns a list of available gateway drivers.


    

  • Return: An array of available drivers.
    • 

  • Access: public
    • 








        
[ Top ]

  

  
  
	
	
getGatewayInfo   [line 105]

	

    

    

		array getGatewayInfo(

$gateway)
    

    


	
		Returns information on a gateway, such as name and a brief description,  from the driver subclass getInfo() function.


    

  • Return: An array of extra information.
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

          
        $gateway  
        — 
        
      

        

    


        
[ Top ]

  

  
  
	
	
getGatewayParams   [line 128]

	

    

    

		array getGatewayParams(
string
$gateway)
    

    


	
		Returns parameters for a gateway from the driver subclass getParams()  function.


    

  • Return: An array of extra information.
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $gateway  
        — 
        The name of the gateway driver for which to return the                 parameters.
      

        

    


        
[ Top ]

  

  
  



        

		    

		    Documentation generated on Mon, 11 Mar 2019 15:57:15 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright ©  PHP Group 2004.