Class EVS

Description
Description | Vars (details) | Methods (details)

Implements the creation and management of different EVSProjects.

EVS provides: Coding standards.
Unified design model for all applications: MVC.
An evnrironment that makes it easyer to manage the development, testing and documentation of different applications.
A collection of powerful classes for faster application development.
The RSDEngine - the Rapid and Secure Development Engine for generating code from your database desing.

Located in /code/framework/EVS/EVS.php (line 78) 


	
			





	
	

		
Variable Summary

		

			Description |
						Vars (details)
							| 
									Methods (details)
							
					

		

			

								

					Array
					$defaults
				

								

					Array
					$projects
				

								

					String
					$_root
				

							

		

	


	
	

		
Method Summary

		

			Description |
															Vars (details)
				 
				|
						Methods (details)
		

		
			
			

								
				

											EVS
										EVS
											(String $root, Array $defaults)
									

								
				

											mixed
										&createProject
											(String $projectName, String $versioning)
									

								
				

											mixed
										&getProject
											(String $projectName)
									

								
				

											String
										getProjectSkel
										()
									

								
				

											String
										getRoot
										()
									

								
				

											String
										getVersionSkel
										()
									

								
				

											String
										getVersionWebApplicationSkel
										()
									

								
				

											void
										loadProjects
										()
									

								
				

											boolean
										projectExists
											(String $name)
									

							

		

	
		

	
	

		
Variables

		

			Description |
										Vars (details)
						
			
							| 
									Methods (details)
							
					

		

			



	

		
			Array
			$defaults
			 = array()			(line 92)
		
	


	

An associative array holding the default values for new projects.


This property is set inside the constcructor method.

	
    
				
  • var: An associative array.
    • 
				
  • see: EVS::EVS
    • 
			

	
	
		
		







	

		
			Array
			$projects
			 = array()			(line 84)
		
	


	

Holds all projects as instances of EVSProject. Gets filled by loadProjects.

	
    
				
  • see: loadProjects.
    • 
			

	
	
		
		







	

		
			String
			$_root
			 =  ''			(line 97)
		
	


	

The path where EVS is installed.

	
    
				
  • var: A path name without a trailing slash.
    • 
			

	
	
		
		



						
		

	

	
	
	

		
Methods

		

			Description |
															Vars (details)
														Methods (details)
						
		

		

			



	
	

		Constructor EVS (line 108)
	
 
	
	

Constructor method.


Sets $this->_root and $this->defaults.

	
	
	

		EVS
		
			EVS
		
					(String $root, Array $defaults)
			

	
			
    
					
  • 
				String
				$root: The path where EVS is installed.			
    • 
					
  • 
				Array
				$defaults: An associative array holding the default values for new projects.			
    • 
				

		
		
	




	
	

		createProject (line 199)
	
 
	
	

Creates a new project and returns a new EVSProject.

	
    
				
  • return: A new instance of EVSProject on success or an instance of RSError on failure.
    • 
			

	
	

		mixed
		
			&createProject
		
					(String $projectName, String $versioning)
			

	
			
    
					
  • 
				String
				$projectName: The name of the project to create.			
    • 
					
  • 
				String
				$versioning: If you do not want versioning support for this project pass an empty string otherwise a non-empty.			
    • 
				

		
		
	




	
	

		getProject (line 120)
	
 
	
	

Returns a new instance of EVSProject.

	
    
				
  • return: An instance of EVSProject or if the project does not exist false.
    • 
				
  • see: EVSProject
    • 
			

	
	

		mixed
		
			&getProject
		
					(String $projectName)
			

	
			
    
					
  • 
				String
				$projectName: The name of the project.			
    • 
				

		
		
	




	
	

		getProjectSkel (line 188)
	
 
	
	

Returns an absolute path to the skel (skeleton) where all files for a new project are stored.

	
    
				
  • return: Absolute path to the project skel.
    • 
			

	
	

		String
		
			getProjectSkel
		
				()
			

	
		
		
	




	
	

		getRoot (line 164)
	
 
	
	

Returns the root of the EVS directory structure.


In fact $this->_root is just returned.

	
    
				
  • return: Absolute path to the root directory of EVS.
    • 
				
  • see: EVS::$_root
    • 
			

	
	

		String
		
			getRoot
		
				()
			

	
		
		
	




	
	

		getVersionSkel (line 172)
	
 
	
	

Returns an absolute path to the skel (skeleton) where all files for a version are stored.

	
    
				
  • return: Absolute path to the skel.
    • 
			

	
	

		String
		
			getVersionSkel
		
				()
			

	
		
		
	




	
	

		getVersionWebApplicationSkel (line 180)
	
 
	
	

Returns an absolute path to the skel (skeleton) where all files for a version that was defined as an web application are stored.

	
    
				
  • return: Absolute path to the web application skel.
    • 
			

	
	

		String
		
			getVersionWebApplicationSkel
		
				()
			

	
		
		
	




	
	

		loadProjects (line 132)
	
 
	
	

Loads all projects as instances of EVSProject into $this->projects.

	
	
	

		void
		
			loadProjects
		
				()
			

	
		
		
	




	
	

		projectExists (line 153)
	
 
	
	

Returns true if the project exists.

	
    
				
  • return: True if the project exists, false otherwise.
    • 
			

	
	

		boolean
		
			projectExists
		
					(String $name)
			

	
			
    
					
  • 
				String
				$name: The name of the project.			
    • 
				

		
		
	

						
		

	

	
	

		Documentation generated on Mon,  8 Dec 2003 13:10:31 +0100 by phpDocumentor 1.2.3