phpDocumentor GloryLands
Common
[ class tree: GloryLands ] [ index: GloryLands ] [ all elements ]
GloryLands
Packages:
GloryLands
Modules

Files:
general.default.php
Common
cache.php
errors.php
glconfig.php
gldataset.php
optimizer.php
proxy.php
Database
db.mysql.php
db.php
db.structured.php
struct.ordered.php
DOM
gldom.php
gldom_element.php
Extensions
glhooks.php
glIPC.php
glmodule.php
glmodules.php
glpermissions.php
GLOO
gloobject.php
gloobject_stage.php
gloolink.php
Interface
form.php
glsmarttemplate.php
gltemplate.php
Optimizer
compatibility.php
gltools.php
xmlconfig.php
System
api.php
bootstrap.php
gl.php
glassemblyline.php
glstreamdef.php
view.php

Classes:
System
GL
GLAssemblyLine
GLStream
srm_api
srm_view
Common
GLCache
GLConfig
GLConfigFile
GLDataset
GLDynamicPath
GLError
GLOptimizer
GLOptimizerModule
Optimizer
GLTools
opt_compatibility
opt_xmlconfig
Database
DBJet
GLDB
GLDBOrderedConfig
GLDBRecord
GLDBRecordset
mysql_jet
Interface
GLIForm
GLSmartTemplate
GLTemplate
DOM
GLDOM
GLDOMElement
Extensions
GLHooks
GLIPC
GLModule
GLModules
GLPermissions
GLOO
GLDOMStage
GLOOLink
GLOOObject

Class: GLDataset

Source Location: /engine/lib/common/gldataset.php

Class GLDataset

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

Basic Dataset Structure The dataset structure is a dynamic data store that provides a variable access system, with some extended variable management functions.

Basic Dataset Structure The dataset structure is a dynamic data store that provides a variable access system, with some extended variable management functions.

Located in /engine/lib/common/gldataset.php [line 44] 



		
				Author(s):
		
    
		  			 		  		

		
		
Information Tags:



			
Version:  1.0

	

				

				
		
Properties

		
				
		
				
		
Methods

		
				
		
		

		
[ Top ]

	




	
	

		
Descendants

		

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

		

			

				

					Child Class
					Description
				

								

					GLDOMElement
					
											Basic DOM Element
 This class provides the basic class that implements the DOM element.
										
				

								

					GLTemplate
					
											GloryLands PHP Template Engine
 This template extends the Dataset structure in order to provide simple variable access, and uses template optimizer to convert short-hand PHP tags to fully compatible PHP code.
										
				

							

			
[ Top ]

		

	




	
	

		
Property Summary

		

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

		

			

			

					

																			
mixed  
					$vars  
					

				
										

			

			
[ Top ]

		

	


	
	

		
Method Summary

		

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

		

			

				

											

											

											

											

											

											

											

											

											

											

											

											

											

											

											

											

											

											

																																																																																																																																																																
GLDataset  
										__construct()  
					

				
																
void  
										assign()  
					Assign a value into a variable

				
																
void  
										import()  
					Import variables from an array or object

				
																
void  
										object_added()  
					An inheritable function to notify an object attachment

				
																
void  
										object_removed()  
					An inheritable function to notify an object detachment

				
																
void  
										pop()  
					Pop a value from a variable

				
																
void  
										push()  
					Push a value on a variable
 If the variable is not an array, it is conerted to.

				
																
void  
										push_once()  
					Push a value on a variable, but make sure it's only one on the array
 This function checks for an existing $value on the array. exists, it is not appended twice.

				
																
void  
										shift()  
					Shift a value from a variable

				
																
void  
										sort()  
					Sort the contents of a variable

				
																
void  
										unshift()  
					Unshift a value on a variable
 If the variable is not an array, it is conerted to.

				
																
void  
										usort()  
					Sort the contents of a variable using a user callback

				
																
void  
										var_changed()  
					An inheritable function to notify a variable update

				
																
void  
										var_removed()  
					An inheritable function to notify a variable removal

				
																
void  
										__get()  
					Get data variables

				
																
void  
										__isset()  
					Check for defined variables

				
																
void  
										__set()  
					Set data variables

				
																
void  
										__unset()  
					Unset a variable

				
												

			

			
