<?xml version="1.0" encoding="utf-8"?>

<!-- $Revision$ -->

<!-- splitted from ./en/functions/apache.xml, last change in rev 1.2 -->

<refentry xml:id="function.apache-lookup-uri" xmlns="http://docbook.org/ns/docbook">

<refnamediv>

<refname>apache_lookup_uri</refname>

<refpurpose>Perform a partial request for the specified URI and return all info about it</refpurpose>

</refnamediv>

<refsect1 role="description">

&reftitle.description;

<methodsynopsis>

<type class="union"><type>object</type><type>false</type></type><methodname>apache_lookup_uri</methodname>

<methodparam><type>string</type><parameter>filename</parameter></methodparam>

</methodsynopsis>

<para>

This performs a partial request for a URI. It goes just far

enough to obtain all the important information about the given

resource.

</para>

&apache.req.module;

</refsect1>

<refsect1 role="parameters">

&reftitle.parameters;

<para>

<variablelist>

<varlistentry>

<term><parameter>filename</parameter></term>

<listitem>

<para>

The filename (URI) that's being requested.

</para>

</listitem>

</varlistentry>

</variablelist>

</para>

</refsect1>

<refsect1 role="returnvalues">

&reftitle.returnvalues;

<para>

An <type>object</type> of related URI information. The properties of

this <type>object</type> are:

</para>

<para>

<simplelist>

<member>status</member>

<member>the_request</member>

<member>status_line</member>

<member>method</member>

<member>content_type</member>

<member>handler</member>

<member>uri</member>

<member>filename</member>

<member>path_info</member>

<member>args</member>

<member>boundary</member>

<member>no_cache</member>

<member>no_local_copy</member>

<member>allowed</member>

<member>send_bodyct</member>

<member>bytes_sent</member>

<member>byterange</member>

<member>clength</member>

<member>unparsed_uri</member>

<member>mtime</member>

<member>request_time</member>

</simplelist>

</para>

<para>

Returns &false; on failure.

</para>

</refsect1>

<refsect1 role="examples">

&reftitle.examples;

<para>

<example>

<title><function>apache_lookup_uri</function> example</title>

<programlisting role="php">

<![CDATA[

<?php

$info = apache_lookup_uri('index.php?var=value');

print_r($info);

if (file_exists($info->filename)) {

echo 'file exists!';

}

?>

]]>

</programlisting>

&example.outputs.similar;

<screen>

<![CDATA[

stdClass Object

(

[status] => 200

[the_request] => GET /dir/file.php HTTP/1.1

[method] => GET

[mtime] => 0

[clength] => 0

[chunked] => 0

[content_type] => application/x-httpd-php

[no_cache] => 0

[no_local_copy] => 1

[unparsed_uri] => /dir/index.php?var=value

[uri] => /dir/index.php

[filename] => /home/htdocs/dir/index.php

[args] => var=value

[allowed] => 0

[sent_bodyct] => 0

[bytes_sent] => 0

[request_time] => 1074282764

)

file exists!

]]>

</screen>

</example>

</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

-->