documentation-2.html

PHPLOB注释详细版 使用模板技术的好帮手 PHP最有用的东东了

mSQL, Sybase, Microsoft SQL Server, ODBC and Oracle have limited
support (the limitation is only relevant if you intend to access
metadata information, i.e. table definitions and the like).
Database interfaces are not difficult to write and you can
easily write your own interface.
<P>You need a database server connection with <CODE>select</CODE>,
<CODE>insert</CODE>, <CODE>update</CODE> and <CODE>delete</CODE> privileges from your
CGI environment. You need <CODE>create</CODE> and <CODE>drop</CODE> privileges
from an administrative account outside your CGI environment as
well.
<P>PHPLIB core functionality requires two tables as part of your
application table name space: <CODE>active_sessions</CODE> (select,
insert, update and delete privilege required for the application
user) and <CODE>auth_user</CODE> (select privilege required for the
application user. insert, update and delete privilege required
for the application user if user management is to be done from
within the application).
<P>Extended functionality may require additional tables.
<P>
<H3>Name space requirements</H3>

<P>
<P>PHPLIB tries to be as name space neutral as possible with its
core features. Is issues no HTML by default and it occupies only
few names in the global name space. These are the class names
for the classes defined: <CODE>DB_Sql</CODE>, <CODE>DB_SAM</CODE>,
<CODE>CT_Sql</CODE>, <CODE>Session</CODE>, <CODE>Auth</CODE>, <CODE>Perm</CODE>,
<CODE>User</CODE>. Additionally, the classnames <CODE>DB_Example</CODE>,
<CODE>Example_CT_Sql</CODE>, <CODE>Example_Session</CODE>,
<CODE>Example_Auth</CODE>,
<CODE>Example_Challenge_Auth</CODE>,
<CODE>Example_Perm</CODE> and <CODE>Example_User</CODE> are
defined by the sample setup in <CODE>local.inc</CODE>, but these names
can and shall be customized by the application developer. PHPLIB
defines the function names <CODE>page_open()</CODE>,
<CODE>page_close</CODE>, <CODE>sess_load()</CODE> and
<CODE>sess_save()</CODE> for the page management functions. The
global variable $_PHPLIB (a hash) is taken. Only if
<CODE>page_open()</CODE> is being used, globals are defined by
the library by default, but one global for each "feature"
requested in the <CODE>page_open()</CODE> statement is taken.
These are at most <CODE>$sess</CODE>, <CODE>$user</CODE>, <CODE>$auth</CODE> and
<CODE>$perm</CODE>.
<P>Including extension functionality or HTML widgets may occupy
additional classnames, function names or variables in the global
name space.
<P>
<H3>Year 2000 compliance statement</H3>

<P>
<P>PHPLIB uses date fields within the column <CODE>changed</CODE> in the
table <CODE>active_sessions</CODE> in your database.  The
<CODE>changed</CODE> field is used in garbage collection, that is, to
clean out abandoned sessions. The date field is a 14 character
field of the format <CODE>YYYYMMDDhhmmss</CODE>, that is, the date field
has four digit years and will cope properly with the new
millennium.
<P>PHPLIB sets cookies in the client browser. These cookies by
default have session lifetime, that is, they do not expire but
are not written to disk. Date calculations are not involved.
<P>It is possible to have PHPLIB set cookies with a limited
lifetime by defining the $lifetime slot of the Session class.
If this is done, it depends on the date handling of the client
browser and client operating system, if the result is Y2K
compliant. There are known issues with longterm cookies and any
browser on MS-DOS/Windows 3.11 systems.
<P>PHPLIB does some date arithmetic internally that involves
mktime() and date() functions of the PHP3 language and Unix
time_t data types. The signed 32 bit Unix time_t
data type counts seconds since 01-Jan-1970 Midnight GMT and will
overflow sometime in the year 2038.
<P>PHPLIB itself will function up to 2038 and longer, if the Unix
time_t is being extended in time. PHPLIB does not protect
you from date and Y2K issues in your PHPLIB application, the
PHP3 interpreter, the server operating system oder server
software, the client browser, the client operating system or
other parts of your installation.
<P>
<H2><A NAME="ss2.4">2.4 Installation procedure </A>
</H2>

<P><CODE>mod_php</CODE> note: The following instructions apply
to the CGI version of PHP as well as to the module version. If
you are working with <CODE>mod_php</CODE>, you must restart your
web server to force a reload of the <CODE>php3.ini</CODE> file, though.
<P>If you are using <CODE>mod_php</CODE>, you have additional
configuration options: See the section below on using PHPLIB
mit <CODE>mod_php</CODE>.
<P>
<DL>
<P>
<DT><B>Library Setup</B><DD><P>Create a directory php next to your cgi:
<P>
<BLOCKQUOTE><CODE>
<HR>
<PRE>
/home/www/servers/phplib.netuse.de/pages   &lt;- document root
                                   cgi     &lt;- php binary
                                   php     &lt;- includes and prepends