[ Top ]

		

	


	
	

		
Properties

		

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

		

			



	

		
			mixed  
			$vars
						[line 46]
		
	


		API Tags:



  

    Access:  protected
  







	
		

	
[ Top ]



		

	


	
	

		
Methods

		

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

		

			







	Constructor __construct  [line 48]





	

    

    
 
		GLDataset __construct(
)
    

    



	
	

	API Tags:



  

    Access:  public
  







		
			

		
Redefined in descendants as:

		
		

	
[ Top ]









	assign  [line 314]





	

    

    
 
		void assign(
string
$name, mixed
$value 
)
    

    



	
Assign a value into a variable



Assign a value into a variable

			Parameters:

			

					

				string  
				
				$name: 
				
				 The variable name to define			

					

				mixed  
				
				$value: 
				
				 The variable value			

				


	

	API Tags:



  

    Access:  public
  







		
		

	
[ Top ]









	import  [line 328]





	

    

    
 
		void import(
mixed
$src 
)
    

    



	
Import variables from an array or object



Import variables from an array or object

			Parameters:

			

					

				mixed  
				
				$src: 
				
				 The object to scan for variables			

				


	

	API Tags:



  

    Access:  public
  







		
		

	
[ Top ]









	object_added  [line 401]





	

    

    
 
		void object_added(
string
$name, 
&$object, object
$object 
)
    

    



	
An inheritable function to notify an object attachment



An inheritable function to notify an object attachment

			Parameters:

			

					

				string  
				
				$name: 
				
				 The variable name that was updated			

					

				object  
				
				$object: 
				
				 The object that was added			

					

				  
				
				&$object: 
				
							

				


	

	API Tags:



  

    Access:  protected
  







		
			

		
Redefined in descendants as:

		
		

	
[ Top ]









	object_removed  [line 411]





	

    

    
 
		void object_removed(
string
$name, 
&$object, object
$object 
)
    

    



	
An inheritable function to notify an object detachment



An inheritable function to notify an object detachment

			Parameters:

			

					

				string  
				
				$name: 
				
				 The variable name that was updated			

					

				object  
				
				$object: 
				
				 The object that was removed			

					

				  
				
				&$object: 
				
							

				


	

	API Tags:



  

    Access:  protected
  







		
			

		
Redefined in descendants as:

		
		

	
[ Top ]









	pop  [line 194]





	

    

    
 
		void pop(
string
$var 
)
    

    



	
Pop a value from a variable



Pop a value from a variable
 If the variable is not an array, the variable is returned and then unsetted If the variable is not defined, NULL is returned

			Parameters:

			

					

				string  
				
				$var: 
				
				 The variable name			

				


	

	API Tags:



  

    Access:  public
  







		
		

	
[ Top ]









	push  [line 61]





	

    

    
 
		void push(

$var, mixed
$value, string
$name 
)
    

    



	
Push a value on a variable
 If the variable is not an array, it is conerted to.



Push a value on a variable
 If the variable is not an array, it is conerted to. If the variable is not definet, it will be created as an array.

			Parameters:

			

					

				string  
				
				$name: 
				
				 The variable name			

					

				mixed  
				
				$value: 
				
				 The variable value			

					

				  
				
				$var: 
				
							

				


	

	API Tags:



  

    Access:  public
  







		
		

	
[ Top ]









	push_once  [line 101]





	

    

    
 
		void push_once(

$var, mixed
$value, [mixed
$uid = false], string
$name 
)
    

    



	
Push a value on a variable, but make sure it's only one on the array
 This function checks for an existing $value on the array. exists, it is not appended twice.



Push a value on a variable, but make sure it's only one on the array
 This function checks for an existing $value on the array. If it already exists, it is not appended twice.
 If you specify the $uid parameter, the unique matching is based on the value of this variable.

			Parameters:

			

					

				string  
				
				$name: 
				
				 The variable name			

					

				mixed  
				
				$value: 
				
				 The variable value			

					

				mixed  
				
				$uid: 
				
				 [Optional] The unique ID to perform single matching. If not defined, uniqueness will be checked with the content.			

					

				  
				
				$var: 
				
							

				


	

	API Tags:



  

    Access:  public
  







		
		

	
[ Top ]









	shift  [line 239]





	

    

    
 
		void shift(
string
$var 
)
    

    



	
Shift a value from a variable



