[prev in list] [next in list] [prev in thread] [next in thread]
List: pear-doc
Subject: [PEAR-DOC] cvs: peardoc /en language-snippets.ent /en/package/pear pear-info.xml /en/package/pear/
From: "Christian Weiske" <cweiske () php ! net>
Date: 2007-07-07 10:13:31
Message-ID: cvscweiske1183803211 () cvsserver
[Download RAW message or body]
cweiske Sat Jul 7 10:13:31 2007 UTC
Added files:
/peardoc/en/package/pear/pear-info/pear-info display.xml
getstylesheet.xml
packageinstalled.xml
setstylesheet.xml
tohtml.xml
Removed files:
/peardoc/en/package/pear/pear-info/pear-info setProxy.xml
Modified files:
/peardoc/en language-snippets.ent
/peardoc/en/package/pear pear-info.xml
/peardoc/en/package/pear/pear-info pear-info.xml
/peardoc/en/package/pear/pear-info/pear-info show.xml
Log:
Committing Laurent's pear info docs
["cweiske-20070707101331.txt" (text/plain)]
http://cvs.php.net/viewvc.cgi/peardoc/en/language-snippets.ent?r1=1.15&r2=1.16&diff_format=u
Index: peardoc/en/language-snippets.ent
diff -u peardoc/en/language-snippets.ent:1.15 peardoc/en/language-snippets.ent:1.16
--- peardoc/en/language-snippets.ent:1.15 Sun May 6 11:53:09 2007
+++ peardoc/en/language-snippets.ent Sat Jul 7 10:13:30 2007
@@ -1,4 +1,4 @@
-<!-- $Revision: 1.15 $ -->
+<!-- $Revision: 1.16 $ -->
<!ENTITY warn.experimental '<warning><simpara>This module is
<emphasis>EXPERIMENTAL</emphasis>. That means that the behaviour of these
@@ -60,6 +60,7 @@
<!ENTITY title.note '<title>Note</title>'>
<!ENTITY title.example '<title>Example</title>'>
<!ENTITY title.see '<title>See</title>'>
+<!ENTITY title.since '<title>Since</title>'>
<!ENTITY title.constants 'Constants'>
<!ENTITY type.array '<type>array</type>'>
http://cvs.php.net/viewvc.cgi/peardoc/en/package/pear/pear-info.xml?r1=1.6&r2=1.7&diff_format=u
Index: peardoc/en/package/pear/pear-info.xml
diff -u peardoc/en/package/pear/pear-info.xml:1.6 \
peardoc/en/package/pear/pear-info.xml:1.7
--- peardoc/en/package/pear/pear-info.xml:1.6 Fri Jun 20 18:37:15 2003
+++ peardoc/en/package/pear/pear-info.xml Sat Jul 7 10:13:31 2007
@@ -1,4 +1,4 @@
-<!-- $Revision: 1.6 $ -->
+<!-- $Revision: 1.7 $ -->
<sect1 id="package.pear-info">
<title>PEAR_Info</title>
@@ -9,8 +9,12 @@
&package.pear.pear-info.intro;
&package.pear.pear-info.pear-info;
- &package.pear.pear-info.pear-info.setProxy;
+ &package.pear.pear-info.pear-info.display;
+ &package.pear.pear-info.pear-info.getstylesheet;
+ &package.pear.pear-info.pear-info.packageinstalled;
+ &package.pear.pear-info.pear-info.setproxy;
&package.pear.pear-info.pear-info.show;
+ &package.pear.pear-info.pear-info.tohtml;
</sect1>
<!-- Keep this comment at the end of the file
http://cvs.php.net/viewvc.cgi/peardoc/en/package/pear/pear-info/pear-info.xml?r1=1.2&r2=1.3&diff_format=u
Index: peardoc/en/package/pear/pear-info/pear-info.xml
diff -u peardoc/en/package/pear/pear-info/pear-info.xml:1.2 \
peardoc/en/package/pear/pear-info/pear-info.xml:1.3
--- peardoc/en/package/pear/pear-info/pear-info.xml:1.2 Thu May 8 03:06:31 2003
+++ peardoc/en/package/pear/pear-info/pear-info.xml Sat Jul 7 10:13:31 2007
@@ -1,47 +1,134 @@
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<refentry id="package.pear.pear-info.pear-info.pear-info">
- <refnamediv>
- <refname>PEAR_Info::PEAR_Info</refname>
- <refpurpose>Constructor</refpurpose>
- </refnamediv>
- <refsynopsisdiv>
- <funcsynopsis>
- <funcsynopsisinfo>
- require_once "PEAR/Info.php";
- </funcsynopsisinfo>
- <funcprototype>
- <funcdef>void <function>PEAR_Info::PEAR_Info</function></funcdef>
- <paramdef>
- string <parameter><optional>$pear_dir=''</optional></parameter>
- </paramdef>
- </funcprototype>
- </funcsynopsis>
- </refsynopsisdiv>
- <refsect1 id="package.pear.pear-info.pear-info.pear-info.desc">
- &title.desc;
- <para>
- Constructor
- </para>
- </refsect1>
- <refsect1 id="package.pear.pear-info.pear-info.pear-info.parameter">
- &title.param;
- <para>
- <itemizedlist>
- <listitem>
- <para>
- <parameter>string $pear_dir</parameter> -
- Full Path to PEAR Install directory
- </para>
- </listitem>
- </itemizedlist>
- </para>
- </refsect1>
- <refsect1 id="package.pear.pear-info.pear-info.pear-info.note">
- &title.note;
- ¬e.notstatic;
- <simpara></simpara>
- </refsect1>
- </refentry>
+ <refnamediv>
+ <refname>constructor <function>PEAR_Info::PEAR_Info</function></refname>
+ <refpurpose>PHP 4 style constructor (ZE1)</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <funcsynopsis>
+ <funcsynopsisinfo>
+ require_once 'PEAR/Info.php';
+ </funcsynopsisinfo>
+ <funcprototype>
+ <funcdef>&type.void; constructor \
<function>PEAR_Info::PEAR_Info</function></funcdef> + <paramdef>&type.string; \
<parameter><optional>$pear_dir = ''</optional></parameter></paramdef> + \
<paramdef>&type.string; <parameter><optional>$user_file = \
''</optional></parameter></paramdef> + <paramdef>&type.string; \
<parameter><optional>$system_file = ''</optional></parameter></paramdef> + \
<paramdef>&type.array; <parameter><optional>$options = \
&null;</optional></parameter></paramdef> + </funcprototype>
+ </funcsynopsis>
+ </refsynopsisdiv>
+
+ <refsect1 id="package.pear.pear-info.pear-info.pear-info.desc">
+ &title.desc;
+ <important>
+ <para>
+ <parameter>$user_file</parameter>, <parameter>$system_file</parameter> and
+ <parameter>$options</parameter> parameters are available since version 1.7.0RC1,
+ allowing to define more easily the PEAR configuration files, and choose what
+ information to display akin to PHP's <ulink \
url="&url.php.lookup;phpinfo">phpinfo()</ulink>. + </para>
+ </important>
+ </refsect1>
+
+ <refsect1 id="package.pear.pear-info.pear-info.pear-info.param">
+ &title.param;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term>
+ &type.string; <parameter>$pear_dir</parameter>
+ </term>
+ <listitem>
+ <para>
+ (optional) The PEAR base install directory
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ <variablelist>
+ <varlistentry>
+ <term>
+ &type.string; <parameter>$user_file</parameter>
+ </term>
+ <listitem>
+ <para>
+ (optional) file to read PEAR user-defined options from
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ <variablelist>
+ <varlistentry>
+ <term>
+ &type.string; <parameter>$system_file</parameter>
+ </term>
+ <listitem>
+ <para>
+ (optional) file to read PEAR system-wide defaults from
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ <variablelist>
+ <varlistentry>
+ <term>
+ &type.array; <parameter>$options</parameter>
+ </term>
+ <listitem>
+ <para>
+ (optional) configure PEAR information output
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+
+ <refsect1 id="package.pear.pear-info.pear-info.pear-info.throws">
+ &title.throws;
+ <para>
+ <emphasis>throws</emphasis> no exceptions thrown
+ </para>
+ </refsect1>
+
+ <refsect1 id="package.pear.pear-info.pear-info.pear-info.since">
+ &title.since;
+ <para>
+ <emphasis>since</emphasis> 1.0.1
+ </para>
+ </refsect1>
+
+ <refsect1 id="package.pear.pear-info.pear-info.pear-info.note">
+ &title.note;
+ ¬e.notstatic;
+ </refsect1>
+
+ <refsect1 id="package.pear.pear-info.pear-info.pear-info.example">
+ &title.example;
+ <para>
+ <programlisting role="php">
+<![CDATA[<?php
+require_once 'PEAR/Info.php';
+
+// Display only PEAR version and logo, reference to config file, list of channels
+// and quick list of packages (with only version info) installed thru channels
+// pear, __uri, pecl.
+$options = array('resume' => PEAR_INFO_GENERAL | PEAR_INFO_CHANNELS | \
PEAR_INFO_PACKAGES_VERSION, + 'channels' => array('pear.php.net', '__uri', \
'pecl.php_net') +);
+
+// Give PEAR install directory where to find pear.ini or pearsys.ini files
+$info = new PEAR_Info('c:\wamp\php', '', '', $options);
+
+$info->display();
+
+?>]]>
+ </programlisting>
+ </para>
+ </refsect1>
+</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
@@ -61,3 +148,4 @@
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
+
http://cvs.php.net/viewvc.cgi/peardoc/en/package/pear/pear-info/pear-info/show.xml?r1=1.3&r2=1.4&diff_format=u
Index: peardoc/en/package/pear/pear-info/pear-info/show.xml
diff -u peardoc/en/package/pear/pear-info/pear-info/show.xml:1.3 \
peardoc/en/package/pear/pear-info/pear-info/show.xml:1.4
--- peardoc/en/package/pear/pear-info/pear-info/show.xml:1.3 Thu May 8 03:07:27 2003
+++ peardoc/en/package/pear/pear-info/pear-info/show.xml Sat Jul 7 10:13:31 2007
@@ -1,31 +1,64 @@
-<!-- $Revision: 1.3 $ -->
+<!-- $Revision: 1.4 $ -->
<refentry id="package.pear.pear-info.pear-info.show">
- <refnamediv>
- <refname>PEAR_Info::show</refname>
- <refpurpose>Display PEAR_Info</refpurpose>
- </refnamediv>
- <refsynopsisdiv>
- <funcsynopsis>
- <funcsynopsisinfo>
- require_once "PEAR/Info.php";
- </funcsynopsisinfo>
- <funcprototype>
- <funcdef>void <function>PEAR_Info::show</function></funcdef>
- <paramdef></paramdef>
- </funcprototype>
- </funcsynopsis>
- </refsynopsisdiv>
- <refsect1 id="package.pear.pear-info.pear-info.show.desc">
- &title.desc;
- <para>
- Displays PEAR_Info result
- </para>
- </refsect1>
- <refsect1 id="package.pear.pear-info.pear-info.show.note">
- &title.note;
- ¬e.notstatic;
- </refsect1>
- </refentry>
+ <refnamediv>
+ <refname><function>PEAR_Info::show</function></refname>
+ <refpurpose>Shows PEAR_Info output</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <funcsynopsis>
+ <funcsynopsisinfo>
+ require_once 'PEAR/Info.php';
+ </funcsynopsisinfo>
+ <funcprototype>
+ <funcdef>&type.void; <function>PEAR_Info::show</function></funcdef>
+ <paramdef></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ </refsynopsisdiv>
+
+ <refsect1 id="package.pear.pear-info.pear-info.show.desc">
+ &title.desc;
+ <para>
+ Displays PEAR_Info output depending of style applied (style sheet).
+ </para>
+ </refsect1>
+
+ <refsect1 id="package.pear.pear-info.pear-info.show.deprecated">
+ &title.deprecated;
+ <para>
+ <emphasis>deprecated</emphasis> use display() instead
+ </para>
+ </refsect1>
+
+ <refsect1 id="package.pear.pear-info.pear-info.show.throws">
+ &title.throws;
+ <para>
+ <emphasis>throws</emphasis> no exceptions thrown
+ </para>
+ </refsect1>
+
+ <refsect1 id="package.pear.pear-info.pear-info.show.since">
+ &title.since;
+ <para>
+ <emphasis>since</emphasis> 1.0.1
+ </para>
+ </refsect1>
+
+ <refsect1 id="package.pear.pear-info.pear-info.show.note">
+ &title.note;
+ ¬e.notstatic;
+ </refsect1>
+
+ <refsect1 id="package.pear.pear-info.pear-info.show.see">
+ &title.see;
+ <para>
+ <link linkend="package.pear.pear-info.pear-info.setstylesheet">
+ <function>PEAR_Info::setStyleSheet</function>
+ </link>
+ </para>
+ </refsect1>
+</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
@@ -45,3 +78,4 @@
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
+
http://cvs.php.net/viewvc.cgi/peardoc/en/package/pear/pear-info/pear-info/display.xml?view=markup&rev=1.1
Index: peardoc/en/package/pear/pear-info/pear-info/display.xml
+++ peardoc/en/package/pear/pear-info/pear-info/display.xml
<!-- $Revision: 1.1 $ -->
<refentry id="package.pear.pear-info.pear-info.display">
<refnamediv>
<refname><function>PEAR_Info::display</function></refname>
<refpurpose>Displays PEAR_Info output</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcsynopsisinfo>
require_once 'PEAR/Info.php';
</funcsynopsisinfo>
<funcprototype>
<funcdef>&type.void; <function>PEAR_Info::display</function></funcdef>
<paramdef></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="package.pear.pear-info.pear-info.display.desc">
&title.desc;
<para>
Displays PEAR_Info output depending of style applied (style sheet).
</para>
</refsect1>
<refsect1 id="package.pear.pear-info.pear-info.display.throws">
&title.throws;
<para>
<emphasis>throws</emphasis> no exceptions thrown
</para>
</refsect1>
<refsect1 id="package.pear.pear-info.pear-info.display.since">
&title.since;
<para>
<emphasis>since</emphasis> 1.7.0RC1
</para>
</refsect1>
<refsect1 id="package.pear.pear-info.pear-info.display.note">
&title.note;
¬e.notstatic;
</refsect1>
<refsect1 id="package.pear.pear-info.pear-info.display.see">
&title.see;
<para>
<link linkend="package.pear.pear-info.pear-info.setstylesheet">
<function>PEAR_Info::setStyleSheet</function>
</link>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
http://cvs.php.net/viewvc.cgi/peardoc/en/package/pear/pear-info/pear-info/getstylesheet.xml?view=markup&rev=1.1
Index: peardoc/en/package/pear/pear-info/pear-info/getstylesheet.xml
+++ peardoc/en/package/pear/pear-info/pear-info/getstylesheet.xml
<!-- $Revision: 1.1 $ -->
<refentry id="package.pear.pear-info.pear-info.getstylesheet">
<refnamediv>
<refname><function>PEAR_Info::getStyleSheet</function></refname>
<refpurpose>Returns the custom style sheet to use for presentation</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcsynopsisinfo>
require_once 'PEAR/Info.php';
</funcsynopsisinfo>
<funcprototype>
<funcdef>&type.string; <function>PEAR_Info::getStyleSheet</function></funcdef>
<paramdef>&type.bool; <parameter><optional>$content = \
&true;</optional></parameter></paramdef> </funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="package.pear.pear-info.pear-info.getstylesheet.desc">
&title.desc;
<para>
Default behavior is to return css string contents.
Sets <parameter>$content</parameter> parameter to &false; will return css filename
reference (defined by setStyleSheet function).
Easy for a <link rel="stylesheet" type="text/css"
href="" /> html tag integration (see example below).
</para>
</refsect1>
<refsect1 id="package.pear.pear-info.pear-info.getstylesheet.param">
&title.param;
<para>
<variablelist>
<varlistentry>
<term>
&type.bool; <parameter>$content</parameter>
</term>
<listitem>
<para>
(optional) Either return css filename or string contents
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 id="package.pear.pear-info.pear-info.getstylesheet.throws">
&title.throws;
<para>
<emphasis>throws</emphasis> no exceptions thrown
</para>
</refsect1>
<refsect1 id="package.pear.pear-info.pear-info.getstylesheet.since">
&title.since;
<para>
<emphasis>since</emphasis> 1.7.0RC1
</para>
</refsect1>
<refsect1 id="package.pear.pear-info.pear-info.getstylesheet.note">
&title.note;
¬e.notstatic;
</refsect1>
<refsect1 id="package.pear.pear-info.pear-info.getstylesheet.returns">
&title.returns;
<para>
&type.string; - returns css filename or css string contents
</para>
</refsect1>
<refsect1 id="package.pear.pear-info.pear-info.getstylesheet.example">
&title.example;
<para>
<programlisting role="php">
<![CDATA[<?php
// require the PEAR_Info file
require_once 'PEAR/Info.php';
class PEAR_Info3 extends PEAR_Info
{
function PEAR_Info3($pear_dir = '', $user_file = '', $system_file = '')
{
$this->__construct($pear_dir, $user_file, $system_file);
}
function toHtml()
{
$styles = basename($this->getStyleSheet(false));
$body = $this->info;
$html = <<<HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" >
<head>
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
<meta name="author" content="Laurent Laville" />
<title>My PEAR_Info()</title>
<link rel="stylesheet" type="text/css" href="$styles" />
</head>
<body>
<div id="header">
<h1>Laurent-Laville.org</h1>
</div>
<div id="footer">
</div>
<div id="contents">
$body
</div>
</body>
</html>
HTML;
return $html;
}
}
// Create PEAR_Info object
$info = new PEAR_Info3();
// set your own styles, rather than use the default stylesheet
$info->setStyleSheet(dirname(__FILE__) . DIRECTORY_SEPARATOR . 'pearinfo3.css');
// Display PEAR_Info output
$info->display();
?>]]>
</programlisting>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
http://cvs.php.net/viewvc.cgi/peardoc/en/package/pear/pear-info/pear-info/packageinstalled.xml?view=markup&rev=1.1
Index: peardoc/en/package/pear/pear-info/pear-info/packageinstalled.xml
+++ peardoc/en/package/pear/pear-info/pear-info/packageinstalled.xml
<!-- $Revision: 1.1 $ -->
<refentry id="package.pear.pear-info.pear-info.packageinstalled">
<refnamediv>
<refname><function>PEAR_Info::packageInstalled</function></refname>
<refpurpose>Check if a package is installed</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcsynopsisinfo>
require_once 'PEAR/Info.php';
</funcsynopsisinfo>
<funcprototype>
<funcdef>&type.bool; <function>PEAR_Info::packageInstalled</function></funcdef>
<paramdef>&type.string; <parameter>$name</parameter></paramdef>
<paramdef>&type.string; <parameter><optional>$version = \
&null;</optional></parameter></paramdef> <paramdef>&type.string; \
<parameter><optional>$channel = &null;</optional></parameter></paramdef> \
<paramdef>&type.string; <parameter><optional>$user_file = \
''</optional></parameter></paramdef> <paramdef>&type.string; \
<parameter><optional>$system_file = ''</optional></parameter></paramdef> \
</funcprototype> </funcsynopsis>
</refsynopsisdiv>
<refsect1 id="package.pear.pear-info.pear-info.packageinstalled.desc">
&title.desc;
¬documented;
</refsect1>
<refsect1 id="package.pear.pear-info.pear-info.packageinstalled.param">
&title.param;
<para>
<variablelist>
<varlistentry>
<term>
&type.string; <parameter>$name</parameter>
</term>
<listitem>
<para>
Package name
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist>
<varlistentry>
<term>
&type.string; <parameter>$version</parameter>
</term>
<listitem>
<para>
(optional) The minimal version that should be installed
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist>
<varlistentry>
<term>
&type.string; <parameter>$channel</parameter>
</term>
<listitem>
<para>
(optional) The package channel distribution
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist>
<varlistentry>
<term>
&type.string; <parameter>$user_file</parameter>
</term>
<listitem>
<para>
(optional) file to read PEAR user-defined options from
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist>
<varlistentry>
<term>
&type.string; <parameter>$system_file</parameter>
</term>
<listitem>
<para>
(optional) file to read PEAR system-wide defaults from
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 id="package.pear.pear-info.pear-info.packageinstalled.since">
&title.since;
<para>
<emphasis>since</emphasis> 1.6.0
</para>
</refsect1>
<refsect1 id="package.pear.pear-info.pear-info.packageinstalled.throws">
&title.throws;
<para>
<emphasis>throws</emphasis> no exceptions thrown
</para>
</refsect1>
<refsect1 id="package.pear.pear-info.pear-info.packageinstalled.note">
&title.note;
¬e.shouldstatic;
</refsect1>
<refsect1 id="package.pear.pear-info.pear-info.packageinstalled.example">
&title.example;
<para>
<programlisting role="php">
<![CDATA[<?php
require_once 'PEAR/Info.php';
$res = PEAR_Info::packageInstalled('Role_Web', '1.1.0', 'pearified');
if ($res) {
print "Package pearified/Role_Web 1.1.0 or greater is installed \n";
} else {
print "Package pearified/Role_Web is not yet installed \n";
}
$res = PEAR_Info::packageInstalled('PEAR_PackageFileManager');
if ($res) {
print "Package pear/PEAR_PackageFileManager is installed \n";
} else {
print "Package pear/PEAR_PackageFileManager is not yet installed \n";
}
?>]]>
</programlisting>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
http://cvs.php.net/viewvc.cgi/peardoc/en/package/pear/pear-info/pear-info/setstylesheet.xml?view=markup&rev=1.1
Index: peardoc/en/package/pear/pear-info/pear-info/setstylesheet.xml
+++ peardoc/en/package/pear/pear-info/pear-info/setstylesheet.xml
<!-- $Revision: 1.1 $ -->
<refentry id="package.pear.pear-info.pear-info.setstylesheet">
<refnamediv>
<refname><function>PEAR_Info::setStyleSheet</function></refname>
<refpurpose>Sets the custom style sheet to use your own styles</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcsynopsisinfo>
require_once 'PEAR/Info.php';
</funcsynopsisinfo>
<funcprototype>
<funcdef>&type.bool; <function>PEAR_Info::setStyleSheet</function></funcdef>
<paramdef>&type.string; <parameter><optional>$css = \
&null;</optional></parameter></paramdef> </funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="package.pear.pear-info.pear-info.setstylesheet.desc">
&title.desc;
<para>
Sets the custom style sheet (colors, sizes) to applied to PEAR_Info output.
If you don't give any parameter, you'll then apply again the default style.
</para>
</refsect1>
<refsect1 id="package.pear.pear-info.pear-info.setstylesheet.param">
&title.param;
<para>
<variablelist>
<varlistentry>
<term>
&type.string; <parameter>$css</parameter>
</term>
<listitem>
<para>
(optional) File to read user-defined styles from
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 id="package.pear.pear-info.pear-info.setstylesheet.throws">
&title.throws;
<para>
<emphasis>throws</emphasis> no exceptions thrown
</para>
</refsect1>
<refsect1 id="package.pear.pear-info.pear-info.setstylesheet.since">
&title.since;
<para>
<emphasis>since</emphasis> 1.7.0RC1
</para>
</refsect1>
<refsect1 id="package.pear.pear-info.pear-info.setstylesheet.note">
&title.note;
¬e.notstatic;
<tip>
<para>
If you don't want to have any style applied, then build an empty style sheet
(css file) and give it as function parameter (See example below).
</para>
</tip>
</refsect1>
<refsect1 id="package.pear.pear-info.pear-info.setstylesheet.returns">
&title.returns;
<para>
&type.bool; - &true; if custom styles, &false; if default styles applied.
</para>
</refsect1>
<refsect1 id="package.pear.pear-info.pear-info.setstylesheet.example">
&title.example;
<para>
<programlisting role="php">
<![CDATA[<?php
// require the PEAR_Info file
require_once 'PEAR/Info.php';
// Create PEAR_Info object
$info = new PEAR_Info();
// set your own styles, rather than use the default stylesheet
$info->setStyleSheet(dirname(__FILE__) . DIRECTORY_SEPARATOR . 'blueskin.css');
// don't use any style (empty.css is an empty file)
//$info->setStyleSheet(dirname(__FILE__) . DIRECTORY_SEPARATOR . 'empty.css');
// Display PEAR_Info output
$info->display();
?>]]>
</programlisting>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
http://cvs.php.net/viewvc.cgi/peardoc/en/package/pear/pear-info/pear-info/tohtml.xml?view=markup&rev=1.1
Index: peardoc/en/package/pear/pear-info/pear-info/tohtml.xml
+++ peardoc/en/package/pear/pear-info/pear-info/tohtml.xml
<!-- $Revision: 1.1 $ -->
<refentry id="package.pear.pear-info.pear-info.tohtml">
<refnamediv>
<refname><function>PEAR_Info::toHtml</function></refname>
<refpurpose>Returns PEAR_Info output (html code)</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcsynopsisinfo>
require_once 'PEAR/Info.php';
</funcsynopsisinfo>
<funcprototype>
<funcdef>&type.string; <function>PEAR_Info::toHtml</function></funcdef>
<paramdef></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="package.pear.pear-info.pear-info.tohtml.desc">
&title.desc;
<para>
Returns html code. This code is XHTML 1.1 compliant since version 1.7.0
</para>
</refsect1>
<refsect1 id="package.pear.pear-info.pear-info.tohtml.throws">
&title.throws;
<para>
<emphasis>throws</emphasis> no exceptions thrown
</para>
</refsect1>
<refsect1 id="package.pear.pear-info.pear-info.tohtml.since">
&title.since;
<para>
<emphasis>since</emphasis> 1.7.0RC1
</para>
</refsect1>
<refsect1 id="package.pear.pear-info.pear-info.tohtml.note">
&title.note;
¬e.notstatic;
</refsect1>
<refsect1 id="package.pear.pear-info.pear-info.tohtml.see">
&title.see;
<para>
<link linkend="package.pear.pear-info.pear-info.setstylesheet">
<function>PEAR_Info::setStyleSheet</function>
</link>,
<link linkend="package.pear.pear-info.pear-info.getstylesheet">
<function>PEAR_Info::getStyleSheet</function>
</link>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
--
PEAR Documentation List Mailing List (http://pear.php.net/)
To unsubscribe, visit: http://www.php.net/unsub.php
[prev in list] [next in list] [prev in thread] [next in thread]
Configure |
About |
News |
Add a list |
Sponsored by KoreLogic