egroupware_official/doc/html/x407.html
2000-11-21 22:33:37 +00:00

227 lines
3.1 KiB
HTML

<HTML
><HEAD
><TITLE
>Application Functions</TITLE
><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="The API"
HREF="devapi.html"><LINK
REL="PREVIOUS"
TITLE="Basic functions"
HREF="x398.html"><LINK
REL="NEXT"
TITLE="File functions"
HREF="x434.html"></HEAD
><BODY
CLASS="SECT1"
><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
HREF="x398.html"
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
>Chapter 25. The API</TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="x434.html"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><DIV
CLASS="SECT1"
><H1
CLASS="SECT1"
><A
NAME="AEN407"
>Application Functions</A
></H1
><P
></P
><DIV
CLASS="SECT2"
><H2
CLASS="SECT2"
><A
NAME="AEN410"
>$phpgw-&#62;common-&#62;phpgw_header</A
></H2
><P
> <TT
CLASS="CLASSNAME"
>$phpgw-&#62;phpgw_header()</TT
>
</P
><P
> Print out the start of the HTML page, including the navigation bar
and includes <TT
CLASS="FILENAME"
>appname/inc/header.php</TT
>
</P
></DIV
><DIV
CLASS="SECT2"
><H2
CLASS="SECT2"
><A
NAME="AEN416"
>$phpgw-&#62;common-&#62;phpgw_footer</A
></H2
><P
><TT
CLASS="CLASSNAME"
>$phpgw-&#62;phpgw_footer()</TT
></P
><P
> Prints the system footer, and includes <TT
CLASS="FILENAME"
>appname/inc/footer.php</TT
>
</P
></DIV
><DIV
CLASS="SECT2"
><H2
CLASS="SECT2"
><A
NAME="AEN422"
>$phpgw-&#62;common-&#62;appsession</A
></H2
><P
><TT
CLASS="CLASSNAME"
>$phpgw-&#62;common-&#62;appsession($data)</TT
></P
><P
> Store important information session information that your
application needs.
</P
><P
> <TT
CLASS="CLASSNAME"
>$phpgw-&#62;appsession</TT
> will return the value of your session data is
you leave the parameter empty [i.e. <TT
CLASS="CLASSNAME"
>$phpgw-&#62;appsession("")</TT
>], otherwise
it will store whatever data you send to it.
</P
><P
> You can also store a comma delimited string and use <TT
CLASS="CLASSNAME"
>explode()</TT
>
to turn it back into an array when you receive the value back.
</P
><P
> Example:
<TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
> $phpgw-&#62;common-&#62;appsession("/path/to/something");
echo "Dir: " . $phpgw-&#62;common-&#62;appsession();</PRE
></TD
></TR
></TABLE
>
</P
></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
HREF="x398.html"
>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
HREF="x434.html"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>Basic functions</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="devapi.html"
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>File functions</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>