Object-relational mapping.
[Database Connectivity]

Collaboration diagram for Object-relational mapping.:

This file is part of Zigmoyd PHP Framework. More...


Data Structures
class	zOrm_base
class	orm_CodeGen
	orm_CodeGen Class Parses the the orm Map on .orm.map.php file from /projects/prjName/etc/conf.d and generates the classes on /projects/prjName/apps/model/orm More...
class	zOrm_core
class	OrmDriver
class	OrmDriver_mysql
class	zOrm_magic
class	zOrm_inc
class	zOrm_noMagic
Functions
	load_orm_map ($mapName, $projectName)
	load_orm_map() will accept the ormMapName and projectName parse the orm Map from /projects/projectName/etc/conf.d/ormMapName.orm.map.php generate the class on /projects/projectName/apps/model/orm/ormMapName.orm.php and then include that generated class file and returns the tableAlias className(s) as an numarically indexed array
Variables
	$__zigmoyd__Orm_drv = new stdClass()
	$__ZigOrm = new stdClass()
	Initializes the ORM Module gets Included for Initialization of ORM Module by the /etc/init.d initialization Script.
$__ZigOrm	connections = array()
$__ZigOrm	dataDict = new stdClass()
$__ZigOrm dataDict	tables = array()

Detailed Description

This file is part of Zigmoyd PHP Framework.

Zigmoyd PHP Framework is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

Zigmoyd PHP Framework is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with Zigmoyd PHP Framework. If not, see <http://www.gnu.org/licenses/>.

Database Abstraction Layers.

Zigmoyd PHP Framework is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

Zigmoyd PHP Framework is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with Zigmoyd PHP Framework. If not, see <http://www.gnu.org/licenses/>.

Database Abstraction Layers.

Zigmoyd PHP Framework is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

Zigmoyd PHP Framework is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with Zigmoyd PHP Framework. If not, see <http://www.gnu.org/licenses/>.

Database Abstraction Layers While Using Static ORM Maps database access is done through Database Abstraction Layers or ORM Classes. An ORM Class is a Database abstraction Layer that isolets SQL Queries by writting/generating it on the fly, with a set of easy and user-friendly methods for full CRUD(Create, read, update, delete) Operation that are linked through Models with the controller(action Logic). ORM Classes need not to be written from scratch.they are automatically generated by reading ORM Maps. ORM Maps are textual, Highly Human readable configuration files that Manages different tables and links a connection against them. Zigmoyd Parses those ORM Maps (Configuration Files) and generates the ORM Classes. Although the ORM Classes are auto generated, they <s>can be</s> meant to be edited if required.to handle Custom access methods, addign triggers etc.....
ORM Maps are stored into etc/conf.d Directory with orm.map.php extension. Although ORM Maps are textual, Human readable configuration Files you dont need to bother about writting a configuration file from scratch. zigmoyd have Command line tools for that automatically too. However its worth to know the structure of that file cause without knowing that you cant edit that file maually.

In a ORM Map one or more Tables that shares common connection attributes are Maped.
You can give an alias name to a table so that you dont need to even remember teh original name of that table. all teh works will be done through the alias Name you have choosen.
you can give alias names to columns of a Table o that you dont need to even remember the original name of that Column. all works will be done through the alias Name you have choosen.
you can mark a Column as readonly or writable. (e.g. auto incremented columns can be kept as readonly as you never write any data on those columns cause they are written automatically)
you can specify validation Rules That will be checked for [[validation]] before writting anything on that column which will auto filter the data whenever you try to write something. which leads to no no unexpected value in the database even if you forget form [[validation]] at submitting time.
You can specify some default values for a Column which will be used if no values specified. This is an example ORM Map. where I am mapping two Tables std with alias name Student and std_score with alias Name Marks. and std Table have a Column called syd_name which I'll use with an alias name Name and std_id column is auto Incremented so Its readonly. and you can see how the validation Filters are applied. and these two shares same Connection attribute dataConn (dicsussed in the next section). Zigmoyd commander is capable to generates these coiguration files by itself even with teh filters and Error messages.
```
connection as dataConn{
	}
	table std as Student{
			readonly std_id as Id{
			}
			writable std_name as Name{
					required:       Student's Name Must not be left Blank
					string:         Student's Name Must be a String
			}
	}
	table std_score as Marks{
			readonly id as Id{
			}
			writable student_id as StudentId{
					required:    StudentId Must not be left Blank
					int:         StudentId Must be an Integer
			}
			writable subject as Sub{
					required:       Subject Must not be left Blank
					string:         Subject Name must be a valid string
			}
			writable marks as Marks{
					optional:       __NULL__
					default:        0
					int:            Marks Obtained by the Student Must be an Integer
			}
	}
```
Zigmoyd has the ability to read your database and generate the ORM Maps. however it can be edited and tuned for better experience.

Now Lets see whats in the Connection attributes. In the Connection Block we are specifying dataConn as the commection which means use connection attributes from a file dataConn.con.ini.php which is stored in etc/conf.d Directory in your Project's Directory.
```
	driver = "mysql"
	database = "school"
	host = "localhost"
	user = "root"
	psw = "123456"
	
```
as the connection parameter is separated in another file more than one orm map can use the same Connection file.
Zigmoyd parses ORM Maps and generates ORM Classes. Each table has two Classes.
Table Level Class
Row Level Class these ORM Classes are stored into files called ormMapName.orm.php in apps/model/orm directory in your Project's Directory.and one file is created per ORM Map basis. so if the above mentioned ORM Map's name is studentOrm.orm.map.php ORM Classes for this Map will be created in a file Called studentOrm.orm.php which will be stored in projects/home/apps/model/orm Directory. and now the question is what will they contain. In studentOrm.orm.php there will be two Classes.
Student The Table Level Class.
StudentRowSet The Row Level Class.
Marks The Table Level Class.
MarksRowSet The Row Level Class. the table level Classes are the Database abstraction layers.

Function Documentation

load_orm_map	(	$	mapName,
		$	projectName
	)

load_orm_map() will accept the ormMapName and projectName parse the orm Map from /projects/projectName/etc/conf.d/ormMapName.orm.map.php generate the class on /projects/projectName/apps/model/orm/ormMapName.orm.php and then include that generated class file and returns the tableAlias className(s) as an numarically indexed array

Parameters:

$map_path

string

Returns:: unknown

Definition at line 149 of file class-gen.php.

Referenced by zigController::loadOrm().

00149                                              {
00150   $hwnd = new orm_CodeGen($mapName, $projectName);
00151   $hwnd->gen_class();
00152   return $hwnd->getClassList();
00153 }