forestAutoLoad.php

global function __autoload uses this class to create object of classes who were not included before

							
	/**
	 * constructor of forestAutoLoad class, to load class file
	 *
	 * @param string $p_s_name  class name
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access public
	 * @static no
	 */
	public function __construct($p_s_name)
	
	/**
	 * static helper function to check if a file is readable or exists
	 *
	 * @param string $p_s_filename  path of filename + filename
	 *
	 * @return bool  true - file is readable and exists, false - file does not exists
	 *
	 * @access public
	 * @static yes
	 */
	public static function IsReadable($p_s_filename)
							
						

forestBase.php

gathering class for all database interfaces an gateways who can be used by the script collection
whole database connectivity goes over this class
on initialization the developer can decide which gateway he wants to use

							
	/**
	 * constructor of forestBase class, set connection parameters to destination database
	 *
	 * @param string $p_s_baseGateway  base-gateway constant
	 * @param string $p_s_host  host value of database server
	 * @param string $p_s_datasource  database name
	 * @param string $p_s_user  database user
	 * @param string $p_s_password  database user's password
	 * @param bool $p_b_persistentConnection  standard true, optional
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access public
	 * @static no
	 */
	public function __construct($p_s_baseGateway = '', $p_s_host = '', $p_s_datasource = '', $p_s_user = '', $p_s_password = '', $p_b_persistentConnection = true)
	
	/**
	 * destructor of forestBase class, closes current connection
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access public
	 * @static no
	 */
	public function __destruct()
	
	/**
	 * function to send a query to the database and get a result set/answer/value
	 *
	 * @param forestSQLQuery $p_o_sqlQuery  sql query
	 * @param bool $p_b_transaction  use query in transaction mode
	 * @param bool $p_b_resultTwigList  convert result set into twig list
	 * @param bool $p_b_freeResult  free result memory
	 * @param integer $p_i_resultType  standard ASSOC - ASSOC, NUM, BOTH, OBJ, LAZY
	 *
	 * @return object  result set/twig list/row count
	 *
	 * @throws forestException if error occurs
	 * @access public
	 * @static no
	 */
	public function FetchQuery(\fPHP\Base\forestSQLQuery $p_o_sqlQuery, $p_b_transaction = false, $p_b_resultTwigList = true, $p_b_freeResult = false, $p_i_resultType = \fPHP\Base\forestBase::ASSOC)
	
	/**
	 * function to start transaction mode
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access public
	 * @static no
	 */
	public function ManualTransaction()
	
	/**
	 * function to roll back all transactions
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access public
	 * @static no
	 */
	public function ManualRollBack()
	 
	 /**
	 * function to end transaction mode
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access public
	 * @static no
	 */
	public function ManualCommit()
	 
	/**
	 * function to get id of last insert with this connection
	 *
	 * @return integer  id of last inserted record
	 *
	 * @throws forestException if error occurs
	 * @access public
	 * @static no
	 */
	public function LastInsertId()
							
						

forestBranch.php

abstract class for all branches
core functionality for rendering and editing records which are managed in the twig object
sub record editing support as well
all functions can be overwritten for user specific use case

							
	/**
	 * constructor of forestBranch class
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access public
	 * @static no
	 */
	public function __construct()
	
	/**
	 * individual branch-classes are calling this method to set next action
	 *
	 * @param string $p_s_nextAction  name of action
	 * @param string $p_s_nextActionAfterReload  name of action
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access protected
	 * @static no
	 */
	protected function SetNextAction($p_s_nextAction, $p_s_nextActionAfterReload = null)
	
	/**
	 * inits global filter mask for all branches and actions
	 *
	 * @return null
	 *
	 * @access protected
	 * @static no
	 */
	protected function InitFilter()
	
	
	/**
	 * clean up temp files and file records
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access protected
	 * @static no
	 */
	protected function CleanUpTempFiles()
	
	/**
	 * handle form key functionality
	 *
	 * @param string $p_s_formId  id of form element
	 * @param bool $p_b_postChain  true - init form key again for multiple step forms, false - normal behavior
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access protected
	 * @static no
	 */
	protected function HandleFormKey($p_s_formId = 'NULL', $p_b_postChain = false)
	
	/**
	 * handle honeypot fields functionality
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access protected
	 * @static no
	 */
	protected function HandleHoneypotFields()
	
	/**
	 * help function to create a new entry in the log
	 *
	 * @param string $p_s_message  message for log entry
	 * @param forestTwig $p_o_twig  record data which can be added to the log message
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access protected
	 * @static no
	 */
	protected function CreateLogEntry($p_s_message = null, \fPHP\Twigs\forestTwig $p_o_twig = null)
	
	
	/**
	 * generates landing page
	 *
	 * @return null
	 *
	 * @access protected
	 * @static no
	 */
	protected function GenerateLandingPage()
	
	
	/**
	 * handle login action
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access protected
	 * @static no
	 */
	protected function loginAction()
	
	/**
	 * handle logout action
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access protected
	 * @static no
	 */
	protected function logoutAction()
	
	/**
	 * handle sign up action
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access protected
	 * @static no
	 */
	protected function signUpAction()
	
	
	/**
	 * generates list view
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access protected
	 * @static no
	 */
	protected function GenerateListView()
	
	/**
	 * render column value for list view
	 *
	 * @param string $p_s_value  value which should be set, passed by reference
	 * @param string $p_s_formElement  forestFormElement type
	 * @param string $p_s_column  name of column/field
	 * @param forestTwig $p_o_record  record of type forestTwig
	 * @param string $p_s_dictionaryKey  name of dictionary key, syntax: fulltablename_fieldname
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access protected
	 * @static no
	 */
	protected function ListViewRenderColumnValue(&$p_s_value, $p_s_formElement, $p_s_column, $p_o_record, $p_s_dictionaryKey)
	
	/**
	 * create modal form for selecting hidden columns
	 *
	 * @param forestForm $p_o_form  form object where form elements will be added to add additonal columns to the view
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access protected
	 * @static no
	 */
	protected function GenerateHiddenColumnsModal(\fPHP\Forms\forestForm $p_o_form)
	
	/**
	 * render search form
	 *
	 * @param string $p_s_searchForm  form object of the search form
	 * @param string $p_s_searchTerms  string container to list all search terms as badges
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access protected
	 * @static no
	 */
	protected function RenderSearchForm(&$p_s_searchForm, &$p_s_searchTerms)
	
	
	/**
	 * generates flex view
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access protected
	 * @static no
	 */
	protected function GenerateFlexView()
	
	/**
	 * handle edit flex view action
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access protected
	 * @static no
	 */
	protected function EditFlexView()
	
	
	/**
	 * generates detail view
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access protected
	 * @static no
	 */
	protected function GenerateView()
	
	/**
	 * handle sub records display in detail view
	 *
	 * @param forestTwig $p_o_twig  head record where sub records will be queried from
	 * @param bool $p_b_readonly  true - show sub records without manipulation actions, false - normal view of all sub records
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access protected
	 * @static no
	 */
	protected function ListSubRecords(\fPHP\Twigs\forestTwig $p_o_twig, $p_b_readonly = false)
	
	
	/**
	 * handle view record action
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access protected
	 * @static no
	 */
	protected function ViewRecord()
	
	
	/**
	 * handle new record action
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access protected
	 * @static no
	 */
	protected function NewRecord()
	
	/**
	 * render modal form for new sub record
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access protected
	 * @static no
	 */
	protected function RenderNewSubRecordForm()
	
	/**
	 * add additional sub record field form elements to global post modal form
	 *
	 * @param subconstraintTwig $p_o_subconstraintTwig  sub constraint object where a lookup and form elements will be build dynamically
	 * @param subrecordsTwig $p_o_subrecordsTwig  record data of sub record to give values to form elements
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access protected
	 * @static no
	 */
	protected function AddAdditionalSubRecordFormElements(\fPHP\Twigs\subconstraintTwig $p_o_subconstraintTwig, \fPHP\Twigs\subrecordsTwig $p_o_subrecordsTwig = null)
	
	
	/**
	 * handle edit record action
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access protected
	 * @static no
	 */
	protected function EditRecord()
	
	/**
	 * render modal form for editing sub record
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access protected
	 * @static no
	 */
	protected function RenderEditSubRecordForm()
	
	/**
	 * write POST data into twig property fields
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access protected
	 * @static no
	 */
	protected function TransferPOST_Twig()
	
	/**
	 * handle FILES data
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access protected
	 * @static no
	 */
	protected function TransferFILES_Twig()
	
	/**
	 * undo created file records if there are any exceptions for new records or editing records
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access protected
	 * @static no
	 */
	protected function UndoFilesEntries()
	
	/**
	 * get validation rules of form element
	 *
	 * @param string $p_s_tableFieldUUID  uuid of tablefield which is part of validation rule primary key
	 * @param array $p_a_validationRules  array object where found validation rules will be inserted, passed by reference
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access protected
	 * @static no
	 */
	protected function GetValidationRules($p_s_tableFieldUUID, &$p_a_validationRules)
	
	/**
	 * handle replace file record action
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access protected
	 * @static no
	 */
	protected function replaceFileAction()
	
	/**
	 * handle restore file record action
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access protected
	 * @static no
	 */
	protected function restoreFileAction()
	
	
	/**
	 * handle checkout record action
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access protected
	 * @static no
	 */
	protected function checkoutAction()
	
	/**
	 * handle checkin record action
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access protected
	 * @static no
	 */
	protected function checkinAction()
	
	/**
	 * re-usable checkin function
	 *
	 * @param string $p_s_recordUUID  uuid of record we want ot checkin
	 * @param integer $p_i_checkinDone  amount of checkin'S which have been done, passed by reference
	 * @param forestTwig $p_o_headTwig  if record is a sub record or file record, we adding head record to the function as parameter
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access protected
	 * @static no
	 */
	protected function executeCheckin($p_s_recordUUID, &$p_i_checkinDone, $p_o_headTwig = null)
	
	
	/**
	 * handle delete record action
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access protected
	 * @static no
	 */
	protected function DeleteRecord()
	
	/**
	 * check twigfield relation to other elements
	 *
	 * @param forestTwig $p_o_twig 
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access protected
	 * @static no
	 */
	protected function CheckandCleanupRecordBeforeDeletion(\fPHP\Twigs\forestTwig $p_o_twig)
	
	/**
	 * re-usable delete record function
	 *
	 * @param forestTwig $p_o_record  record which will be deleted
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access protected
	 * @static no
	 */
	protected function executeDeleteRecord(\fPHP\Twigs\forestTwig $p_o_record)
	
	/**
	 * re-usable delete sub record function
	 *
	 * @param subrecordsTwig $p_o_subrecord  sub record which will be deleted
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access protected
	 * @static no
	 */
	protected function executeDeleteSubRecord(\fPHP\Twigs\subrecordsTwig $p_o_subrecord)
	
	/**
	 * re-usable delete file record function with history files option
	 *
	 * @param filesTwig $p_o_file  file record which will be deleted
	 * @param bool $p_b_deleteRecord  true - delete file record as well, false - only delete stored file
	 * @param bool $p_b_deleteHistoryFiles  true - check and delete all history file records as well, false - do not look for history file records
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access protected
	 * @static no
	 */
	protected function executeDeleteFileRecord(\fPHP\Twigs\filesTwig $p_o_file, $p_b_deleteRecord = true, $p_b_deleteHistoryFiles = false)
	
	/**
	 * handle action to change order of records, moving one record up
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access protected
	 * @static no
	 */
	protected function MoveUpRecord()
	
	/**
	 * handle action to change order of records, moving one record down
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access protected
	 * @static no
	 */
	protected function MoveDownRecord()
	
	/**
	 * handle upload actions from dropzone
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access protected
	 * @static no
	 */
	protected function fphp_uploadAction()
	
	/**
	 * handle upload delete actions from dropzone
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access protected
	 * @static no
	 */
	protected function fphp_upload_deleteAction()
	
	/**
	 * function to create and render a captcha picture
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access protected
	 * @static no
	 */
	protected function fphp_captchaAction()
	
	/**
	 * function to create a thumbnail of an stored image
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access protected
	 * @static no
	 */
	protected function fphp_imageThumbnailAction()
	
	/**
	 * function to update flex settings for a record element or general container
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access protected
	 * @static no
	 */
	protected function fphp_updateFlexAction()
							
						

