phpDocumentor Smarty
[ class tree: Smarty ] [ index: Smarty ] [ all elements ]
Smarty
Packages:
phpDocumentor
Converters
Cpdf
HTML_TreeMenu
Smarty
tests
XML_Beautifier

Files:
Config_File.class.php
Smarty.class.php
Smarty_Compiler.class.php
plugins
block.strip.php
block.textformat.php
core.assemble_plugin_filepath.php
core.assign_smarty_interface.php
core.create_dir_structure.php
core.display_debug_console.php
core.get_include_path.php
core.get_microtime.php
core.get_php_resource.php
core.is_secure.php
core.is_trusted.php
core.load_plugins.php
core.load_resource_plugin.php
core.process_cached_inserts.php
core.process_compiled_include.php
core.read_cache_file.php
core.rmdir.php
core.rm_auto.php
core.run_insert_handler.php
core.smarty_include_php.php
core.write_cache_file.php
core.write_compiled_include.php
core.write_compiled_resource.php
core.write_file.php
function.assign.php
function.assign_debug_info.php
function.config_load.php
function.counter.php
function.cycle.php
function.debug.php
function.eval.php
function.fetch.php
function.html_checkboxes.php
function.html_image.php
function.html_options.php
function.html_radios.php
function.html_select_date.php
function.html_select_time.php
function.html_table.php
function.mailto.php
function.math.php
function.popup.php
function.popup_init.php
function.var_dump.php
modifier.capitalize.php
modifier.cat.php
modifier.count_characters.php
modifier.count_paragraphs.php
modifier.count_sentences.php
modifier.count_words.php
modifier.date_format.php
modifier.debug_print_var.php
modifier.default.php
modifier.escape.php
modifier.htmlentities.php
modifier.indent.php
modifier.lower.php
modifier.nl2br.php
modifier.rawurlencode.php
modifier.regex_replace.php
modifier.replace.php
modifier.spacify.php
modifier.string_format.php
modifier.strip.php
modifier.strip_tags.php
modifier.truncate.php
modifier.upper.php
modifier.wordwrap.php
outputfilter.trimwhitespace.php
shared.escape_special_chars.php
shared.make_timestamp.php

Classes:
Config_File
Smarty
Smarty_Compiler

Class: Config_File

Source Location: /phpDocumentor/Smarty-2.6.0/libs/Config_File.class.php

Class Config_File

Class Overview
Class Overview | Properties Summary | Properties Detail | Method Summary | Methods Detail

Config file reading class

Located in /phpDocumentor/Smarty-2.6.0/libs/Config_File.class.php [line 39] 



		
		
		
				

				
		
Properties

		
				
		
				
		
Methods

		
				
		
		

		
[ Top ]

	







	
	

		
Property Summary

		

			Class Overview |
									Property Summary | Properties Detail
												Method Summary | Methods Detail
											    				

		

			

			

					

					

					

					

					

																																											
mixed  
					$booleanize  
					Controls whether config values of on/true/yes and off/false/no get  converted to boolean values automatically.

				
													
mixed  
					$fix_newlines  
					Controls whether or not to fix mac or dos formatted newlines.

				
													
mixed  
					$overwrite  
					Controls whether variables with the same name overwrite each other.

				
													
mixed  
					$read_hidden  
					Controls whether hidden config sections/vars are read from the file.

				
													
mixed  
					$_config_data  
					

				
										

			

			
[ Top ]

		

	


	
	

		
Method Summary

		

			Class Overview |
																		Properties Summary | Properties Detail
											    					Method Summary | Methods Detail
		

		

			

				

											

											

											

											

											

											

											

											

											

																																																																																								
Config_File  
										Config_File()  
					Constructs a new config file class.

				
																
void  
										clear()  
					Clear loaded config data for a certain file or all files.

				
																
string|array  
										&get()  
					Retrieves config info based on the file, section, and variable name.

				
																
array  
										get_file_names()  
					Get all loaded config file names.

				
																
string|array  
										&get_key()  
					Retrieves config info based on the key.

				
																
array  
										get_section_names()  
					Get all section names from a loaded file.

				
																
array  
										get_var_names()  
					Get all global or section variable names.

				
																
void  
										load_file()  
					Load a configuration file manually.

				
																
void  
										set_path()  
					Set the path where configuration files can be found.

				
												

			

			
[ Top ]

		

	


	
	

		
Properties

		

			Class Overview |
													Property Summary | Properties Detail
			
							|
									Method Summary | Methods Detail
												

		

			



	

		
			mixed  
			$booleanize
			 =     true			[line 53]
		
	


	
Controls whether config values of on/true/yes and off/false/no get  converted to boolean values automatically.



