DataObject_Landmark Class Reference

Inheritance diagram for DataObject_Landmark:

Inheritance graph
[legend]
Collaboration diagram for DataObject_Landmark:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 __clone ()
 staticGet ($k, $v=NULL)
 postGenerateForm (&$form)
 preGenerateForm ()
 table ()
 update ($do=false)
 find ($n=false)
 insert ()
 updateAreaFields ($objDataObject=false)
 getXyFromRequest ()

Public Attributes

 $__table = 'landmark'
 $gid
 $subtype
 $village
 $administra
 $name
 $the_geom
 $fb_addFormHeader = false
 $fb_hidePrimaryKey = false
 $fb_fieldLabels = NULL
 $fb_linkDisplayFields = array('name')
 $fb_submitText = 'Submit'
 $fb_fieldsToRender
 $fb_userEditableFields = array('subtype', 'name')

Detailed Description

DCMMS -- DC Maintenance Management System

Landmark.php - table definiton for landmark

Copyright (C) 2005, 2006 DORSCH Consult

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program 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 General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.


Member Function Documentation

DataObject_Landmark::__clone  ) 
 

DataObject_Landmark::find n = false  ) 
 

Find results, give precedence to x and y values from HTTP request.

Parameters:
boolean $n Fetch first result.
Returns:
int number of records found.
Todo:
Update query whenever Landmark table structure changes.

DataObject_Landmark::getXyFromRequest  ) 
 

Get x and y values from the request and store them as attributes. Calculate AdministrativeArea and Village.

Returns:
Nothing.

DataObject_Landmark::insert  ) 
 

Insert the current object attributes to the database. Remove virtual fields.

Returns:
mixed false on failure, int when auto increment or sequence used, otherwise true on success.

DataObject_Landmark::postGenerateForm &$  form  ) 
 

Add validation rules to form and fix Arabic layout.

Parameters:
&$form is the HTML Quickform to which the rules should be added.
Returns:
Nothing.

DataObject_Landmark::preGenerateForm  ) 
 

Localize labels and buttons.

Returns:
Nothing.

DataObject_Landmark::staticGet k,
v = NULL
 

DataObject_Landmark::table  ) 
 

Add x and y as virtual fields.

DataObject_Landmark::update do = false  ) 
 

Update database with current object attributes. Handle virtual fields.

Parameters:
object $do (optional) used to update only changed items.
Returns:
int rows affected or false on failure.

DataObject_Landmark::updateAreaFields objDataObject = false  ) 
 

Update the AdministrativeArea and Village fields if necessary.

Parameters:
object $objDataObject is the optional original DataObject to compare if the x or y values have changed.
Returns:
true on success or false on failure.
Check if x or y have changed


Member Data Documentation

DataObject_Landmark::$__table = 'landmark'
 

DataObject_Landmark::$administra
 

DataObject_Landmark::$fb_addFormHeader = false
 

Don't display a header above the form.

DataObject_Landmark::$fb_fieldLabels = NULL
 

Localized field labels.

DataObject_Landmark::$fb_fieldsToRender
 

Initial value:

 array('gid', 'subtype', 'administra', 'village',
    'name', 'x', 'y')
Fields that should actually be displayed.

DataObject_Landmark::$fb_hidePrimaryKey = false
 

Show primary key.

DataObject_Landmark::$fb_linkDisplayFields = array('name')
 

Use the name property when the class is used as a source for a select box.

DataObject_Landmark::$fb_submitText = 'Submit'
 

Text of the submit button (to be localized).

DataObject_Landmark::$fb_userEditableFields = array('subtype', 'name')
 

Fields that are editable through the form.

DataObject_Landmark::$gid
 

DataObject_Landmark::$name
 

DataObject_Landmark::$subtype
 

DataObject_Landmark::$the_geom
 

DataObject_Landmark::$village
 


The documentation for this class was generated from the following file:
Generated on Sat Jul 1 21:19:32 2006 for DCMMS by  doxygen 1.4.6-NO