Shift a value from a variable
 If the variable is not an array, the variable is returned and then unsetted If the variable is not defined, NULL is returned

			Parameters:

			

					

				string  
				
				$var: 
				
				 The variable name			

				


	

	API Tags:



  

    Access:  public
  







		
		

	
[ Top ]









	sort  [line 284]





	

    

    
 
		void sort(
string
$var, [int
$sort_flags = 0] 
)
    

    



	
Sort the contents of a variable



Sort the contents of a variable
 If the variable is not an array or not defined, nothing happens

			Parameters:

			

					

				string  
				
				$var: 
				
				 The variable name			

					

				int  
				
				$sort_flags: 
				
				 The sort flags, as defined in sort()			

				


	

	API Tags:



  

    Access:  public
  







		
		

	
[ Top ]









	unshift  [line 158]





	

    

    
 
		void unshift(

$var, mixed
$value, string
$name 
)
    

    



	
Unshift a value on a variable
 If the variable is not an array, it is conerted to.



Unshift a value on a variable
 If the variable is not an array, it is conerted to. If the variable is not definet, it will be created as an array.

			Parameters:

			

					

				string  
				
				$name: 
				
				 The variable name			

					

				mixed  
				
				$value: 
				
				 The variable value			

					

				  
				
				$var: 
				
							

				


	

	API Tags:



  

    Access:  public
  







		
		

	
[ Top ]









	usort  [line 300]





	

    

    
 
		void usort(
string
$var, int
$cmp_function 
)
    

    



	
Sort the contents of a variable using a user callback



Sort the contents of a variable using a user callback
 If the variable is not an array or not defined, nothing happens

			Parameters:

			

					

				string  
				
				$var: 
				
				 The variable name			

					

				int  
				
				$cmp_function: 
				
				 The sorting function			

				


	

	API Tags:



  

    Access:  public
  







		
		

	
[ Top ]









	var_changed  [line 382]





	

    

    
 
		void var_changed(
string
$name, 
&$value, mixed
$value 
)
    

    



	
An inheritable function to notify a variable update



An inheritable function to notify a variable update

			Parameters:

			

					

				string  
				
				$name: 
				
				 The variable name that was updated			

					

				mixed  
				
				$value: 
				
				 The variable value			

					

				  
				
				&$value: 
				
							

				


	

	API Tags:



  

    Access:  protected
  







		
			

		
Redefined in descendants as:

		
		

	
[ Top ]









	var_removed  [line 391]





	

    

    
 
		void var_removed(
string
$name 
)
    

    



	
An inheritable function to notify a variable removal



An inheritable function to notify a variable removal

			Parameters:

			

					

				string  
				
				$name: 
				
				 The variable name that was removed			

				


	

	API Tags:



  

    Access:  protected
  







		
			

		
Redefined in descendants as:

		
		

	
[ Top ]









	__get  [line 349]





	

    

    
 
		void __get(
string
$name 
)
    

    



	
Get data variables



Get data variables

			Parameters:

			

					

				string  
				
				$name: 
				
				 The variable name to return			

				


	

	API Tags:



  

    Access:  public
  







		
		

	
[ Top ]









	__isset  [line 372]





	

    

    
 
		void __isset(
string
$name 
)
    

    



	
Check for defined variables



Check for defined variables

			Parameters:

			

					

				string  
				
				$name: 
				
				 The variable name to check			

				


	

	API Tags:



  

    Access:  public
  







		
		

	
[ Top ]









	__set  [line 363]





	

    

    
 
		void __set(
string
$name, mixed
$value 
)
    

    



	
Set data variables



Set data variables

			Parameters:

			

					

				string  
				
				$name: 
				
				 The variable name to define			

					

				mixed  
				
				$value: 
				
				 The variable value			

				


	

	API Tags:



  

    Access:  public
  







		
		

	
[ Top ]









	__unset  [line 339]





	

    

    
 
		void __unset(
string
$name 
)
    

    



	
Unset a variable



Unset a variable

			Parameters:

			

					

				string  
				
				$name: 
				
				 The variable name to unset			

				


	

	API Tags:



  

    Access:  public
  







		
		

	
[ Top ]



		

	



        

		    

		    Documentation generated on Tue, 13 Oct 2009 23:49:00 +0300 by phpDocumentor 1.4.1