2000-11-11 11:39:44 +01:00
|
|
|
<HTML
|
|
|
|
|
><HEAD
|
|
|
|
|
><TITLE
|
2000-11-21 23:33:37 +01:00
|
|
|
>The API</TITLE
|
2000-11-11 11:39:44 +01:00
|
|
|
><META
|
|
|
|
|
NAME="GENERATOR"
|
|
|
|
|
CONTENT="Modular DocBook HTML Stylesheet Version 1.52"><LINK
|
|
|
|
|
REL="HOME"
|
|
|
|
|
TITLE="phpGroupWare Docs V0.05"
|
|
|
|
|
HREF="book1.html"><LINK
|
|
|
|
|
REL="UP"
|
|
|
|
|
TITLE="Developers Documentation"
|
2000-11-21 23:33:37 +01:00
|
|
|
HREF="p261.html"><LINK
|
2000-11-11 11:39:44 +01:00
|
|
|
REL="PREVIOUS"
|
2000-11-21 23:33:37 +01:00
|
|
|
TITLE="Infrastructure"
|
|
|
|
|
HREF="devinfra.html"><LINK
|
2000-11-11 11:39:44 +01:00
|
|
|
REL="NEXT"
|
2000-11-21 23:33:37 +01:00
|
|
|
TITLE="Basic functions"
|
|
|
|
|
HREF="x398.html"></HEAD
|
2000-11-11 11:39:44 +01:00
|
|
|
><BODY
|
|
|
|
|
CLASS="CHAPTER"
|
|
|
|
|
><DIV
|
|
|
|
|
CLASS="NAVHEADER"
|
|
|
|
|
><TABLE
|
|
|
|
|
WIDTH="100%"
|
|
|
|
|
BORDER="0"
|
|
|
|
|
CELLPADDING="0"
|
|
|
|
|
CELLSPACING="0"
|
|
|
|
|
><TR
|
|
|
|
|
><TH
|
|
|
|
|
COLSPAN="3"
|
|
|
|
|
ALIGN="center"
|
|
|
|
|
>phpGroupWare Docs V0.05</TH
|
|
|
|
|
></TR
|
|
|
|
|
><TR
|
|
|
|
|
><TD
|
|
|
|
|
WIDTH="10%"
|
|
|
|
|
ALIGN="left"
|
|
|
|
|
VALIGN="bottom"
|
|
|
|
|
><A
|
2000-11-21 23:33:37 +01:00
|
|
|
HREF="devinfra.html"
|
2000-11-11 11:39:44 +01:00
|
|
|
>Prev</A
|
|
|
|
|
></TD
|
|
|
|
|
><TD
|
|
|
|
|
WIDTH="80%"
|
|
|
|
|
ALIGN="center"
|
|
|
|
|
VALIGN="bottom"
|
|
|
|
|
></TD
|
|
|
|
|
><TD
|
|
|
|
|
WIDTH="10%"
|
|
|
|
|
ALIGN="right"
|
|
|
|
|
VALIGN="bottom"
|
|
|
|
|
><A
|
2000-11-21 23:33:37 +01:00
|
|
|
HREF="x398.html"
|
2000-11-11 11:39:44 +01:00
|
|
|
>Next</A
|
|
|
|
|
></TD
|
|
|
|
|
></TR
|
|
|
|
|
></TABLE
|
|
|
|
|
><HR
|
|
|
|
|
ALIGN="LEFT"
|
|
|
|
|
WIDTH="100%"></DIV
|
|
|
|
|
><DIV
|
|
|
|
|
CLASS="CHAPTER"
|
|
|
|
|
><H1
|
|
|
|
|
><A
|
2000-11-21 23:33:37 +01:00
|
|
|
NAME="DEVAPI"
|
|
|
|
|
>Chapter 25. The API</A
|
2000-11-11 11:39:44 +01:00
|
|
|
></H1
|
|
|
|
|
><DIV
|
|
|
|
|
CLASS="TOC"
|
|
|
|
|
><DL
|
|
|
|
|
><DT
|
|
|
|
|
><B
|
|
|
|
|
>Table of Contents</B
|
|
|
|
|
></DT
|
|
|
|
|
><DT
|
|
|
|
|
><A
|
2000-11-21 23:33:37 +01:00
|
|
|
HREF="devapi.html#AEN389"
|
|
|
|
|
>Introduction</A
|
|
|
|
|
></DT
|
|
|
|
|
><DT
|
|
|
|
|
><A
|
|
|
|
|
HREF="x398.html"
|
|
|
|
|
>Basic functions</A
|
|
|
|
|
></DT
|
|
|
|
|
><DT
|
|
|
|
|
><A
|
|
|
|
|
HREF="x407.html"
|
|
|
|
|
>Application Functions</A
|
2000-11-11 11:39:44 +01:00
|
|
|
></DT
|
|
|
|
|
><DT
|
|
|
|
|
><A
|
2000-11-21 23:33:37 +01:00
|
|
|
HREF="x434.html"
|
|
|
|
|
>File functions</A
|
|
|
|
|
></DT
|
|
|
|
|
><DT
|
|
|
|
|
><A
|
|
|
|
|
HREF="x471.html"
|
|
|
|
|
>Email/NNTP Functions</A
|
2000-11-11 11:39:44 +01:00
|
|
|
></DT
|
|
|
|
|
></DL
|
|
|
|
|
></DIV
|
|
|
|
|
><DIV
|
|
|
|
|
CLASS="SECT1"
|
|
|
|
|
><H1
|
|
|
|
|
CLASS="SECT1"
|
|
|
|
|
><A
|
2000-11-21 23:33:37 +01:00
|
|
|
NAME="AEN389"
|
|
|
|
|
>Introduction</A
|
2000-11-11 11:39:44 +01:00
|
|
|
></H1
|
|
|
|
|
><P
|
2000-11-21 23:33:37 +01:00
|
|
|
> phpGroupWare attempts to provide developers with a useful API to handle common tasks.
|
|
|
|
|
</P
|
|
|
|
|
><P
|
|
|
|
|
> To do this we have created a multi-dimensional class $phpgw->.
|
|
|
|
|
</P
|
|
|
|
|
><P
|
|
|
|
|
> This allows for terrific code organization, and help developers easily identify
|
|
|
|
|
the file that the function is in. All the files that are part of this class are in the
|
|
|
|
|
<TT
|
|
|
|
|
CLASS="FILENAME"
|
|
|
|
|
>inc/core</TT
|
|
|
|
|
> directory
|
|
|
|
|
and are named to match the sub-class.
|
|
|
|
|
</P
|
|
|
|
|
><P
|
|
|
|
|
> Example:<TT
|
|
|
|
|
CLASS="CLASSNAME"
|
|
|
|
|
>$phpgw->send->msg()</TT
|
|
|
|
|
> is in the
|
|
|
|
|
<TT
|
|
|
|
|
CLASS="FILENAME"
|
|
|
|
|
>inc/phpgwapi/phpgw_send.inc.php</TT
|
|
|
|
|
> file.
|
|
|
|
|
</P
|
2000-11-11 11:39:44 +01:00
|
|
|
></DIV
|
|
|
|
|
></DIV
|
|
|
|
|
><DIV
|
|
|
|
|
CLASS="NAVFOOTER"
|
|
|
|
|
><HR
|
|
|
|
|
ALIGN="LEFT"
|
|
|
|
|
WIDTH="100%"><TABLE
|
|
|
|
|
WIDTH="100%"
|
|
|
|
|
BORDER="0"
|
|
|
|
|
CELLPADDING="0"
|
|
|
|
|
CELLSPACING="0"
|
|
|
|
|
><TR
|
|
|
|
|
><TD
|
|
|
|
|
WIDTH="33%"
|
|
|
|
|
ALIGN="left"
|
|
|
|
|
VALIGN="top"
|
|
|
|
|
><A
|
2000-11-21 23:33:37 +01:00
|
|
|
HREF="devinfra.html"
|
2000-11-11 11:39:44 +01:00
|
|
|
>Prev</A
|
|
|
|
|
></TD
|
|
|
|
|
><TD
|
|
|
|
|
WIDTH="34%"
|
|
|
|
|
ALIGN="center"
|
|
|
|
|
VALIGN="top"
|
|
|
|
|
><A
|
|
|
|
|
HREF="book1.html"
|
|
|
|
|
>Home</A
|
|
|
|
|
></TD
|
|
|
|
|
><TD
|
|
|
|
|
WIDTH="33%"
|
|
|
|
|
ALIGN="right"
|
|
|
|
|
VALIGN="top"
|
|
|
|
|
><A
|
2000-11-21 23:33:37 +01:00
|
|
|
HREF="x398.html"
|
2000-11-11 11:39:44 +01:00
|
|
|
>Next</A
|
|
|
|
|
></TD
|
|
|
|
|
></TR
|
|
|
|
|
><TR
|
|
|
|
|
><TD
|
|
|
|
|
WIDTH="33%"
|
|
|
|
|
ALIGN="left"
|
|
|
|
|
VALIGN="top"
|
2000-11-21 23:33:37 +01:00
|
|
|
>Infrastructure</TD
|
2000-11-11 11:39:44 +01:00
|
|
|
><TD
|
|
|
|
|
WIDTH="34%"
|
|
|
|
|
ALIGN="center"
|
|
|
|
|
VALIGN="top"
|
|
|
|
|
><A
|
2000-11-21 23:33:37 +01:00
|
|
|
HREF="p261.html"
|
2000-11-11 11:39:44 +01:00
|
|
|
>Up</A
|
|
|
|
|
></TD
|
|
|
|
|
><TD
|
|
|
|
|
WIDTH="33%"
|
|
|
|
|
ALIGN="right"
|
|
|
|
|
VALIGN="top"
|
2000-11-21 23:33:37 +01:00
|
|
|
>Basic functions</TD
|
2000-11-11 11:39:44 +01:00
|
|
|
></TR
|
|
|
|
|
></TABLE
|
|
|
|
|
></DIV
|
|
|
|
|
></BODY
|
|
|
|
|
></HTML
|
|
|
|
|
>
|
