Welcome, Guest Log In
[ class tree: Krai ] [ index: Krai ] [ all elements ]
Krai
Packages:
Krai
Demo

Classes:
Module
Krai_Module
Krai_Module_Action
Krai_Module_Exception
Krai_Module_Exception_Adone
Krai_Module_Exception_Mdone
Cache
Krai_Cache
Krai_Cache_Exception
Log
Krai_Log
Krai_Log_Logger
Krai_Log_Logger_Console
Krai_Log_Logger_Email
Krai_Log_Logger_Local
Krai_Log_Logger_Syslog
Krai_Log_Session
Db
Krai_Db
Krai_Db_Exception
Krai_Db_Handler
Krai_Db_Handler_Mysql
Krai_Db_Handler_Pdo
Krai_Db_Object
Krai_Db_Query
Struct
Krai_Struct
Krai_Struct_Dbquery
Krai_Struct_Dbquery_Delete
Krai_Struct_Dbquery_Insert
Krai_Struct_Dbquery_Select
Krai_Struct_Dbquery_Update
Krai_Struct_Exception
Krai_Struct_Loginfo
Krai_Struct_Mail
Krai_Struct_Mailconf
Krai
Krai_Exception
Markup
Krai_Markup
Krai_Markup_Exception
Mail
Krai_Mail
Krai_Mail_Exception
Router
Krai_Router
Krai_Router_Exception
Krai_Router_Route
Lib
Krai_Lib_Inflector
Nakor
Spyc

Files:
Exception.php
Krai.php
Cache
Cache.php
Exception.php
Db
Db.php
Exception.php
Handler.php
Mysql.php
Object.php
Pdo.php
Query.php
Lib
Inflector.php
Lib.php
Nakor.php
Spyc.php
Log
Console.php
Email.php
Local.php
Log.php
Logger.php
Session.php
Syslog.php
Mail
Exception.php
Mail.php
Markup
Exception.php
Markup.php
Module
Action.php
Adone.php
Exception.php
Mdone.php
Module.php
Router
Exception.php
Route.php
Router.php
Struct
Dbquery.php
Delete.php
Exception.php
Insert.php
Loginfo.php
Mail.php
Mailconf.php
Select.php
Struct.php
Update.php

Class Krai_Struct

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

A struct type abstract class

This class provides a sort of approximation of a struct type from some other languages. The Krai_Struct::$FIELDS variable holds the names and default values of the allowed properties. The default values are also used to determine what type the values of those properties must have.

The class uses the PHP overloading functions to control the public behavior.

Located in /Krai/Struct.php [line 32] 



		
				Author(s):
		
    
		  			 		  		

		
		API Tags:



  

    Abstract:  
  






				

				
		
Properties

		
				
		
				
		
Methods

		
				
		
		

		
[ Top ]

	




	
	

		
Descendants

		

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

		

			

				

					Child Class
					Description
				

								

					Krai_Struct_Loginfo
					
											Log Info Struct
										
				

								

					Krai_Struct_Dbquery
					
											Database base query struct
										
				

								

					Krai_Struct_Mail
					
											Struct holding the information for an e-mail
										
				

								

					Krai_Struct_Mailconf
					
											Struct holding the information for an e-mail connection
										
				

								

					AccessScheme
					
											Structure of an Access Scheme for use with authenticating permissions.
										
				

							

			
[ Top ]

		

	




	
	

		
Property Summary

		

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

		

			

			

					

					

																									
array  
					$DATA  
					Array of current values of the Fields

				
													
array  
					$FIELDS  
					Array of allowed properties of the struct

				
										

			

			
[ Top ]

		

	


	
	

		
Method Summary

		

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

		

			

				

											

											

											

											

																																																
Krai_Struct  
										__construct()  
					Constructor

				
																
boolean  
										VarAllowed()  
					Determine whether a property is allowed to be get / set

				
																
mixed  
										__get()  
					PHP magic function for getting a property value

				
																
void  
										__set()  
					PHP magic function for setting a property value

				
												

			

			
[ Top ]

		

	


	
	

		
Properties

		

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

		

			



	

		
			array  
			$DATA
			 = array()			[line 54]
		
	


	
Array of current values of the Fields



This variable holds the data that currently resides in each of the allowed  properties.
	API Tags:



  

    Access:  protected
  







	
		

	
[ Top ]







	

		
			array  
			$FIELDS
			 = array()			[line 44]
		
	


	
Array of allowed properties of the struct



This variable holds the names and  default values of the allowed properties. The default values are also used  to determine what type the values of those properties must have.
	API Tags:



  

    Access:  protected
  







	
			

		
Redefined in descendants as:

		
		

	
[ Top ]



		

	


	
	

		
Methods

		

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

		

			







	Constructor __construct  [line 66]





	

    

    
 
		Krai_Struct __construct(
[
$new_defaults = array()] 
)
    

    



	
Constructor



This function initializes the struct instance. It accepts overrides of the  default values, in lieu of setting those values after initialization, for  convenience.

			Parameters:

			

					

				array  
				
				$new_defaults: 
				
				 Override the default values of the allowed  fields			

				


	

	API Tags:



  

    Access:  public
  







		
			

		
Redefined in descendants as:

		
		

	
[ Top ]









	VarAllowed  [line 140]





	

    

    
 
		boolean VarAllowed(
mixed
$m 
)
    

    



	
Determine whether a property is allowed to be get / set



This function determines, from the Krai_Struct::$FIELDS variable,  whether or not a certail property is allowed.

			Parameters:

			

					

				mixed  
				
				$m: 
				
				 The name of the property			

				


	

	API Tags:



  

    Access:  protected
  







		
		

	
[ Top ]









	__get  [line 94]





	

    

    
 
		mixed __get(
mixed
$m 
)
    

    



	
PHP magic function for getting a property value



Returns the current value of a property, or throws a Krai_Struct_Exception  if that property is not valid.

			Parameters:

			

					

				mixed  
				
				$m: 
				
				 The name of the property of which to get the value			

				


	

	API Tags:



  

    Return:  The value of the property
  

  

    Access:  public
  






Information Tags:



  

    Throws:  Krai_Struct_Exception
  




		
		

	
[ Top ]









	__set  [line 118]





	

    

    
 
		void __set(
mixed
$m, mixed
$v 
)
    

    



	
PHP magic function for setting a property value



Sets the value of the property if it is allowed by the struct and if the value  is of the correct type. Otherwise throws a Krai_Struct_Exception.

			Parameters:

			

					

				mixed  
				
				$m: 
				
				 The name of the property to set			

					

				mixed  
				
				$v: 
				
				 The value of the property to set			

				


	

	API Tags:



  

    Access:  public
  






Information Tags:



  

    Throws:  Krai_Struct_Exception
  




		
		

	
[ Top ]



		

	



        

		    

		    Documentation generated on Fri, 25 Jul 2008 15:20:04 -0400 by phpDocumentor 1.4.2
	      

      

    		
  




	

	
    

    

      Krai Framework
      
        site admin
        credits
        sitemap
        valid xhtml?