forestData.php

forestData trait declaring general types of data and for reuse in all fphp classes and mods

							
trait forestData {
	/**
	 * write access to value, calling further __set method
	 *
	 * @param string $p_s_name  name of the property
	 * @param object $p_o_value  value which should be set
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access public
	 * @static no
	 */
	 public function __set($p_s_name, $p_o_value)

	/**
	 * read access to value, calling further __get method
	 *
	 * @param string $p_s_name  name of the property
	 *
	 * @return object  object value which is stored with the property
	 *
	 * @throws forestException if error occurs
	 * @access public
	 * @static no
	 */
	public function &__get($p_s_name)
	
	/**
	 * unset access to value, calling further __unset method
	 *
	 * @param string $p_s_name  name of the property
	 *
	 * @return null
	 *
	 * @access public
	 * @static no
	 */
	public function __unset($p_s_name)
}

	/**
	 * string data container
	 *
	 * @throws forestException if error occurs
	 * @access public
	 * @static no
	 */
	class forestString
	
	/**
	 * list data container
	 *
	 * @throws forestException if error occurs
	 * @access public
	 * @static no
	 */
	class forestList

	/**
	 * numericstring data container
	 *
	 * @throws forestException if error occurs
	 * @access public
	 * @static no
	 */
	class forestNumericString

	/**
	 * integer data container
	 *
	 * @throws forestException if error occurs
	 * @access public
	 * @static no
	 */
	class forestInt

	/**
	 * float data container
	 *
	 * @throws forestException if error occurs
	 * @access public
	 * @static no
	 */
	class forestFloat

	/**
	 * bool data container
	 *
	 * @throws forestException if error occurs
	 * @access public
	 * @static no
	 */
	class forestBool

	/**
	 * array data container
	 *
	 * @throws forestException if error occurs
	 * @access public
	 * @static no
	 */
	class forestArray

	/**
	 * object data container
	 *
	 * @throws forestException if error occurs
	 * @access public
	 * @static no
	 */
	class forestObject
	
	/**
	 * lookup data container
	 *
	 * @throws forestException if error occurs
	 * @access public
	 * @static no
	 */
	class forestLookup
							
						

forestDateInterval.php

date interval class with match validation of date interval strings

							
	/**
	 * constructor of forestDateInterval class
	 *
	 * @param string $p_s_dateinterval  date interval string, e.g. P2D, P1Y3M18DT5H16M33S, PT3H30S, ...
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access public
	 * @static no
	 */
	public function __construct($p_s_dateinterval = null)
	
	/**
	 * set date interval values with PHP DateInterval object
	 *
	 * @param DateInterval $p_o_dateInterval
	 *
	 * @return null
	 *
	 * @access public
	 * @static no
	 */
	public function SetDateInterval(\DateInterval $p_o_dateInterval)
	
	/**
	 * returns date interval string with translation
	 *
	 * @return string
	 *
	 * @access public
	 * @static no
	 */
	public function __toString()
							
						

forestDateTime.php

capsule class for creating DateTime-objects with own rules and easy uses

							
	/**
	 * constructor of forestDateTime class
	 *
	 * @param string $p_s_format  format string for DateTime
	 * @param integer $p_i_year
	 * @param integer $p_i_month
	 * @param integer $p_i_day
	 * @param integer $p_i_hour
	 * @param integer $p_i_minute
	 * @param integer $p_i_second
	 * @param string $p_o_timezone  timezone object
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access public
	 * @static no
	 */
	public function __construct($p_s_format = null, $p_i_year = 0, $p_i_month = 0 , $p_i_day = 0, $p_i_hour = 0, $p_i_minute = 0, $p_i_second = 0, $p_o_timezone = null)
	
	/**
	 * returns DateTime as string with format setting or DateTime::ATOM
	 *
	 * @return string  DateTime as string
	 *
	 * @access public
	 * @static no
	 */
	public function __toString()
	
	/**
	 * manual ToString-method for returning DateTime in another format than was set on creation of the object or DateTime::ATOM
	 *
	 * @param string $p_s_format  format string for DateTime
	 *
	 * @return string  DateTime as string
	 *
	 * @throws forestException if error occurs
	 * @access public
	 * @static no
	 */
	public function ToString($p_s_format = null)
	
	/**
	 * add interval to DateTime value
	 *
	 * @param integer $p_i_years
	 * @param integer $p_i_months
	 * @param integer $p_i_days
	 * @param integer $p_i_hours
	 * @param integer $p_i_minutes
	 * @param integer $p_i_seconds
	 *
	 * @return null
	 *
	 * @access public
	 * @static no
	 */
	public function AddDateInterval($p_i_years = 0, $p_i_months = 0 , $p_i_days = 0, $p_i_hours = 0, $p_i_minutes = 0, $p_i_seconds = 0)
	
	/**
	 * sub interval from DateTime value
	 *
	 * @param integer $p_i_years
	 * @param integer $p_i_months
	 * @param integer $p_i_days
	 * @param integer $p_i_hours
	 * @param integer $p_i_minutes
	 * @param integer $p_i_seconds
	 *
	 * @return null
	 *
	 * @access public
	 * @static no
	 */
	public function SubDateInterval($p_i_years = 0, $p_i_months = 0 , $p_i_days = 0, $p_i_hours = 0, $p_i_minutes = 0, $p_i_seconds = 0)
	
	/**
	 * convert integer seconds to DateTime value
	 *
	 * @param integer $p_i_seconds
	 *
	 * @return forestDateTime
	 *
	 * @access public
	 * @static yes
	 */
	public static function SecondsToDateTime($p_i_seconds = 0)
	
	/**
	 * convert unix timestamp to DateTime value
	 *
	 * @param integer $p_i_unixTimestmp
	 *
	 * @return forestDateTime
	 *
	 * @access public
	 * @static yes
	 */
	public static function UnixTimestampToDateTime($p_i_unixTimestmp = 0)
	
	/**
	 * get amount of days of a month, considering leap year too
	 *
	 * @param integer $p_i_month
	 * @param integer $p_i_year
	 *
	 * @return integer
	 *
	 * @access public
	 * @static yes
	 */
	public static function AmountDaysMonth($p_i_month = 0, $p_i_year = 0)
	
	/**
	 * check if year is a leap year
	 *
	 * @param integer $p_i_year
	 *
	 * @return bool  true - is leap year, false - is not leap year
	 *
	 * @access public
	 * @static yes
	 */
	public static function LeapYear($p_i_year = 0)
							
						