Options
	

	
		

	
[ Top ]







	

		
			mixed  
			$fix_newlines
			 =     true			[line 64]
		
	


	
Controls whether or not to fix mac or dos formatted newlines.



Options  If set to true, \r or \r\n will be changed to \n.
	

	
		

	
[ Top ]







	

		
			mixed  
			$overwrite
			 =     true			[line 47]
		
	


	
Controls whether variables with the same name overwrite each other.



Options
	

	
		

	
[ Top ]







	

		
			mixed  
			$read_hidden
			 =     true			[line 58]
		
	


	
Controls whether hidden config sections/vars are read from the file.



Options
	

	
		

	
[ Top ]







	

		
			mixed  
			$_config_data
			 = array()			[line 69]
		
	


		

	
		

	
[ Top ]



		

	


	
	

		
Methods

		

			Class Overview |
									                |
									Property Summary | Properties Detail
																	| Method Summary | Methods Detail
					

		

			







	Constructor Config_File  [line 77]





	

    

    
 
		Config_File Config_File(
[string
$config_path = NULL] 
)
    

    



	
Constructs a new config file class.



			Parameters:

			

					

				string  
				
				$config_path: 
				
				 (optional) path to the config files			

				


	

	

		
		

	
[ Top ]









	clear  [line 218]





	

    

    
 
		void clear(
[string
$file_name = NULL] 
)
    

    



	
Clear loaded config data for a certain file or all files.



			Parameters:

			

					

				string  
				
				$file_name: 
				
				 file to clear config data for			

				


	

	

		
		

	
[ Top ]









	get  [line 113]





	

    

    
 
		string|array &get(
string
$file_name, [string
$section_name = NULL], [string
$var_name = NULL] 
)
    

    



	
Retrieves config info based on the file, section, and variable name.



			Parameters:

			

					

				string  
				
				$file_name: 
				
				 config file to get info for			

					

				string  
				
				$section_name: 
				
				 (optional) section to get info for			

					

				string  
				
				$var_name: 
				
				 (optional) variable to get info for			

				


	

	API Tags:



  

    Return:  a value or array of values
  

  

    Usedby:  Config_File::get_key() - retrieves information from config file and returns it
  







		
		

	
[ Top ]









	get_file_names  [line 165]





	

    

    
 
		array get_file_names(
)
    

    



	
Get all loaded config file names.



	

	API Tags:



  

    Return:  an array of loaded config file names
  







		
		

	
[ Top ]









	get_key  [line 153]





	

    

    
 
		string|array &get_key(
$file_name
$config_key 
)
    

    



	
Retrieves config info based on the key.



			Parameters:

			

					

				$file_name  
				
				$config_key: 
				
				 string config key (filename/section/var)			

				


	

	API Tags:



  

    Return:  same as get()
  

  

    Uses:  Config_File::get() - retrieves information from config file and returns it
  







		
		

	
[ Top ]









	get_section_names  [line 177]





	

    

    
 
		array get_section_names(
string
$file_name 
)
    

    



	
Get all section names from a loaded file.



			Parameters:

			

					

				string  
				
				$file_name: 
				
				 config file to get section names from			

				


	

	API Tags:



  

    Return:  an array of section names from the specified file
  







		
		

	
[ Top ]









	get_var_names  [line 196]





	

    

    
 
		array get_var_names(
string
$file_name, [
$section = NULL], string
$section_name 
)
    

    



	
Get all global or section variable names.



			Parameters:

			

					

				string  
				
				$file_name: 
				
				 config file to get info for			

					

				string  
				
				$section_name: 
				
				 (optional) section to get info for			

					

				  
				
				$section: 
				
							

				


	

	API Tags:



  

    Return:  an array of variables names from the specified file/section
  







		
		

	
[ Top ]









	load_file  [line 234]





	

    

    
 
		void load_file(
string
$file_name, [boolean
$prepend_path = true] 
)
    

    



	
Load a configuration file manually.



			Parameters:

			

					

				string  
				
				$file_name: 
				
				 file name to load			

					

				boolean  
				
				$prepend_path: 
				
				 whether current config path should be                               prepended to the filename			

				


	

	

		
		

	
[ Top ]









	set_path  [line 89]





	

    

    
 
		void set_path(
string
$config_path 
)
    

    



	
Set the path where configuration files can be found.



			Parameters:

			

					

				string  
				
				$config_path: 
				
				 path to the config files			

				


	

	

		
		

	
[ Top ]



		

	



        

		    

		    Documentation generated on Tue, 24 Oct 2006 09:21:18 -0500 by phpDocumentor 1.3.1