Net_Growl
[ class tree: Net_Growl ] [ index: Net_Growl ] [ all elements ]
Packages:
Net_Growl


Classes:
Net_Growl
Net_Growl_Application
Net_Growl_Exception
Net_Growl_Gntp
Net_Growl_GntpMock
Net_Growl_Icon
Net_Growl_Response
Net_Growl_Udp
Files:
Application.php
Autoload.php
Exception.php
Gntp.php
gntpAdapter.php
gntpAdapterIconCollection.php
gntpAdapterSecurity.php
gntpAdapterSocketCallbacks.php
gntpAdapterUrlCallbacks.php
GntpMock.php
Growl.php
Icon.php
japanese-utf8.php
Response.php
Udp.php
udpAdapter.php
udpAdapterNotifyPEARerrors.php

Class: Net_Growl_Application

Source Location: /Net_Growl-2.7.0/Net/Growl/Application.php

Class Overview




Application object for Net_Growl




Author(s):






            
                    

Version:


    
  
  • Release: 2.7.0
    • 









Methods
















Inherited Variables





Inherited Methods














Class Details



[line 73]

Application object for Net_Growl
This object represents an application containing the notifications  to be registered by Growl. Feel free to use  your own application object as long as it implements the few public  getter methods: 
 setter methods 









[ Top ]








Method Detail



	
	
__construct (Constructor)   [line 113]

	

    

    

		void __construct(
[string
$appName = null], [array
$notifications = null], [string
$password = null], [string
$appIcon = null])
    

    


	
		Constructor  Constructs a new application to be registered by Growl








        
Parameters:

    

    

          

        string  
        $appName  
        — 
        (optional) Application name
      

          

        array  
        $notifications  
        — 
        (optional) Array of notifications
      

          

        string  
        $password  
        — 
        (optional) Password to be used to notify Growl
      

          

        string  
        $appIcon  
        — 
        (optional) Application icon
      

        

    


        
[ Top ]

  

  
  
	
	
addGrowlNotifications   [line 147]

	

    

    

		void addGrowlNotifications(
array
$notifications)
    

    


	
		Adds notifications supported by this application
Expected array format is:  
 array('notification name' => array('option name' => 'option value'))
  At the moment, only option name 'enabled' is supported for UDP. Example:  
  1.  $notifications = array('Test Notification' => array('enabled' => true));
    2. 



    

  • Throws: InvalidArgumentException
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        array  
        $notifications  
        — 
        Array of notifications to support
      

        

    


        
[ Top ]

  

  
  
	
	
getGrowlIcon   [line 269]

	

    

    

		string getGrowlIcon(
)
    

    


	
		Returns the application icon for registration in Growl








        
[ Top ]

  

  
  
	
	
getGrowlName   [line 208]

	

    

    

		string getGrowlName(
)
    

    


	
		Returns the application name for registration in Growl








        
[ Top ]

  

  
  
	
	
getGrowlNotifications   [line 180]

	

    

    

		array getGrowlNotifications(
)
    

    


	
		Returns the notifications accepted by Growl for this application
Expected array format is:  
 array('notification name' => array('option name' => 'option value'))
  At the moment, only option name 'enabled' is supported. Example:  
  1.  $notifications = array('Test Notification' => array('enabled' => true));
    2. 

  2.  return $notifications;
    3. 



    

  • Return: notifications
    • 

  • Access: public
    • 








        
[ Top ]

  

  
  
	
	
getGrowlPassword   [line 236]

	

    

    

		string getGrowlPassword(
)
    

    


	
		Returns the password to be used by Growl to accept notification packets








        
[ Top ]

  

  
  
	
	
setGrowlIcon   [line 250]

	

    

    

		void setGrowlIcon(
mixed
$appIcon)
    

    


	
		Sets the application icon for registration in Growl








        
Parameters:

    

    

          

        mixed  
        $appIcon  
        — 
        Application icon
      

        

    


        
[ Top ]

  

  
  
	
	
setGrowlName   [line 194]

	

    

    

		void setGrowlName(
string
$appName)
    

    


	
		Sets the application name for registration in Growl








        
Parameters:

    

    

          

        string  
        $appName  
        — 
        Application name
      

        

    


        
[ Top ]

  

  
  
	
	
setGrowlPassword   [line 222]

	

    

    

		void setGrowlPassword(
string
$password)
    

    


	
		Sets the password to be used by Growl to accept notification packets








        
Parameters:

    

    

          

        string  
        $password  
        — 
        Password to be used to notify Growl
      

        

    


        
[ Top ]

  

  
  



        

		    

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