forestException.php

class for own exceptions getting exception-description from database table
distinguish between three exception types: error, warnung, message - all three types have their own ToString-behaviour

							
	/**
	 * constructor of forestException class, set exception content, dynamic values and error trigger flag
	 *
	 * @param object $p_o_content  exception content message
	 * @param array $p_a_values  array of values which should be inserted into exception message by sprintf2 helper function, usually dynamic values
	 * @param bool $p_b_triggerError  flag to use trigger_error php function
	 *
	 * @return object of type Exception
	 *
	 * @access public
	 * @static no
	 */
	public function __construct($p_o_content = null, $p_a_values = array(), $p_b_triggerError = false)
	
	/**
	 * __toString function returning created exception as string value, well formated
	 *
	 * @return string
	 *
	 * @access public
	 * @static no
	 */
	public function __toString()
							
						

forestFile.php

file class for creating and editing files on your own webspace

							
	/**
	 * access to amount of file lines
	 *
	 * @return integer  amount of file lines
	 *
	 * @access public
	 * @static no
	 */
	public function FileLines()
	
	/**
	 * constructor of forestFile class to read or create a file
	 *
	 * @param string $p_s_fullfilename  filename with full path
	 * @param bool $p_b_new  true - create new file, false - read file
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access public
	 * @static no
	 */
	public function __construct($p_s_fullfilename, $p_b_new = false)
	
	/**
	 * delete file which was opened by creating forestFile
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access public
	 * @static no
	 */
	public function DeleteFile()
	
	/**
	 * read a line from the file
	 *
	 * @param integer $p_i_line  file line number
	 *
	 * @return string  file line as string
	 *
	 * @throws forestException if error occurs
	 * @access public
	 * @static no
	 */
	public function ReadLine($p_i_line = 0)
	
	/**
	 * wrote a line to the file
	 *
	 * @param string $p_s_value  new file line as string
	 * @param integer $p_i_line  file line number
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access public
	 * @static no
	 */
	public function WriteLine($p_s_value, $p_i_line = 0)
	
	/**
	 * replace a line in the file
	 *
	 * @param string $p_s_value  new file line as string
	 * @param integer $p_i_line  file line number
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access public
	 * @static no
	 */
	public function ReplaceLine($p_s_value, $p_i_line)
	
	/**
	 * delete a line from the file
	 *
	 * @param integer $p_i_line  file line number
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access public
	 * @static no
	 */
	public function DeleteLine($p_i_line)
	
	/**
	 * replace full content of the file
	 *
	 * @param string $p_s_value  file content as string
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access public
	 * @static no
	 */
	public function ReplaceContent($p_s_value)
	
	/**
	 * truncate full content of the file
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access public
	 * @static no
	 */
	public function TruncateContent()
	
	/**
	 * create csv file in temporary directory with file name and random name suffix
	 *
	 * @param string $p_s_name  name of file which should be created
	 *
	 * @return string  filename of generate csv file
	 *
	 * @throws forestException if error occurs
	 * @access public
	 * @static yes
	 */
	public static function CreateTempFileCSV($p_s_name)
	
	/**
	 * create forestPHP file folder structure
	 *
	 * @param string $p_s_branch  name of branch where folder structure should be created
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access public
	 * @static yes
	 */
	public static function CreateFileFolderStructure($p_s_branch)
	
	/**
	 * remove a directory and all its sub-directories and files
	 *
	 * @param string $p_s_directory  path to directory
	 *
	 * @return null
	 *
	 * @access public
	 * @static yes
	 */
	public static function RemoveDirectoryRecursive($p_s_directory)
	
	/**
	 * copy a directory and all its sub-directories and files to a destination directory
	 *
	 * @param string $p_s_srcDirectory  path to source directory
	 * @param string $p_s_dstDirectory  path to destination directory
	 *
	 * @return null
	 *
	 * @access public
	 * @static yes
	 */
	public static function CopyRecursive($p_s_srcDirectory, $p_s_dstDirectory)
							
						

forestForm.php

class-collection for all necessary form data and settings
multiple tabs are possible for rendering, also modal form view is supported
most settings are based on json encoded strings stored in configuration files or in database records

							
class forestForm {
	/**
	 * constructor of forestForm class
	 *
	 * @param forestTwig $p_o_twig  forestTwig object to get tablefields and information to render the form for each tablefield
	 * @param bool $p_b_automatic  true - create a new forestForm object and generate form elements by twig object automtically, false - only create a new forestForm object
	 * @param bool $p_b_readonly  true - indicates that the form is in readonly mode, false - normal form
	 * @param bool $p_b_printFooter  true - indicates that the form has a footer, false - form has no footer
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access public
	 * @static no
	 */
	public function __construct(\fPHP\Twigs\forestTwig $p_o_twig, $p_b_automatic = false, $p_b_readonly = false, $p_b_printFooter = true)
	
	/**
	 * render the complete form with all its settings
	 *
	 * @return string
	 *
	 * @throws forestException if error occurs
	 * @access public
	 * @static no
	 */
	public function __toString()
	
	/**
	 * create standard modal form elements, by loading standard form formElement, submit and cancel button
	 *
	 * @param forestTwig $p_o_twig
	 * @param string $p_s_title  title of form
	 * @param bool $p_b_showSubmit  true - create submit button, false - do not create submit button
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access public
	 * @static no
	 */
	public function CreateModalForm(\fPHP\Twigs\forestTwig $p_o_twig, $p_s_title, $p_b_showSubmit = true)
	
	/**
	 * create standard delete modal form elements, by loading standard form formElement, submit and cancel button
	 *
	 * @param forestTwig $p_o_twig
	 * @param string $p_s_title  title of form
	 * @param string $p_s_description  description for delete form
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access public
	 * @static no
	 */
	public function CreateDeleteModalForm(\fPHP\Twigs\forestTwig $p_o_twig, $p_s_title, $p_s_description)
	
	/**
	 * add hidden form key field to form footer elements
	 *
	 * @return null
	 *
	 * @access public
	 * @static no
	 */
	public function AddFormKey()
	
	/**
	 * add hidden honeypot fields to form footer elements
	 *
	 * @param forestTwig $p_o_twig
	 *
	 * @return null
	 *
	 * @access public
	 * @static no
	 */
	public function AddHoneypotFields(\fPHP\Twigs\forestTwig $p_o_twig)
	
	/**
	 * get form element by form element id
	 *
	 * @param string $p_s_formId
	 *
	 * @return forestFormElement
	 *
	 * @access public
	 * @static no
	 */
	public function GetFormElementByFormId($p_s_formId)
	
	/**
	 * delete form element by form element id
	 *
	 * @param string $p_s_formId
	 *
	 * @return bool  true - form element has been deleted, false - form element has been not found
	 *
	 * @access public
	 * @static no
	 */
	public function DeleteFormElementByFormId($p_s_formId)
	
	/**
	 * add form element to form
	 *
	 * @param forestFormElement $p_o_formElement
	 * @param string $p_s_tabId  indicated on which tab the form element should be added
	 * @param bool $p_b_first  true - add as first element, false - just add to form element list
	 *
	 * @return bool  true - form element has been added, false - form element has been not added
	 *
	 * @access public
	 * @static no
	 */
	public function AddFormElement(\fPHP\Forms\forestFormElement $p_o_formElement, $p_s_tabId = 'general', $p_b_first = false)
}
	
class forestFormTab {
	/**
	 * constructor of forestFormTab class
	 *
	 * @param string $p_s_tabId  tab id for html tab element
	 * @param string $p_s_tabTitle  tab title for html tab element
	 * @param string $p_s_tabClass  tab class for html tab element
	 * @param string $p_b_printFooter  tab active class for html tab element
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access public
	 * @static no
	 */
	public function __construct($p_s_tabId = null, $p_s_tabTitle = null, $p_s_tabClass = null, $p_s_tabActiveClass = null)
	
	/**
	 * render the complete form tab with all its settings
	 *
	 * @return string
	 *
	 * @throws forestException if error occurs
	 * @access public
	 * @static no
	 */
	public function __toString()
	
	/**
	 * load forestFormTab class with settings from json object
	 *
	 * @param string $p_s_jsonDataSettings  json settings
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access public
	 * @static no
	 */
	public function loadJSON($p_s_jsonDataSettings)
	
	/**
	 * check if all necessary settings for forestFormTab are set
	 *
	 * @param boool $p_b_extended  true - check tab class and tab active class, false - check only tab id and tab title
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access public
	 * @static no
	 */
	public function CheckIsset($p_b_extended = false)
	
	/**
	 * get form element by form element id
	 *
	 * @param string $p_s_formId
	 *
	 * @return forestFormElement
	 *
	 * @access public
	 * @static no
	 */
	public function GetFormElementByFormId($p_s_formId)
	
	/**
	 * delete form element by form element id
	 *
	 * @param string $p_s_formId
	 *
	 * @return bool  true - form element has been deleted, false - form element has been not found
	 *
	 * @access public
	 * @static no
	 */
	public function DeleteFormElementByFormId($p_s_formId)
	
