package.loader
[ class tree: package.loader ] [ index: package.loader ] [ all elements ]
Packages:
default
common.cache
common.container
common.controller.flow
common.datasource
common.datastructure
common.helper.dsn
common.logger
common.logger.appender
common.logger.layout
common.reader
common.storage
common.validator
Mojavi
mvc.controller
package.loader


Files:
PackageLoader.class.php

Classes:
PackageLoader

Class: PackageLoader

Source Location: /package/loader/PackageLoader.class.php

Class Overview




PackageLoader   loads package.php files by directive, includes their file  content's names, and caches those files in a composite manner.




Author(s):


    
                
  • Tyler Tompkins (ttompkins@mojavi.org)
    • 
      





        






Variables







Methods
























Class Details



[line 19]

PackageLoader   loads package.php files by directive, includes their file  content's names, and caches those files in a composite manner.





Tags:





  

    since:  4.0.0
  

  

    author:  Tyler Tompkins (ttompkins@mojavi.org)
  










[ Top ]







Class Variables



	
	

	
$cache =  null

	
[line 26]

  
  

	

  

    

      Type:  
      mixed
    

      

	



	
[ Top ]


	
	

	
$expireTime = 

	
[line 28]

  
  

	

  

    

      Type:  
      mixed
    

      

	



	
[ Top ]


	
	

	
$loadedPackages = array()

	
[line 27]

  
  

	

  

    

      Type:  
      mixed
    

      

	



	
[ Top ]


	
	

	
$packagePath =  null

	
[line 25]

  



Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      mixed
    

      

	



	
[ Top ]










Class Methods



  

	
	
constructor __construct [line 45]

	

    

    

		void __construct(
Cache
$cache, string
$packagePath, [mixed
$expireTime = 60])
    

    


	
		Construct the object





Tags:





  

    access:  public
  

  

    since:  4.0.0
  

  

    author:  Tyler Tompkins (ttompkins@mojavi.org)
  

  

    throws:  PackageException if cache or package path does not exist
  










        
Parameters:

    

    

          

        string  
        $cache  
        Package path
      

          

        string  
        $packagePath  
        Cache path
      

        

    


        
[ Top ]

  

  

	
	
method fixDirective [line 345]

	

    

    

		void fixDirective(
type
$string)
    

    


	
		Fixed the directive





Tags:





  

    access:  protected
  

  

    since:  4.0.0
  

  

    author:  Tyler Tompkins (ttompkins@mojavi.org)
  










        
Parameters:

    

    

          

        type  
        $string  
        descrip
      

        

    


        
[ Top ]

  

  

	
	
method getPackageContents [line 310]

	

    

    

		array &getPackageContents(
string
&$packageFile)
    

    


	
		Retrieve an array of all files package describes, including files of  packages it describes.





Tags:





  

    return:  a list of packages from within the package descriptor
  

  

    access:  public
  

  

    since:  4.0.0
  

  

    author:  Tyler Tompkins (ttompkins@mojavi.org)
  










        
Parameters:

    

    

          

        string  
        &$packageFile  
        Package filename
      

        

    


        
[ Top ]

  

  

	
	
method getPackageFiles [line 188]

	

    

    

		void getPackageFiles(
string
$packageDirective, int
1)
    

    


	
		Load a package





Tags:





  

    access:  public
  

  

    since:  4.0.0
  

  

    author:  Tyler Tompkins (ttompkins@mojavi.org)
  










        
Parameters:

    

    

          

        int  
        1  
        Expire time denotes a value, in seconds, after which the   cache should be regenerated if past.
      

          

        string  
        $packageDirective  
        A package directive 
  • ex. "common.cache.*"

      

        

    


        
[ Top ]

  

  

	
	
method isDirective [line 363]

	

    

    

		void isDirective(
type
$string)
    

    


	
		



Tags:





  

    access:  public
  

  

    since:  4.0.0
  

  

    author:  Tyler Tompkins (ttompkins@mojavi.org)
  










        
Parameters:

    

    

          

        type  
        $string  
        descrip
      

        

    


        
[ Top ]

  

  

	
	
method load [line 81]

	

    

    

		void load(
type
$packageDirective)
    

    


	
		Load a package directive





Tags:





  

    access:  public
  

  

    since:  4.0.0
  

  

    author:  Tyler Tompkins (ttompkins@mojavi.org)
  










        
Parameters:

    

    

          

        type  
        $packageDirective  
        descrip
      

        

    


        
[ Top ]

  






        

		    

		    Documentation generated on Tue, 21 Feb 2006 02:29:56 +0900 by phpDocumentor 1.3.0RC5