mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-20 10:58:54 +00:00
6a9d174b80
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@173025 c90b9560-bf6c-de11-be94-00142212c4b1
52 lines
1.8 KiB
XML
52 lines
1.8 KiB
XML
<?xml version='1.0' encoding='iso-8859-1' ?>
|
|
<!-- $Revision: 1.6 $ -->
|
|
<!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 -->
|
|
<refentry id="function.hwapi-content">
|
|
<refnamediv>
|
|
<refname>hw_api->content</refname>
|
|
<refpurpose>Returns content of an object</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<methodsynopsis>
|
|
<type>HW_API_Content</type><methodname>hw_api->content</methodname>
|
|
<methodparam><type>array</type><parameter>parameter</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
This function returns the content of a document as an object of type
|
|
<classname>hw_api_content</classname>. The parameter array
|
|
contains the required elements 'objectidentifier' and the optional
|
|
element 'mode'. The mode can be one of the constants
|
|
<constant>HW_API_CONTENT_ALLLINKS</constant>,
|
|
<constant>HW_API_CONTENT_REACHABLELINKS</constant> or
|
|
<constant>HW_API_CONTENT_PLAIN</constant>.
|
|
<constant>HW_API_CONTENT_ALLLINKS</constant> means to insert all
|
|
anchors even if the destination is not reachable.
|
|
<constant>HW_API_CONTENT_REACHABLELINKS</constant> tells
|
|
<function>hw_api_content</function> to insert only reachable links and
|
|
<constant>HW_API_CONTENT_PLAIN</constant> will lead to
|
|
document without any links.
|
|
</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:"../../../../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
|
|
-->
|