	/**
	 * add form element to form
	 *
	 * @param forestFormElement $p_o_formElement
	 * @param bool $p_b_first  true - add as first element, false - just add to form element list
	 *
	 * @return bool  true - form element has been added, false - form element has been not added
	 *
	 * @access public
	 * @static no
	 */
	public function AddFormElement(\fPHP\Forms\forestFormElement $p_o_formElement, $p_b_first = false)
}
							
						

forestFormElement.php

class collection for rendering all usable html form elements
all necessary properties can be changed and will be considered in the __toString-methods
its a full collection of these properties

							
class forestFormElement {
	/**
	 * access to forestFormElement type value
	 *
	 * @return string  forestFormElement type
	 *
	 * @access public
	 * @static no
	 */
	public function getType()
	
	/**
	 * access to forestFormElement formelement value
	 *
	 * @return forestFormElement
	 *
	 * @access public
	 * @static no
	 */
	public function getFormElement()
	
	/**
	 * constructor of forestFormElement class
	 *
	 * @param string $p_s_type  string value as constant pointer to desired form elements
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access public
	 * @static no
	 */
	public function __construct($p_s_type)
	
	/**
	 * render form element
	 *
	 * @return string
	 *
	 * @access public
	 * @static no
	 */
	public function __toString()
	
	/**
	 * bridge function to access form element properties
	 *
	 * @param string $p_s_name  name of property
	 *
	 * @return forestFormElement Property
	 *
	 * @access public
	 * @static no
	 */
	public function __get($p_s_name)
	
	/**
	 * bridge function to set form element properties
	 *
	 * @param string $p_s_name  name of property
	 * @param object $p_o_value  property value
	 *
	 * @return null
	 *
	 * @access public
	 * @static no
	 */
	public function __set($p_s_name, $p_o_value)
	
	/**
	 * load forestFormElement class with settings from json object
	 *
	 * @param string $p_s_jsonDataSettings  json settings
	 * @param integer $p_i_branchId  deviating branch id
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access public
	 * @static no
	 */
	public function loadJSON($p_s_jsonDataSettings, $p_i_branchId = null)
	
	/**
	 * replace forestFormElement json settings text placeholders with translation values
	 *
	 * @param string $p_s_jsonDataSettings  json settings, passed by reference
	 * @param integer $p_i_branchId  deviating branch id
	 *
	 * @return null
	 *
	 * @access public
	 * @static yes
	 */
	public static function JSONSettingsMultilanguage(&$p_s_jsonDataSettings, $p_i_branchId = null)
}

abstract class forestFormGeneralAttributes
abstract class forestFormInputAttributes extends forestFormGeneralAttributes
class forestFormValidationRule
class forestFormObject extends forestFormGeneralAttributes
class forestFormElementText extends forestFormInputAttributes
class forestFormElementList extends forestFormInputAttributes
class forestFormElementHidden extends forestFormInputAttributes
class forestFormElementPassword extends forestFormInputAttributes
class forestFormElementFile extends forestFormInputAttributes
class forestFormElementRadio extends forestFormInputAttributes
class forestFormElementCheckbox extends forestFormInputAttributes
class forestFormElementColor extends forestFormInputAttributes
class forestFormElementEmail extends forestFormInputAttributes
class forestFormElementUrl extends forestFormInputAttributes
class forestFormElementDate extends forestFormInputAttributes
class forestFormElementDateTimeLocal extends forestFormInputAttributes
class forestFormElementMonth extends forestFormInputAttributes
class forestFormElementNumber extends forestFormInputAttributes
class forestFormElementRange extends forestFormInputAttributes
class forestFormElementSearch extends forestFormInputAttributes
class forestFormElementPhone extends forestFormInputAttributes
class forestFormElementTime extends forestFormInputAttributes
class forestFormElementWeek extends forestFormInputAttributes
class forestFormElementTextArea extends forestFormGeneralAttributes
class forestFormElementSelect extends forestFormGeneralAttributes
class forestFormElementDescription extends forestFormGeneralAttributes
class forestFormElementButton extends forestFormInputAttributes
class forestFormElementDropzone extends forestFormGeneralAttributes
class forestFormElementRichtext extends forestFormGeneralAttributes
class forestFormElementCaptcha extends forestFormInputAttributes
							
						

forestGlobals.php

singleton class for temporary values and communication
between different classes and build-steps in the script collection

							
	/**
	 * constructor of forestGlobals class
	 *
	 * @return null
	 *
	 * @access public
	 * @static no
	 */
	public function __construct()
	
	/**
	 * method to create singleton object
	 *
	 * @return null
	 *
	 * @access public
	 * @static yes
	 */
	public static function init()
	
	/**
	 * prevent cloning singleton object
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access public
	 * @static no
	 */
	public function __clone()
	
	/**
	 * get forestSort object stored in global list by key
	 *
	 * @param string $p_s_key  index of forestSort object
	 *
	 * @return forestSort
	 *
	 * @throws forestException if error occurs
	 * @access public
	 * @static no
	 */
	public function GetSort($p_s_key)
	
	/**
	 * backup forestSort object list
	 *
	 * @return null
	 *
	 * @access public
	 * @static no
	 */
	public function BackupSorts()
	
	/**
	 * restore forestSort object list
	 *
	 * @return null
	 *
	 * @access public
	 * @static no
	 */
	public function RestoreSorts()
	
	/**
	 * backup forestLimit object list
	 *
	 * @return null
	 *
	 * @access public
	 * @static no
	 */
	public function BackupLimit()
	
	/**
	 * restore forestLimit object list
	 *
	 * @return null
	 *
	 * @access public
	 * @static no
	 */
	public function RestoreLimit()
	
	/**
	 * backup stdclass object list
	 *
	 * @return null
	 *
	 * @access public
	 * @static no
	 */
	public function BackupTemp()
	
	/**
	 * restore stdclass object list
	 *
	 * @return null
	 *
	 * @access public
	 * @static no
	 */
	public function RestoreTemp()
	
	/**
	 * build a tree of the branch-structure which is often used by functions and navigation processes
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access public
	 * @static no
	 */
	public function BuildBranchTree()
	
	/**
	 * this method is very important to get access to other classes which are not in the current url directory
	 * after this method has been called you can try to call a class which is in the parameter's branch url directory
	 *
	 * @param string $p_s_branch  name of branch
	 * @param string $p_s_action  name of action
	 * @param array $p_a_parameters  parameters array object
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access public
	 * @static no
	 */
	public function SetVirtualTarget($p_s_branch, $p_s_action = null, $p_a_parameters = null)
	
	/**
	 * load all translations from database
	 * thus it is not necessary to query always the database for each label, text, etc.
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access public
	 * @static no
	 */
	public function ListTranslations()
	
	/**
	 * get a translation by name
	 *
	 * @param string $p_s_name  key name of translation
	 * @param integer $p_i_branch_id  id of branch
	 *
	 * @return string  translation string or NO_CAPTION
	 *
	 * @throws forestException if error occurs
	 * @access public
	 * @static no
	 */
	public function GetTranslation($p_s_name, $p_i_branch_id = null)
	
	/**
	 * load all table records from database
	 * load all table records with tablefields from database
	 * query all sub-constraints from database
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access public
	 * @static no
	 */
	public function ListTables()
	
	/**
	 * fast access to a tablefield entry in global dictionary by tablefield uuid
	 *
	 * @return forestTAbleFieldProperties  fPHP-class with many information to a tablefield
	 *
	 * @throws forestException if error occurs
	 * @access public
	 * @static no
	 */
	public function GetTablefieldsDictionaryByUUID($p_s_uuid)
	
	/**
	 * load all user names from database, after that user names can be called by uuid with function GetUserNameByUUID
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access public
	 * @static no
	 */
	public function ListUserNames()
	
	/**
	 * fast access to a user name in global dictionary by user uuid
	 *
	 * @return string  user name or empty '-' string
	 *
	 * @throws forestException if error occurs
	 * @access public
	 * @static no
	 */
	public function GetUserNameByUUID($p_s_uuid)
							
						

forestIterator.php

iterator class for forestObjectList-class
necessary for iteration of a list-objects in a foreach-loop

							
	/**
	 * constructor of forestIterator class
	 *
	 * @param array $p_a_value  array object
	 *
	 * @return null
	 *
	 * @access public
	 * @static no
	 */
    public function __construct($p_a_value)
	
	/**
	 * set index back to zero
	 *
	 * @return null
	 *
	 * @access public
	 * @static no
	 */
    public function rewind()
	
	/**
	 * get current array object based on internal index value using keys of array
	 *
	 * @return object
	 *
	 * @access public
	 * @static no
	 */
    public function current()
	
	/**
	 * get current key based on internal index value
	 *
	 * @return object  key value
	 *
	 * @access public
	 * @static no
	 */
    public function key()
	
	/**
	 * get next array object based on internal index value using keys of array
	 *
	 * @return object  object value if there is a next object, false if there is no next object in list
	 *
	 * @access public
	 * @static no
	 */
    public function next()
	
	/**
	 * check if there is a valid object behind a key
	 *
	 * @return bool  true - object set behind key, false - no object set behind key
	 *
	 * @access public
	 * @static no
	 */
    public function valid()
							
						

forestLimit.php

class for holding information about page limit of current page view

							
	/**
	 * constructor of forestLimit class
	 *
	 * @return null
	 *
	 * @access public
	 * @static no
	 */
	public function __construct()
	
	/**
	 * returns limit pagination
	 *
	 * @return string  html limit pagination element
	 *
	 * @throws forestException if error occurs
	 * @access public
	 * @static no
	 */
	public function __toString()
							
						

