mirror of
https://github.com/php/doc-ja.git
synced 2026-04-23 16:08:07 +02:00
TAKAGI Masahiro
8aa8aa561d
git-svn-id: https://svn.php.net/repository/phpdoc/ja/trunk@322540 c90b9560-bf6c-de11-be94-00142212c4b1
83 lines
2.5 KiB
XML
83 lines
2.5 KiB
XML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<!-- $Revision$ -->
|
|
<!-- EN-Revision: 0d604bbc9d3b741d53e7fac26f5b24c306751e9a Maintainer: takagi Status: ready -->
|
|
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="hwapi.content">
|
|
<refnamediv>
|
|
<refname>hw_api::content</refname>
|
|
<refpurpose>オブジェクトのコンテンツを返す</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>HW_API_Content</type><methodname>hw_api::content</methodname>
|
|
<methodparam><type>array</type><parameter>parameter</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
この関数は、文書のコンテンツを <classname>hw_api_content</classname>
|
|
型のオブジェクトとして返します。
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>parameter</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
パラメータの配列には、必須要素
|
|
'objectidentifier' およびオプションの要素 'mode' が含まれます。
|
|
mode は
|
|
<constant>HW_API_CONTENT_ALLLINKS</constant>、
|
|
<constant>HW_API_CONTENT_REACHABLELINKS</constant> あるいは
|
|
<constant>HW_API_CONTENT_PLAIN</constant> のうちのいずれかです。
|
|
</para>
|
|
<para>
|
|
<constant>HW_API_CONTENT_ALLLINKS</constant> は、
|
|
たとえそれが指している先が存在しない場合でもすべての対象アンカーを挿入します。
|
|
</para>
|
|
<para>
|
|
<constant>HW_API_CONTENT_REACHABLELINKS</constant> は、
|
|
到達可能なリンクのみを挿入するよう
|
|
<function>hw_api_content</function> に指示し、
|
|
<constant>HW_API_CONTENT_PLAIN</constant>
|
|
は文書にリンクを一切含めません。
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
<classname>hw_api_content</classname> のインスタンスを返します。
|
|
</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
|
|
indent-tabs-mode:nil
|
|
sgml-parent-document:nil
|
|
sgml-default-dtd-file:"~/.phpdoc/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
|
|
-->
|