はじめに

Prev

Next

はじめに

PEAR は、the PHP Extension and ApplicationRepository を意味します。

このマニュアルについて

このマニュアルは、DocBook XMLDTD を用いて XML で書かれ、DSSSL(Document Style and Semantics Specification Language) をフォーマットに使用しています。HTML バージョンのフォーマットに使用されたツールは、James Clarkにより書かれた Jade とNorman Walsh により書かれたThe Modular DocBook Stylesheetsです。

このマニュアルの基本的な構成は、過去に行われた PHP ドキュメント作成グループの偉大な成果に基づいています。詳細については、PHP マニュアルについてを参照してください。

このマニュアルの構成

ここでは、PEAR マニュアルの構成やレイアウト・表記について説明します。このマニュアルは主に以下の 6 つの部分から構成されています。

PEAR について

PEAR とその機能に関する導入を示します。たとえば、PEAR のインストールと使用方法、サポートに関する一般的な情報、PEAR 関連して頻出する質問の回答などがあります。

デベロッパーズガイド

PEAR パッケージの開発/リリースについての一般的な情報を示します。

PEAR コア コンポーネンツ

コア PEAR クラスに関する文書を示します。このコアなコンポーネントは、すべての PEAR クラスのベースとなっており、PEAR ライブラリを汎用的に使用するには、その基本的理解が必要となります。ここでは、PEAR 基底クラス、PEAR 管理、PEAR_Error オブジェクト、システムコマンドについて記述します。これらのクラスは、通常、すべての PHP ソース配布ファイルに付属しています。

パッケージ

PEAR パッケージは数多くあり、さらに、その数は日々増え続けています。そのほとんどは、デフォルトではインストールされません。また、ほぼすべてのパッケージについて〔その概要や関連情報が〕文書化されています。PEAR クラスをシステムへインストールする方法に関する情報については、インストール に関するセクションを参照してください。

パッケージの各クラスについての文書には、パブリックに利用可能な関数に関する基本的な情報が示されています。さらに、導入、利用可能な定数の一覧、パッケージの使用方法といった付加的な情報が含まれていることもあります。パッケージのソースファイル自体にも、付加的な情報が含まれている場合があります。

各関数の説明には以下の要素のいずれかが含まれています。

・概要

関数の構造とプロトタイプ。

・説明

関数の動作に関する説明。

・パラメータ

関数の各パラメータの型と名前。必須なパラメータおよびオプションのパラメータを列挙します。

・返り値

関数の処理が失敗せずに完了した場合の返り値。

・例外・エラー

関数の処理が失敗した場合に返されるPEAR_Error オブジェクト。

・注意

この関数に関する追加情報。たとえば、この関数をスタティックにコールすることができるかどうかについて。

・参照

関連する関数やマニュアルのエントリへのリンク。

・例

続き…

ページ上段