forestLink.php

class generate link-element out of array-parameters with static functions

							
	/**
	 * static method to create a url for html a link value
	 *
	 * @param string $p_s_branch  name of branch
	 * @param string $p_s_action  name of action
	 * @param string $p_a_parameters  parameters, syntax: 'key' => 'value', 'key' => 'value', ...
	 * @param string $p_s_anchor  value for html anchor
	 *
	 * @return string  valid url string
	 *
	 * @throws forestException if error occurs
	 * @access public
	 * @static yes
	 */
	public static function Link($p_s_branch = null, $p_s_action = null, array $p_a_parameters = null, $p_s_anchor = null)
							
						

forestLookupData.php

class to capsulate lookup result data
storing these objects in a global dictionary will reduce database record access for one session

							
	/**
	 * constructor of forestLookupData class
	 *
	 * @param string $p_s_table  name of table
	 * @param array $p_a_primary  primary key fields
	 * @param array $p_a_label  tablefields which will be shown if lookup will be read an isset
	 * @param array $p_a_filter  filter commands - syntax: 'FieldName' => 'FieldValue' or '!1FieldName' => 'FieldValue', '!2FieldName' => 'FieldValue', '!3FieldName' => 'FieldValue'
	 * @param string $p_s_concat  conat string how the label fields will be glued together
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access public
	 * @static no
	 */
	public function __construct($p_s_table, array $p_a_primary, array $p_a_label, array $p_a_filter = array(), $p_s_concat = ' - ')
	
	/**
	 * function call to overwrite lookup data
	 *
	 * @param string $p_s_functionName  name of function
	 * @param array $p_a_arguments  argument object which must be of type forestLookupData
	 *
	 * @return null
	 *
	 * @access public
	 * @static no
	 */
	public function __call($p_s_functionName, $p_a_arguments)
	
	/**
	 * return field values of label fields in settings with concat string setting
	 * result wiill be stored in global dictionary, so that it must not be queried again
	 *
	 * @return string
	 *
	 * @throws forestException if error occurs
	 * @access public
	 * @static no
	 */
	public function __toString()
	
	/**
	 * this function is important to use lookup data with web select control or other option based controls
	 *
	 * @return array  options array with syntax array('label fields with concat string setting' => 'primary key'
	 *
	 * @throws forestException if error occurs
	 * @access public
	 * @static no
	 */
	public function CreateOptionsArray()
							
						

forestMaintenance.php

maintenance routine if any main exception occurs during runtime

forestNavigation.php

class for render the navigation-bar
the navigation-bar itself is a linked list of navigation-nodes

							
	/**
	 * constructor of forestNavigation class
	 *
	 * @return null
	 *
	 * @access public
	 * @static no
	 */
	public function __construct()
	
	/**
	 * initialisation function to get navigation settings from database and creation of all navigation nodes
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access public
	 * @static no
	 */
	public function InitNavigation()
	
	/**
	 * main render function
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access public
	 * @static no
	 */
	public function RenderNavigation()
	
	/**
	 * function to render a landing page
	 *
	 * @return string  contains all html nodes to show a landing page
	 *
	 * @throws forestException if error occurs
	 * @access public
	 * @static no
	 */
	public function RenderLandingPage()
							
						

forestNavigationNode.php

class holding navigation information
action and parameter properties are not necessary to be set at this point of development

							
	/**
	 * constructor of forestNavigationNode class
	 *
	 * @return null
	 *
	 * @access public
	 * @static no
	 */
	public function __construct()
	
	/**
	 * function to render navigation node for landing page
	 *
	 * @return string  navigation node
	 *
	 * @access public
	 * @static no
	 */
	public function RenderForLandingPage()
	
	/**
	 * function to render navigation node
	 *
	 * @return string  navigation node
	 *
	 * @throws forestException if error occurs
	 * @access public
	 * @static no
	 */
	public function __toString()
							
						

forestObjectList.php

simple class for using collections
creating lists of objects with array, index can be of any type

							
	/**
	 * property function count
	 *
	 * @return integer  amount of objects in list
	 *
	 * @access public
	 * @static no
	 */
	public function Count()
	
	/**
	 * property function firstkey to get the first element by sorting keys with array_keys
	 *
	 * @return object  first object in list
	 *
	 * @access public
	 * @static no
	 */
	public function FirstKey()
	
	/**
	 * property function lastkey to get the last element by sorting keys with array_keys
	 *
	 * @return object  last object in list
	 *
	 * @access public
	 * @static no
	 */
	public function LastKey()
	
	/**
	 * on initializing the object-list, we need the class-name of the object
	 * so we can be sure in our list are only objects of the same type/class later
	 *
	 * @param string $p_s_objectClassName  class name of objects which will be accepted to be added to the list
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access public
	 * @static no
	 */
	public function __construct($p_s_objectClassName)
	
	/**
	 * add an object to array list
	 * controlling the class-name to be sure in array list are only objects of the same type/class
	 *
	 * @param object $p_o_object  object which will be stored in list
	 * @param string $p_s_key  key name for index, optional
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access public
	 * @static no
	 */
	public function Add($p_o_object, $p_s_key = null)
	
	/**
	 * add an object to array list as first element
	 * controlling the class-name to be sure in array list are only objects of the same type/class
	 *
	 * @param object $p_o_object  object which will be stored in list
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access public
	 * @static no
	 */
	public function AddFirst($p_o_object)
	
	/**
	 * delete an object in the list
	 * controlling that the element exists in array list
	 *
	 * @param string $p_s_key  key name for index, optional
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access public
	 * @static no
	 */
	public function Del($p_s_key = null)
	
	/**
	 * using magic method to get array list object or for iteration in a foreach-loop
	 *
	 * @param string $p_s_key  key name for index, optional
	 *
	 * @return object  object in list found by index key
	 *
	 * @throws forestException if error occurs
	 * @access public
	 * @static no
	 */
	public function __get($p_s_key = null)
	
	/**
	 * method to find out if object exists by key
	 *
	 * @param string $p_s_key  key name for index
	 *
	 * @return bool  true - object exists in list, false - object does not exists in list
	 *
	 * @access public
	 * @static no
	 */
	public function Exists($p_s_key)
	
	/**
	 * method to find out if array has element equal to parameter value
	 *
	 * @param object $p_o_value  object for comparsion
	 *
	 * @return bool  true - object exists in list, false - object does not exists in list
	 *
	 * @access public
	 * @static no
	 */
	public function Has($p_o_value)
	
	/**
	 * abstract necessary method from IteratorAggregate-Interface to create an external Iterator
	 *
	 * @return forestIterator  instance of forestIterator to loop through list
	 *
	 * @access public
	 * @static no
	 */
	public function getIterator()
	
	/**
	 * method to sort objects in the list, by using an individual function named CompareObjects
	 *
	 * @return null
	 *
	 * @access public
	 * @static no
	 */
	public function SortObjects()
							
						

forestPHP.php

central control class of forestPHP framework for fetch-content and render-content

							
	/**
	 * constructor of forestPHP framework
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access public
	 * @static no
	 */
	public function __construct()
	
	/**
	 * init function to separate fetching content and rendering output of forestPHP framework
	 *
	 * @return null
	 *
	 * @access public
	 * @static no
	 */
	public function init()
							
						

forestRootBranch.php