</PRE>
<HR>
</CODE></BLOCKQUOTE>
<P>Make this php directory your php include directory: Put 
<CODE>include_path = /home/www/servers/phplib.netuse.de/php</CODE>
into <CODE>cgi/php3.ini</CODE>. If you already have an include path
defined in your setup, add the PHPLIB include path to the
existing include path using the separator character applicable
for your operating system (":" on UNIX, ";" on Windows).
Defining an include path will not actually include code on your
pages; it only tells the PHP interpreter in which directories to
look for files referenced in <CODE>require()</CODE> and <CODE>include()</CODE>
statements.
<P>Into the <CODE>php</CODE> directory go all the files from the <CODE>php</CODE>
directory of the distribution. Into documentroot, put all the
files and directories from the <CODE>pages</CODE> directory of the
distribution.
<P>Have <CODE>documentation.txt</CODE> handy and read it.
<P>
<DT><B>Database access with MySQL</B><DD><P>The following information applies to MySQL only. No information
is provided for other database servers as of now. You are
encouraged to copy this section, adapt it for your database
server and submit it to the authors. It will be included in
further releases of PHPLIB.
<P>Edit <CODE>prepend.php3</CODE>. Change the first <CODE>require()</CODE>
statement to <CODE>require("db_mysql.inc");</CODE>. This will
include the MySQL database interface (Interfaces for other
databases are provided in
<CODE>db_&lt;databasename&gt;.inc</CODE>. The <CODE>require()</CODE>
statement has to be adapted to reflect this).
<P>Assuming your database server is named <CODE>database.netuse.de</CODE>
and your CGI user is <CODE>webuser</CODE> and you are accessing the
database <CODE>myapp</CODE>, do
<P>
<BLOCKQUOTE><CODE>
<HR>
<PRE>
mysql -h database -u webuser myapp
</PRE>
<HR>
</CODE></BLOCKQUOTE>
<P>If it does not work, connect your database as administrator and
create the proper mysql access permissions. Adapt and run
<CODE>create_database.mysql</CODE> from the <CODE>stuff</CODE>
subdirectory of the distribution to create the databases
<CODE>active_sessions</CODE> and <CODE>auth_user</CODE> as well as
the sample user <CODE>kris</CODE> with password <CODE>test</CODE>. Try again to
connect like shown above. Can you do <CODE>select * from
active_sessions</CODE>? and <CODE>insert into
active_sessions values ("1", "2", "3", "")</CODE> as well as
<CODE>delete from active_sessions</CODE>? Can you <CODE>select *
from auth_user</CODE>?
<P><EM>Note:</EM> Additional database creation scripts are provided for
several different databases in the <CODE>stuff</CODE> directory of the
distribution.
<P>
<DT><B>Merging the library with your PHP files</B><DD><P>Decide if you want to use <CODE>include</CODE> or
<CODE>auto_prepend_file</CODE>. We do use
<CODE>auto_prepend_file</CODE>
here and we add the statement
<CODE>auto_prepend_file =
/home/www/servers/phplib.netuse.de/php/prepend.php3</CODE> to our
<CODE>php3.ini</CODE>.
<P>Not all classes are included/required by <CODE>prepend.php3</CODE>, only
core functionality files are: <CODE>db_xxx.inc</CODE>,
<CODE>ct_sql.inc</CODE>, <CODE>session.inc</CODE>,
<CODE>auth.inc</CODE>, <CODE>perm.inc</CODE>, <CODE>user.inc</CODE>, <CODE>local.inc</CODE> and
<CODE>page.inc</CODE>. The library provides other, less essential
classes that can be included manually on a page-by-page basis.
Some classes make themselves persistent, if used. These classes
require that you include their definitions in the
<CODE>prepend.php3</CODE> file where indicated to function correctly.
See the usage instructions for these classes for details.
<P>Having done this, access <CODE>/index.php3</CODE>. The counter
should increment when that page is being reloaded. Also, checking
<CODE>active_sessions</CODE> in the database should reflect that
session.
<P>
<DT><B>Subscribe for support</B><DD><P>Subscribe to the mailing list 
<A HREF="mailto:[e-mail]">[e-mail]</A>. Do so by sending a mail body of <CODE>subscribe</CODE>
to 
<A HREF="mailto:[e-mail]">[e-mail]</A> and follow instructions. Share your
experiences.
</DL>

<P>
<H2><A NAME="ss2.5">2.5 Using <CODE>include()</CODE> instead of <CODE>auto_prepend_file=</CODE></A>
</H2>

