extern/egroupware
1
0
Fork 1
mirror of https://github.com/EGroupware/egroupware.git synced 2025-08-17 20:11:23 +02:00
Code Issues Packages Projects Releases Wiki Activity

Added $phpgw->common->phpgw_footer() function, and changed all

Browse Source 
places that were including the footer.inc.php to use the function.

Re-arrange phpgw.inc.php to include optional classes after reading the DB config
misc bugfixes.
This commit is contained in:
sjb4891
2000-09-29 05:24:18 +00:00
parent 313c7aba0f
commit 263fdedd2a
44 changed files with 184 additions and 83 deletions
Download Patch File Download Diff File Expand all files Collapse all files

106
doc/developers/phpGW_Developers-HOWTO.txt
View File

@@ -1,6 +1,6 @@
phpGroupWare Application Development
Dan Kuykendall <dan@kuykendall.org>
v0.5, 09 September 2000
v0.9 29 September 2000
This document explains phpGroupWare's infrastructure and API, along
with what is required to integrate applications into it.
@@ -98,7 +98,9 @@
5.2 Basic functions
5.2.1 $phpgw->link
5.3 Application Functions
5.3.1 $phpgw->common->appsession
5.3.1 $phpgw->common->phpgw_header
5.3.2 $phpgw->common->phpgw_footer
5.3.3 $phpgw->common->appsession
5.4 File functions
5.4.1 $phpgw->vfs->read_file
5.4.2 $phpgw->vfs->write_file
@@ -128,8 +130,8 @@
7.2.2.1 The lang table
7.2.2.2 lang.sql
7.3 Common return codes
8. Using Templates
8.1 Overview
8.2 How to use templates
@@ -192,10 +194,10 @@
If you need help converting your application to templates and our lang
support, we will try to connect you with someone to help.
22..22.. WWrriittiinngg//ppoorrttiinngg yyoouurr aapppplliiccaattiioonn
22..22..11.. IInncclluuddee ffiilleess
Each PHP page you write will need to include the header.inc.php along
@@ -249,13 +251,16 @@
+o appname/inc/functions.inc.php - This file should include all your
application specific functions.
+o appname/inc/header.inc.php - This file is loaded just after the
system header/navbar, and allows developers to use it for whatever
they need to load.
+o appname/inc/header.inc.php - This file is loaded by
$phpgw->common->header just after the system header/navbar, and
allows developers to use it for whatever they need to load.
+o appname/inc/footer.inc.php - This file is loaded by
$phpgw->common->footer just before the system footer, allowing
developers to close connections and whatever else they need.
+o appname/inc/footer.inc.php - This file is loaded just before the
system footer, allowing developers to close connections and
whatever else they need.
33..33.. AAddddiinngg ffiilleess,, ddiirreeccttoorriieess aanndd iiccoonnss..
@@ -326,8 +331,6 @@
There are 2 functions to coordinate the display of each application's
links, section_start() and section_end()
33..55..11.. sseeccttiioonn__ssttaarrtt
section_start($title,$icon_url) starts the section for your
@@ -387,9 +390,6 @@
@@ -538,7 +538,18 @@
55..33.. AApppplliiccaattiioonn FFuunnccttiioonnss
55..33..11.. $$pphhppggww-->>ccoommmmoonn-->>aappppsseessssiioonn
55..33..11.. $$pphhppggww-->>ccoommmmoonn-->>pphhppggww__hheeaaddeerr
$phpgw->phpgw_header()
Print out the start of the HTML page, including the navigation bar and
includes appname/inc/header.php
55..33..22.. $$pphhppggww-->>ccoommmmoonn-->>pphhppggww__ffooootteerr
$phpgw->phpgw_footer()
Prints the system footer, and includes appname/inc/footer.php
55..33..33.. $$pphhppggww-->>ccoommmmoonn-->>aappppsseessssiioonn
$phpgw->common->appsession($data)
Store important information session information that your application
@@ -580,6 +591,7 @@
You must send the complete path to the file.
Example:
______________________________________________________________________
$data = $phpgw->vfs->write_file("/some/dir/to/file.txt");
______________________________________________________________________
@@ -592,6 +604,7 @@
$phpgw->vfs->read_userfile($file)
Returns the data from $file, which resides in the users private dir.
Example:
______________________________________________________________________
$data = $phpgw->vfs->read_userfile("file.txt");
______________________________________________________________________
@@ -644,6 +657,7 @@
66.. CCoonnffiigguurraattiioonn VVaarriiaabblleess
66..11.. IInnttrroodduuccttiioonn
@@ -711,6 +725,8 @@
directory.
$phpgw_info["server"]["temp_dir"] = Directory that can be used for
temporarily storing files
$phpgw_info["server"]["files_dir"] = Directory er and group files are
stored
$phpgw_info["server"]["common_include_dir"] = Location of the
core/shared include files.
$phpgw_info["server"]["template_dir"] = Active template files
@@ -718,12 +734,16 @@
user.
$phpgw_info["server"]["dir_separator"] = Allows compatibility with
WindowsNT directory format,
$phpgw_info["server"]["encrpytkey"] =
$phpgw_info["server"]["encrpytkey"] = Key used for encryption
functions
$phpgw_info["server"]["site_title"] = Site Title will show in the
title bar of each webpage.
$phpgw_info["server"]["webserver_url"] = URL to phpGroupWare
installation.
$phpgw_info["server"]["charset"] = Unknown
$phpgw_info["server"]["hostname"] = Name of the server phpGroupWare is
installed upon.
$phpgw_info["server"]["charset"] = default charset,
default:iso-8859-1
$phpgw_info["server"]["version"] = phpGroupWare version.
66..55.. DDaattaabbaassee iinnffoorrmmaattiioonn
@@ -835,6 +855,7 @@
77..22..11.. TThhee llaanngg ffuunnccttiioonn
lang($key, $m1="", $m2="", $m3="", $m4="", $m5="",
$m6="", $m7="", $m8="", $m9="", $m10="")
@@ -898,6 +919,9 @@
application name in for app_name otherwise use the name common. The
message_id should be in lower case for a small increase in speed.
77..33.. CCoommmmoonn rreettuurrnn ccooddeess
If you browse through the phpGroupWare sources, you may notice a
@@ -921,7 +945,6 @@
Your message has been sent
translated into the current language.
@@ -958,6 +981,9 @@
This document was written by Dan Kuykendall.
2000-09-25 documentation on lang(), codes, administration and
preferences extension added by Steve Brown.
99..44.. CCooppyyrriigghhttss aanndd TTrraaddeemmaarrkkss
Copyright (c) Dan Kuykendall. Permission is granted to copy,
@@ -988,3 +1014,43 @@