adminisration class for handling all adminstrative use cases for forestBranch and forestTwig objects

							
	/**
	 * render root menu for root actions for every branch
	 *
	 * @return string  string value with root menu part for navigation
	 *
	 * @throws forestException if error occurs
	 * @access protected
	 * @static no
	 */
	protected function RenderRootMenu()
	
	
	/**
	 * handle view identifier action
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access protected
	 * @static no
	 */
	protected function viewIdentifierAction()
	
	/**
	 * handle new identifier record action
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access protected
	 * @static no
	 */
	protected function newIdentifierAction()
	
	/**
	 * handle edit identifier record action
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access protected
	 * @static no
	 */
	protected function editIdentifierAction()
	
	/**
	 * handle delete identifier record action
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access protected
	 * @static no
	 */
	protected function deleteIdentifierAction()
	
	
	/**
	 * handle new branch record action
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access protected
	 * @static no
	 */
	protected function newBranchAction()
	
	/**
	 * handle edit branch record action
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access protected
	 * @static no
	 */
	protected function editBranchAction()
	
	/**
	 * handle view branch record action
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access protected
	 * @static no
	 */
	protected function viewBranchAction()
	
	/**
	 * handle action to change order of branch record in navigation, moving one record up
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access protected
	 * @static no
	 */
	protected function moveUpBranchAction()
	
	/**
	 * handle action to change order of branch record in navigation, moving one record down
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access protected
	 * @static no
	 */
	protected function moveDownBranchAction()
	
	/**
	 * handle delete branch record action
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access protected
	 * @static no
	 */
	protected function deleteBranchAction()


	/**
	 * handle new action record action
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access protected
	 * @static no
	 */
	protected function newActionAction()

	/**
	 * handle edit action record action
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access protected
	 * @static no
	 */
	protected function editActionAction()
	
	/**
	 * handle delete action record action
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access protected
	 * @static no
	 */
	protected function deleteActionAction()


	/**
	 * handle new twig record action
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access protected
	 * @static no
	 */
	protected function newTwigAction()

	/**
	 * handle edit twig record action
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access protected
	 * @static no
	 */
	protected function editTwigAction()
	
	/**
	 * handle view twig record action
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access protected
	 * @static no
	 */
	protected function viewTwigAction()
	
	/**
	 * handle transfer twig recorrd action
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access protected
	 * @static no
	 */
	protected function transferTwigAction()
	
	/**
	 * handle truncate twig record action
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access protected
	 * @static no
	 */
	protected function truncateTwigAction()
	
	
	/**
	 * truncate execution of a twig
	 *
	 * @param tableTwig $p_o_table  table record of table sys_fphp_table which will be truncated
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access protected
	 * @static no
	 */
	protected function executeTruncateTwig(\fPHP\Twigs\tableTwig $p_o_table)
	
	/**
	 * handle delete twig record action
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access protected
	 * @static no
	 */
	protected function deleteTwigAction()
	
	/**
	 * handle sub records display in detail view
	 *
	 * @param tableTwig $p_o_table  table record of table sys_fphp_table where all properties will be queried and shown within a modal form
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access protected
	 * @static no
	 */
	protected function ListTwigProperties(\fPHP\Twigs\tableTwig $p_o_twig)
	
	/**
	 * function to update twig file of current branch with current tablefields and twig settings
	 *
	 * @param tableTwig $p_o_table  table record of table sys_fphp_table to update the twig file in ./twigs/
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access protected
	 * @static no
	 */
	protected function doTwigFile(\fPHP\Twigs\tableTwig $p_o_tableTwig)
	
	
	/**
	 * handle new twig tablefield record action
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access protected
	 * @static no
	 */
	protected function newTwigFieldAction()
	
	/**
	 * handle edit twig tabelfield record action
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access protected
	 * @static no
	 */
	protected function editTwigFieldAction()
	
	/**
	 * handle delete twig tabelfield record action
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access protected
	 * @static no
	 */
	protected function deleteTwigFieldAction()
	
	/**
	 * check twigfield relation to other elements
	 *
	 * @param tableTwig $p_o_table  table record of table sys_fphp_table
	 * @param tablefieldTwig $p_o_tablefield  tablefield record of table sys_fphp_tablefield
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access protected
	 * @static no
	 */
	protected function checkTwigFieldBeforeDeletion(\fPHP\Twigs\tableTwig $p_o_table, \fPHP\Twigs\tablefieldTwig $p_o_tablefield)
	
	/**
	 * check twigfield relation to other elements
	 *
	 * @param tableTwig $p_o_table  table record of table sys_fphp_table, passed by reference
	 * @param tablefieldTwig $p_o_tablefield  tablefield record of table sys_fphp_tablefield
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access protected
	 * @static no
	 */
	protected function cleanupTwigFieldAfterDeletion(\fPHP\Twigs\tableTwig &$p_o_table, \fPHP\Twigs\tablefieldTwig $p_o_tablefield)
	
	/**
	 * handle action to change order of twig tablefield records, moving one record up
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access protected
	 * @static no
	 */
	protected function moveUpTwigFieldAction()
	
	/**
	 * handle action to change order of twig tablefield records, moving one record down
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access protected
	 * @static no
	 */
	protected function moveDownTwigFieldAction()
	
	/**
	 * handle view twig tablefield record action
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access protected
	 * @static no
	 */
	protected function viewTwigFieldAction()
	
	/**
	 * handle new translation record action for twig
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access protected
	 * @static no
	 */
	protected function newTranslationAction()

	/**
	 * handle edit translation record action for twig
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access protected
	 * @static no
	 */
	protected function editTranslationAction()
	
	/**
	 * handle delete translation record action for twig
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access protected
	 * @static no
	 */
	protected function deleteTranslationAction()


	/**
	 * handle new unique record action for twig
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access protected
	 * @static no
	 */
	protected function newUniqueAction()

	/**
	 * handle edit unique record action for twig
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access protected
	 * @static no
	 */
	protected function editUniqueAction()
	
	/**
	 * handle delete unique record action for twig
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access protected
	 * @static no
	 */
	protected function deleteUniqueAction()


	/**
	 * handle new sort order record action for twig
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access protected
	 * @static no
	 */
	protected function newSortAction()

	/**
	 * handle edit sort order record action for twig
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access protected
	 * @static no
	 */
	protected function editSortAction()
	
	/**
	 * handle delete sort order record action for twig
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access protected
	 * @static no
	 */
	protected function deleteSortAction()


	/**
	 * handle new twig sub constraint record action
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access protected
	 * @static no
	 */
	protected function newSubConstraintAction()

	/**
	 * handle edit twig sub constraint record action
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access protected
	 * @static no
	 */
	protected function editSubConstraintAction()
	
	/**
	 * handle action to change order of sub constraint records, moving one record up
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access protected
	 * @static no
	 */
	protected function moveUpSubConstraintAction()
	
	/**
	 * handle action to change order of sub constraint records, moving one record down
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access protected
	 * @static no
	 */
	protected function moveDownSubConstraintAction()
	
	/**
	 * handle delete twig sub constraint record action
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access protected
	 * @static no
	 */
	protected function deleteSubConstraintAction()

	/**
	 * check twigfield relation to other elements
	 *
	 * @param tableTwig $p_o_table  table record of table sys_fphp_table
	 * @param subconstraintTwig $p_o_subconstraint  sub contraint record of table sys_fphp_subcontraint
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access protected
	 * @static no
	 */
	protected function checkSubConstraintBeforeDeletion(\fPHP\Twigs\tableTwig $p_o_table, \fPHP\Twigs\subconstraintTwig $p_o_subconstraint)
	
	
	/**
	 * handle new twig validation rule record action
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access protected
	 * @static no
	 */
	protected function newValidationRuleAction()

	/**
	 * handle edit twig validation rule record action
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access protected
	 * @static no
	 */
	protected function editValidationRuleAction()
	
	/**
	 * handle delete twig validation rule record action
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access protected
	 * @static no
	 */
	protected function deleteValidationRuleAction()
							
						

forestSecurity.php

main class for security information
holding session values, user information, user rights and static functions for fphp framework security

							
	/**
	 * constructor of forestSecurity class
	 *
	 * @param bool $p_b_debug  flag to show debug information
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access public
	 * @static no
	 */
	public function __construct($p_b_debug = false)
	
	/**
	 * init function of forestSecurity class, handling session records, guest and user access
	 *
	 * @param bool $p_b_debug  flag to show debug information
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access public
	 * @static no
	 */
	public function init($p_b_debug = false)
	
	/**
	 * synchronize data in object list with $_SESSION array
	 *
	 * @param bool $p_b_debug  flag to show debug information
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access public
	 * @static no
	 */
	public function SyncSessionData($p_b_debug = false)
	
	/**
	 * list permission records for user and save them in internal object twig list
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access public
	 * @static no
	 */
	public function ListUserPermissions()
	
	/**
	 * check if permission records for current branch/action access are available for guest or user
	 *
	 * @param string $p_s_branch  name of branch
	 * @param string $p_s_action  name of action
	 *
	 * @return bool  true - user/guest has permission, false - user/guest has no permission
	 *
	 * @throws forestException if error occurs
	 * @access public
	 * @static no
	 */
	public function CheckUserPermission($p_s_branch = null, $p_s_action = null)
	
	/**
	 * logout function and cleanup
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access public
	 * @static no
	 */
	public function Logout()
	
	/**
	 * delete expired guest and user session records
	 *
	 * @param bool $p_b_debug  flag to show debug information
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access public
	 * @static no
	 */
	public function DeleteExpiredSessions($p_b_debug = false)
	
	/**
	 * generates uuid with php-function uniqid and '-'-delimiter
	 *
	 * @return string  uuid as string value
	 *
	 * @throws forestException if error occurs
	 * @access public
	 * @static no
	 */
	public function GenUUID()
	
	/**
	 * generates random hash string
	 *
	 * @return string  random hash string
	 *
	 * @throws forestException if error occurs
	 * @access public
	 * @static no
	 */
	public function GenRandomHash()
	
	/**
	 * generates hash string with sha512-algorithm
	 *
	 * @return string  random hash string
	 *
	 * @throws forestException if error occurs
	 * @access public
	 * @static no
	 */
	public function HashString(&$p_s_value, $p_s_salt, $p_i_loop)
	
	/**
	 * generates random character for captcha image
	 *
	 * @param integer $p_i_strength  how many times a random character should be generated with mt_rand function
	 *
	 * @return char  random character
	 *
	 * @throws forestException if error occurs
	 * @access public
	 * @static no
	 */
	public function GenerateCaptchaCharacter($p_i_strength = 10)
							
						

forestSort.php

class for holding information about sorting columns of current page view

							
	/**
	 * constructor of forestSort class
	 *
	 * @param string $p_s_column  name of sql column/field
	 * @param bool $p_b_direction  true - ascending, false - descending
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access public
	 * @static no
	 */
	public function __construct($p_s_column, $p_b_direction)
	
	/**
	 * returns sort link button
	 *
	 * @return string  html sort link button
	 *
	 * @throws forestException if error occurs
	 * @access public
	 * @static no
	 */
	public function __toString()
	
	/**
	 * alternative call of returning sort link with title parameter
	 *
	 * @return string  html sort link button
	 *
	 * @access public
	 * @static no
	 */
	public function ToString($p_s_columnName)
							
						

forestSQLQuery.php

