org-puremvc-php-multicore
[ class tree: org-puremvc-php-multicore ] [ index: org-puremvc-php-multicore ] [ all elements ]
Packages:
org-puremvc-php-multicore


Interfaces:
ICommand
IController
IFacade
IMediator
IModel
INotification
INotifier
IObserver
IProxy
IView
Classes:
Controller
Facade
MacroCommand
Mediator
Model
Notification
Notifier
Observer
Proxy
SimpleCommand
View
Files:
Controller.php
Facade.php
ICommand.php
IController.php
IFacade.php
IMediator.php
IModel.php
INotification.php
INotifier.php
IObserver.php
IProxy.php
IView.php
MacroCommand.php
Mediator.php
Model.php
Notification.php
Notifier.php
Observer.php
Proxy.php
SimpleCommand.php
View.php

Class: Notification

Source Location: /org/puremvc/php/multicore/patterns/observer/Notification.php

Class Overview




A base INotification implementation.




Author(s):


    
        





    

                

            Implements interfaces:
            

        

        




Variables







Methods
























Class Details



[line 45]

A base INotification implementation.

PureMVC does not rely upon underlying event models such  as the one provided with others like Flash, and PHP does  not have an inherent event model.
The Observer Pattern as implemented within PureMVC exists  to support event-driven communication between the  application and the actors of the MVC triad.
PureMVC Notifications follow a 'Publish/Subscribe'  pattern. PureMVC classes need not be related to each other in a  parent/child relationship in order to communicate with one another  using Notifications.





Tags:





  

    see:  Observer
  










[ Top ]







Class Variables



	
	

	
$body = 

	
[line 64]

  The body of the notification instance





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      mixed
    

      

	



	
[ Top ]


	
	

	
$name = 

	
[line 52]

  Name of the notification instance





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      string
    

      

	



	
[ Top ]


	
	

	
$type = 

	
[line 58]

  The type of the notification instance





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      string
    

      

	



	
[ Top ]










Class Methods




  

	
	
constructor __construct [line 73]

	

    

    

		Notification __construct(
string
$name, [mixed
$body = null], [string
$type = null])
    

    


	
		Constructor.





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $name  
        The name of the notification to send.
      

          

        mixed  
        $body  
        The body of the notification (optional).
      

          

        string  
        $type  
        The type of the notification (optional).
      

        

    


        
[ Top ]

  

  

	
	
method getBody [line 114]

	

    

    

		mixed getBody(
)
    

    


	
		Body getter

Get the body of the Notification instance.





Tags:





  

    return:  The body of the Notification instance.
  

  

    access:  public
  









			

		
Implementation of:

			

			
INotification::getBody()

						
Body getter

					

		
        
[ Top ]

  

  

	
	
method getName [line 89]

	

    

    

		string getName(
)
    

    


	
		Name getter

Get the name of the Notification instance.
No setter, should be set by constructor only





Tags:





  

    return:  Name of the Notification instance.
  

  

    access:  public
  









			

		
Implementation of:

			

			
INotification::getName()

						
Name getter

					

		
        
[ Top ]

  

  

	
	
method getType [line 139]

	

    

    

		string getType(
)
    

    


	
		Type getter

Get the type of the Notification instance.





Tags:





  

    return:  The type of the Notification instance.
  

  

    access:  public
  









			

		
Implementation of:

			

			
INotification::getType()

						
Type getter

					

		
        
[ Top ]

  

  

	
	
method setBody [line 102]

	

    

    

		void setBody(
object
$body)
    

    


	
		Body setter

Set the body of the Notification instance.





Tags:





  

    access:  public
  









			

		
Implementation of:

			

			
INotification::setBody()

						
Body setter

					

		
        
Parameters:

    

    

          

        object  
        $body  
        The body of the Notification instance.
      

        

    


        
[ Top ]

  

  

	
	
method setType [line 127]

	

    

    

		void setType(
string
$type)
    

    


	
		Type setter

Set the type of the Notification instance.





Tags:





  

    access:  public
  









			

		
Implementation of:

			

			
INotification::setType()

						
Type setter

					

		
        
Parameters:

    

    

          

        string  
        $type  
        The type of the Notification instance.
      

        

    


        
[ Top ]

  

  

	
	
method toString [line 151]

	

    

    

		string toString(
)
    

    


	
		String representation

Get the string representation of the INotification instance





Tags:





  

    access:  public
  









			

		
Implementation of:

			

			
INotification::toString()

						
String representation

					

		
        
[ Top ]

  






        

		    

		    Documentation generated on Mon, 03 Aug 2009 04:58:00 +0000 by phpDocumentor 1.4.2