<P>If you do not want to use <CODE>auto_prepend_file</CODE> to load the
PHPLIB core functionality, you can load the class definitions
for the core manually on each page that requires them.
<P>You will have to define a valid
<CODE>include_path=</CODE>-statement in your <CODE>php3.ini</CODE> file
as outlined previously to reflect the location of the <CODE>*.inc</CODE>
files. Then, all core functionality can be loaded with
<CODE>include("prepend.php3")</CODE> as the first statement at the top
of each page.
<P>To further optimize performance, you can minimize the contents
of the prepend file, if you do not need all core functionality.
You <EM>may</EM> leave out <CODE>auth.inc</CODE>, <CODE>perm.inc</CODE> and
<CODE>user.inc</CODE>, if you do not require these features (note that
there are dependencies among these classes!).
<P>
<H2><A NAME="ss2.6">2.6 PHPLIB with mod_php (Apache module)</A>
</H2>

<P>
<P>Installing PHPLIB onto a web server that has PHP3 as a module
(actually Apache) mainly differs in where you can set up runtime
settings for PHP3 itself.  PHP3 can be compiled with a wealth of
parameters (see the PHP section in <CODE>phpinfo()</CODE>), most of which can
get overridden by the <CODE>php3.ini</CODE> file. The location of this
file is shows as part of the output of <CODE>phpinfo()</CODE>.
<P>With PHP3 as a module you have a wider choice on placing these
settings: they are overridden, in this order, by what is defined
in <CODE>httpd.conf</CODE> and in your per-directory <CODE>.htaccess</CODE>
file. Directives in these files are identical to their
<CODE>php3.ini</CODE> brothers, but are prefixed with <CODE>php_</CODE>
to avoid clashes with Apache configuration keywords. Also, as
they are Apache configuration keywords, they have no equals
("=") sign in them. If <CODE>x=y</CODE> is a configuration directive
from <CODE>php3.ini</CODE>, you should be using <CODE>php3_x y</CODE>
within the Apache configuration instead. That is, you should
prepend <CODE>php3_</CODE> to the keyword and omit the equals
sign. If you misspell a configuration directive, you will get an
error 500 from your webserver and find more details about the
error in the logfile you configured with <CODE>ErrorLog</CODE> in your
webserver setup.
<P><EM>Example:</EM> If below we talk about setting in your
<CODE>php3.ini</CODE> the configuration
<P>
<BLOCKQUOTE><CODE>
<HR>
<PRE>
include_path = "/bla"
</PRE>
<HR>
</CODE></BLOCKQUOTE>
<P><CODE>mod_php</CODE> users may alternatively configure in their
<CODE>httpd.conf</CODE> the following:
<P>
<BLOCKQUOTE><CODE>
<HR>
<PRE>
&lt;Directory /home/www/servers/phplib.netuse.de/pages&gt;
php3_include_path "/bla"
&lt;/Directory&gt;
</PRE>
<HR>
</CODE></BLOCKQUOTE>
<P>Of special interest to PHPLIB users are the following
directives:
<P>
<BLOCKQUOTE><CODE>
<HR>
<PRE>
;;;;;;;;;;;;;;;;;
; Data Handling ;
;;;;;;;;;;;;;;;;;
magic_quotes_gpc = Off    ; magic quotes for incoming 
                          ; GET/POST/Cookie data
magic_quotes_runtime = Off; magic quotes for runtime-generated data,
                          ; e.g. data from SQL, from exec(), etc.
magic_quotes_sybase = Off ; Use Sybase-style magic quotes 
                          ; (escape ' with '' instead of \')
track_vars = On           ; enable $PHP_GET_VARS[], $PHP_POST_VARS[] 
                          ; and $PHP_COOKIE_VARS[] arrays

; automatically add files before or after any PHP 3.0 document
auto_prepend_file = (add path to prepend.php3 here)
auto_append_file  =

;;;;;;;;;;;;;;;;;;;;;;;;;
; Paths and Directories ;
;;;;;;;;;;;;;;;;;;;;;;;;;
include_path      = (add path to the directory with all .inc files)
</PRE>
<HR>
</CODE></BLOCKQUOTE>
<P>All of this comes very handy when you have multiple virtual
hosts (e.g. you are an ISP). In this case you can comfortably
place the php3 directives in the <CODE>&lt;VirtualHost&gt;</CODE> block
or in an <CODE>.htaccess</CODE> file in the client directory.
<P>
<P>
<HR>
<A HREF="documentation-3.html">Next</A>
<A HREF="documentation-1.html">Previous</A>
<A HREF="documentation.html#toc2">Contents</A>
</BODY>
</HTML>