class collection for generating one SQL-Query in an object-oriented way
this helps for object-oriented access on database-tables
for more information please read the documentation

							
	class forestSQLQuery
	
	/**
	 * constructor of forestSQLQuery class, set query parameters like base-gateway, type and table
	 *
	 * @param string $p_s_baseGateway  base-gateway constant
	 * @param string $p_s_type  type of sql query - SELECT, INSERT, UPDATE, DELETE, TRUNCATE, CREATE, DROP, ALTER
	 * @param string $p_s_table  table name
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access public
	 * @static no
	 */
	public function __construct($p_s_baseGateway, $p_s_type, $p_s_table)
	
	/**
	 * __toString function returning created sql query as string value
	 *
	 * @return string
	 *
	 * @access public
	 * @static no
	 */
	public function __toString()
	
	/**
	 * function to get sql query object
	 *
	 * @return forestSQLQueryAbstract or forestString
	 *
	 * @access public
	 * @static no
	 */
	public function GetQuery()
	
	/**
	 * function to set sql query as string value manually
	 *
	 * @return string
	 *
	 * @access public
	 * @static no
	 */
	public function SetQuery($p_s_queryString)
	
	/**
	 * transpose general column type to base-gateway defined column type and further information for query execution
	 *
	 * @param string $p_s_baseGateway  base-gateway constant
	 * @param string $p_s_sqlType  type of sql column, based on values in table sys_fphp_sqltype
	 * @param string $p_s_columnType  transposed column type, passed by reference
	 * @param integer $p_i_columnLength  transposed column length, passed by reference
	 * @param integer $p_i_columnDecimalLength  transposed column decimal length, passed by reference
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access public
	 * @static yes
	 */
	public static function ColumnTypeAllocation($p_s_baseGateway, $p_s_sqlType, &$p_s_columnType, &$p_i_columnLength, &$p_i_columnDecimalLength)
	
	/**
	 * transpose general constraint type to base-gateway defined constraint type and further information for query execution
	 *
	 * @param string $p_s_baseGateway  base-gateway constant
	 * @param string $p_s_constraintType  constraint type of sql column
	 * @param string $p_s_outConstraintType  transposed constraint type, passed by reference
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access public
	 * @static yes
	 */
	public static function ConstraintTypeAllocation($p_s_baseGateway, $p_s_constraintType, &$p_s_outConstraintType)
	
	abstract class forestSQLQueryAbstract
	
	/**
	 * important parsing function, preventing SQL-Injection, formatting date values, etc
	 *
	 * @param string $p_s_value  value of a sql field/column
	 *
	 * @return string  returning checked and edited sql field/column value
	 *
	 * @throws forestException if error occurs
	 * @access public
	 * @static no
	 */
	public function ParseValue($p_s_value)
	
	class forestSQLSelect
	class forestSQLInsert
	class forestSQLUpdate
	class forestSQLDelete
	class forestSQLTruncate
	class forestSQLCreate
	class forestSQLDrop
	class forestSQLAlter
	class forestSQLColumn
	class forestSQLJoin
	class forestSQLRelation
	class forestSQLWhere
	class forestSQLOrderBy
	class forestSQLLimit
	class forestSQLColumnValue
	class forestSQLColumnStructure
	class forestSQLConstraint
							
						

forestStringLib.php

collection of static string helper functions

							
	/**
	 * replace multiple values in a string where we have numeric placeholders with a preceding character
	 *
	 * @param string $p_s_str  string value with numeric placeholders
	 * @param array $p_a_vars  array of values
	 * @param char $p_s_char  numeric placeholder char for recognition
	 *
	 * @return string
	 *
	 * @access public
	 * @static yes
	 */
	public static function sprintf2($p_s_str = '', $p_a_vars = array(), $p_s_char = '%')
	
	/**
	 * replace multiple chars in a string which are arranged in two parameter-arrays
	 *
	 * @param string $p_s_str  string value, passed by reference
	 * @param array $p_a_search  array of characters which should be replaced
	 * @param array $p_a_replace  array of characters which are replacing the found characters
	 *
	 * @return null
	 *
	 * @access public
	 * @static yes
	 */
	public static function ReplaceChar(&$p_s_str, array $p_a_search, array $p_a_replace)
	
	/**
	 * remove multiple chars in a string which are set in parameter-array
	 *
	 * @param string $p_s_str  string value
	 * @param array $p_a_search  array of characters which should be removed
	 *
	 * @return string
	 *
	 * @access public
	 * @static yes
	 */
	public static function RemoveChar($p_s_str, array $p_a_search)
	
	/**
	 * converts sql-filter arguments into sql-clauses-array for implementing filter in query
	 * example: =35&<2|>=5&1..5&2*|ab?d
	 *
	 * @param string $p_s_value  string value
	 *
	 * @return array  array of filter clauses
	 *
	 * @access public
	 * @static yes
	 */
	public static function SplitFilter($p_s_value)
	
	/**
	 * converts date/time/datetime-sql-string into forestDateTime object
	 *
	 * @param string $p_s_value  string value
	 *
	 * @return forestDateTime
	 *
	 * @access public
	 * @static yes
	 */
	public static function TextToDate($p_s_value)
	
	/**
	 * converts hex-value into integer
	 *
	 * @param string $p_s_value  string value
	 *
	 * @return integer
	 *
	 * @access public
	 * @static yes
	 */
	public static function HexToInt($p_s_value)
	
	/**
	 * converts integer into hex-value
	 *
	 * @param integer $p_i_value  integer value
	 *
	 * @return string
	 *
	 * @access public
	 * @static yes
	 */
	public static function IntToHex($p_i_value)
	
	/**
	 * check if a string starts with a specific order of characters
	 *
	 * @param string $p_s_str  string value
	 * @param string $p_s_search  search for occurence
	 *
	 * @return bool  true - string starts with search value, false - string start not with search value
	 *
	 * @access public
	 * @static yes
	 */
	public static function StartsWith($p_s_str, $p_s_search)
	
	/**
	 * check if a string ends with a specific order of characters
	 *
	 * @param string $p_s_str  string value
	 * @param string $p_s_search  search for occurence
	 *
	 * @return bool  true - string ends with search value, false - string ends not with search value
	 *
	 * @access public
	 * @static yes
	 */
	public static function EndsWith($p_s_str, $p_s_search)
	
	/**
	 * close all open html tags of the parameter string
	 *
	 * @param string $p_s_value  string value
	 *
	 * @return string
	 *
	 * @access public
	 * @static yes
	 */
	public static function closeHTMLTags($p_s_value)
	
	/**
	 * function to remove system prefix of sql table names
	 *
	 * @param string $p_s_table  name of table, passed by reference
	 *
	 * @return null
	 *
	 * @access public
	 * @static yes
	 */
	public static function RemoveTablePrefix(&$p_s_table)
	
	/**
	 * replace unicode escape sequence within a string
	 *
	 * @param string $p_s_string  string value
	 *
	 * @return string
	 *
	 * @access public
	 * @static yes
	 */
	public static function ReplaceUnicodeEscapeSequence($p_s_string)
	
	/**
	 * help function to increase alphanumeric and numeric only identifiers, with leading zeros as well
	 *
	 * @param string $p_s_identifier  value of identifier
	 * @param string $p_i_increment  increment value
	 *
	 * @return string  incremented identifier
	 *
	 * @access public
	 * @static yes
	 */
	public static function IncreaseIdentifier($p_s_identifier, $p_i_increment)
	
	/**
	 * parse a string value to a valid filename string
	 *
	 * @param string $p_s_string  string value
	 *
	 * @return string
	 *
	 * @access public
	 * @static yes
	 */
	public static function ParseNameToFilename($p_s_string)
	
	/**
	 * manual european money_format function
	 *
	 * @param string $format  locale format e.g. en_US, de_DE
	 * @param float $number
	 *
	 * @return string  well formated money string
	 *
	 * @access public
	 * @static yes
	 */
	public static function money_format($format, $number)
							
						

forestTableFieldProperties.php

class to capsulate data about table fields
storing these objects in a global dictionary will reduce database record access for one session

							
	/**
	 * constructor of forestTableFieldProperties class, holding all information of a sql column/field
	 *
	 * @param parameters based on the sql columns/fields of sys_fphp_tablefield table
	 *
	 * @return null
	 *
	 * @access public
	 * @static no
	 */
	public function __construct(
		$p_s_uuid,
		$p_s_tableUUID,
		$p_s_fieldName,
		$p_s_tabId,
		$p_s_json,
		$p_b_footerElement,
		$p_s_subRecordField,
		$p_i_order,
		$p_s_formUUID,
		$p_s_formName,
		$p_s_formJSON,
		$p_s_sqlUUID,
		$p_s_sqlName,
		$p_s_fdataUUID,
		$p_s_fdataName
	)
							
						

forestTemplates.php

template class using to print standard data elements

							
	/**
	 * access to forestTemplate type value
	 *
	 * @return string  forestTemplate type
	 *
	 * @access public
	 * @static no
	 */
	public function getType()
	
	/**
	 * constructor of forestTemplates class
	 *
	 * @param string $p_s_type  string value as constant pointer to desired template
	 * @param array $p_a_placeHolders  array list of values which should be inserted into the template
	 *
	 * @return null
	 *
	 * @access public
	 * @static no
	 */
	public function __construct($p_s_type, $p_a_placeHolders = null)
	
	/**
	 * render method to print forestTemplate with values which should be inserted into template's content by sprintf2 helper function, usually dynamic values
	 *
	 * @return string
	 *
	 * @access public
	 * @static no
	 */
	public function __toString()
							
						

