modules
Packages
Interfaces
Classes
Files

Class: ModulesDiscoveryService

Source Location: /modules/modules_discovery_service.class.php [line 38]

Class Overview



This class is a ModuleInterface factory providing some services like mass operations (on several modules at the same time) or identifications methods to get all modules that provide a given functionality

		

	    
Author(s):

	    
	




		





    

    
    

        
Methods

        
    

    		











Class Details


This class is a ModuleInterface factory providing some services like mass operations (on several modules at the same time) or identifications methods to get all modules that provide a given functionality
    
Tags:

    

        
    




[ Top ] - [ Class Details ] - [ Methods ] - [ Variables ]



	

	
Class Methods

	
  

    
    
constructor ModulesDiscoveryService [line 43]

    

    

    

        ModulesDiscoveryService ModulesDiscoveryService(
)
    

    

    
        
Builds a new ModuleInterface factory

    
        
[ Top ] - [ Class Details ] - [ Methods ] - [ Variables ]
    

  

  

  

    
    
method functionality [line 68]

    

    

    

        mixed[string] functionality(
string
$functionality, mixed[string]
$modules)
    

    

    
        
Call the method call functionality on each speficied modules
    
Tags:

    

        
  • return: The results of the functionality method on all modules. This array has keys that are the modules ids and the associated value is the return value for this particular module.

    


    
        
Parameters:

    

    

          

        string  
        $functionality  
        The method name to call on ModuleInterfaces
      

          

        mixed[string]  
        $modules  
        The modules arguments in an array which keys are modules ids and values specifics arguments for those modules.
      

        

    

        
[ Top ] - [ Class Details ] - [ Methods ] - [ Variables ]
    

  

  

  

    
    
method get_all_modules [line 92]

    

    

    

        ModuleInterface[] get_all_modules(
)
    

    

    
        
Returns a list with all the modules in it, even with those that have no ModuleInterface. Useful to do generic operations on modules.
    
Tags:

    

        
  • return: the ModuleInterface list.

    


    
        
[ Top ] - [ Class Details ] - [ Methods ] - [ Variables ]
    

  

  

  

    
    
method get_available_modules [line 107]

    

    

    

        ModuleInterface[] get_available_modules(
[string
$functionality = 'none'], [ModuleInterface[]
$modulesList = array()])
    

    

    
        
Returns the ModuleInterface list.
    
Tags:

    

        
  • return: the ModuleInterface list.

    


    
        
Parameters:

    

    

          

        string  
        $functionality  
        the functionality name. By default, returns all availables modules interfaces.
      

          

        ModuleInterface[]  
        $modulesList  
        If specified, only keep modules interfaces having the requested functionality. Else, search in all availables modules interfaces.
      

        

    

        
[ Top ] - [ Class Details ] - [ Methods ] - [ Variables ]
    

  

  

  

    
    
method get_module [line 141]

    

    

    

        ModuleInterface get_module(
[string
$module_id = ''])
    

    

    
        
Returns the ModuleInterface of the module which id is $module_id.
    
Tags:

    

        
  • return: The corresponding ModuleInterface.

    


    
        
Parameters:

    

    

          

        string  
        $module_id  
        The module id.
      

        

    

        
[ Top ] - [ Class Details ] - [ Methods ] - [ Variables ]
    

  

  





    

    
Class Variables

    
                    

                            
                [line 192]  
                mixed 
                $available_modules 
                                                

                                

                                    

                    

        
[ Top ] - [ Class Details ] - [ Methods ] - [ Variables ]
                

                            
                [line 191]  
                mixed 
                $loaded_modules 
                                                

                                

                                    

                    

        
[ Top ] - [ Class Details ] - [ Methods ] - [ Variables ]
    



            		
        

            

    
    
         
    

    
Documentation generated on Tue, 28 Jul 2009 22:43:40 +0200 by phpDocumentor 1.4.1



			

			
	        

				

 

 

Annonces