forestTwig.php

abstract class for all twig objects, one twig represents a table in a database
all necessary methods to read or manipulate data are implemented in this class
and can be used with every twig-object that stays for one table in the database

							
	/**
	 * constructor of forestTwig class, creating a twig object representing a table with all its information and a table record
	 *
	 * @param array $p_a_record  raw dataset of a record as an array
	 * @param integer $p_i_resultType  standard ASSOC - ASSOC, NUM, BOTH, OBJ, LAZY
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access public
	 * @static no
	 */
	public function __construct($p_a_record = array(), $p_i_resultType = \fPHP\Base\forestBase::ASSOC)
	
	/* every class which inherits forestTwig must implement init-function */
	abstract protected function init();
	
	/**
	 * execute sql query to get table field properties
	 *
	 * @param string $p_s_tableUUID  table uuid
	 * @param string $p_s_field  field name
	 *
	 * @return array  raw record data or null if no properties could be found
	 *
	 * @throws forestException if error occurs
	 * @access public
	 * @static yes
	 */
	public static function QueryFieldProperties($p_s_tableUUID, $p_s_field)
	
	/**
	 * query sub records of a sub constraint
	 *
	 * @param subconstraintTwig $p_o_subconstraint  sub constraint record
	 * @param bool $p_b_overwrite  flag to overwrite information in global cache, standard false
	 *
	 * @return forestTwigList  record list of sub records
	 *
	 * @throws forestException if error occurs
	 * @access public
	 * @static no
	 */
	public function QuerySubRecords(\fPHP\Twigs\subconstraintTwig $p_o_subconstraint, $p_b_overwrite = false)
	
	/**
	 * fill Mapping array from forestTwig instance
	 *
	 * @param array $p_a_object_vars  list of class variables
	 *
	 * @return null
	 *
	 * @access protected
	 * @static no
	 */
	protected function fphp_FillMapping(array $p_a_object_vars)
	
	/**
	 * general method to get property field value, for sub records as well as for combination fields
	 *
	 * @param string $p_s_name  sql column/field name
	 *
	 * @return object  value behind sql column/field name of holded record
	 *
	 * @access public
	 * @static no
	 */
	public function GetFieldValue($p_s_name)
	
	/**
	 * general method to set property field value, for sub records as well
	 *
	 * @param string $p_s_name  sql column/field name
	 * @param object $p_o_value  object value for sql column/field
	 *
	 * @return null
	 *
	 * @access public
	 * @static no
	 */
	public function SetFieldValue($p_s_name, $p_o_value)
	
	/**
	 * if twig object is not empty, field value will be restored using record image
	 *
	 * @param string $p_s_name  sql column/field name
	 *
	 * @return null
	 *
	 * @access public
	 * @static no
	 */
	public function RestoreFieldValue($p_s_name)
	
	/**
	 * calculate value behind forestCombination field
	 *
	 * @param string $p_s_forestCombination  forestCombination command
	 *
	 * @return object  value behind forestCombination field, usually a string value
	 *
	 * @throws forestException if error occurs
	 * @access public
	 * @static no
	 */
	public function CalculateCombination($p_s_forestCombination)
	
	/**
	 * get record with values of primary key
	 *
	 * @param array $p_a_primaryValues  primary key values for where clause
	 *
	 * @return bool  true - record found and values loaded into fields, false - record could not be found
	 *
	 * @throws forestException if error occurs
	 * @access public
	 * @static no
	 */
	public function GetRecord(array $p_a_primaryValues)
	
	/**
	 * determine if current twig object is empty
	 *
	 * @return bool  true - record is not empty, false - record is empty
	 *
	 * @access public
	 * @static no
	 */
	public function IsEmpty()
	
	/**
	 * gets record with values of temporary other primary key
	 *
	 * @param array $p_a_primaryValues  primary key values for where clause
	 * @param array $p_a_primaryKeys  primary key names for where clause
	 *
	 * @return bool  true - record found and values loaded into fields, false - record could not be found
	 *
	 * @throws forestException if error occurs
	 * @access public
	 * @static no
	 */
	public function GetRecordPrimary(array $p_a_primaryValues, array $p_a_primaryKeys)
	
	/**
	 * showing all data fields of current twig object for log purposes
	 *
	 * @param bool $p_b_showViewFields  true - show fields in view object list, false - show fields in mapping object list
	 * @param bool $p_b_printBreak  true - print html-br-tag within return value, false - do not print html-br-tag within return value
	 *
	 * @return string  record fields with values
	 *
	 * @throws forestException if error occurs
	 * @access public
	 * @static no
	 */
	public function ShowFields($p_b_showViewFields = true, $p_b_printBreak = false)
	
	/**
	 * get first record of table
	 *
	 * @return bool  true - record found and values loaded into fields, false - record could not be found
	 *
	 * @throws forestException if error occurs
	 * @access public
	 * @static no
	 */
	public function GetFirstRecord()
	
	/**
	 * get last record of table
	 *
	 * @return bool  true - record found and values loaded into fields, false - record could not be found
	 *
	 * @throws forestException if error occurs
	 * @access public
	 * @static no
	 */
	public function GetLastRecord()
	
	/**
	 * get amount of records of current table or another table
	 *
	 * @param string $p_s_table  name of table, optional
	 * @param bool $p_b_unlimited  true - use filter and limit settings, false - ignore filter and limit settings
	 * @param bool $p_b_updateLimitAmount  true - update global limit amount value, false - do not update global limit amount value
	 *
	 * @return integer  amount of records
	 *
	 * @throws forestException if error occurs
	 * @access public
	 * @static no
	 */
	public function GetCount($p_s_table = null, $p_b_unlimited = false, $p_b_updateLimitAmount = false)
	
	/**
	 * get all records, depending on filter and limit parameters
	 *
	 * @param bool $p_b_unlimited  true - use filter and limit settings, false - ignore filter and limit settings
	 *
	 * @return result of function forestBase->FetchQuery
	 *
	 * @throws forestException if error occurs
	 * @access public
	 * @static no
	 */
	public function GetAllRecords($p_b_unlimited = false)
	
	/**
	 * get records based on view columns, depending on filter and limit parameters
	 *
	 * @param bool $p_b_unlimited  true - use filter and limit settings, false - ignore filter and limit settings
	 *
	 * @return result of function this->GetAllRecords
	 *
	 * @throws forestException if error occurs
	 * @access public
	 * @static no
	 */
	public function GetAllViewRecords($p_b_unlimited = false)
	
	/**
	 * insert record into table, with primary key fields optional
	 *
	 * @param bool $p_b_withPrimary  true - assume and set values for primary key, false - keep primary key values unchanged or let them handle by dbms
	 *
	 * @return integer  -1 - unique issue, 0 - could not create record, 1 - record creation successful
	 *
	 * @throws forestException if error occurs
	 * @access public
	 * @static no
	 */
	public function InsertRecord($p_b_withPrimary = false, $p_b_full = false)
	
	/**
	 * update record in table, you cannot modify primary key, with modify of unique fields optional
	 *
	 * @param bool $p_b_modifyUnique  true - assume and set values for unique fields, false - keep unique key fields unchanged or let them handle by dbms
	 *
	 * @return integer  -1 - unique issue, 0 - could not update record, 1 - record update successful
	 *
	 * @throws forestException if error occurs
	 * @access public
	 * @static no
	 */
	public function UpdateRecord($p_b_modifyUnique = true)
	
	/**
	 * delete record in table
	 *
	 * @return integer  0 - could not delete record, 1 - record deletion successful
	 *
	 * @throws forestException if error occurs
	 * @access public
	 * @static no
	 */
	public function DeleteRecord()
		
	/**
	 * truncate table
	 *
	 * @return integer  0 - could not truncate table, 1 - truncate of table successful
	 *
	 * @throws forestException if error occurs
	 * @access public
	 * @static no
	 */
	public function TruncateTable()
							
						

forestTwigList.php

object collection of unique twigs, objects of one single database record
you enter a sql query result on construction of the twig list
it will automatically create the twig objects depending on how many records are present in the query result

							
	/**
	 * constructor of forestTwigList class, creating a object list of forestTwig objects and possible join records
	 *
	 * @param string $p_s_table  name of table
	 * @param array $p_a_records  raw dataset of records as an array
	 * @param integer $p_i_resultType  standard ASSOC - ASSOC, NUM, BOTH, OBJ, LAZY
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access public
	 * @static no
	 */
	public function __construct($p_s_table, $p_a_records = array(), $p_i_resultType = \fPHP\Base\forestBase::ASSOC)
							
						

forestURL.php

class holding specific url information based on an arranged url-format
for more information about the arranged url-format, see the documentation

							
	/**
	 * constructor of forestURL class
	 *
	 * @return null
	 *
	 * @access public
	 * @static no
	 */
	public function __construct()
	
	/**
	 * retrieving detail information out of database based on information read out of url
	 *
	 * @param bool $p_b_show  flag to show debug information
	 *
	 * @return null
	 *
	 * @throws forestException if error occurs
	 * @access public
	 * @static no
	 */
	public function RetrieveInformationByURL($p_b_show = false)