curl-getinfo.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 56171c30f4f4bb558537d9f5b400f21fdd2ebee8 Maintainer: hirokawa Status: ready -->
<!-- Reviewed: no -->
<!-- CREDITS: takagi,mumumu -->
<refentry xml:id="function.curl-getinfo" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>curl_getinfo</refname>
  <refpurpose>指定した伝送に関する情報を得る</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>mixed</type><methodname>curl_getinfo</methodname>
   <methodparam><type>CurlHandle</type><parameter>handle</parameter></methodparam>
   <methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>option</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
  <para>
   直近の転送に関する情報を取得します。
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    &curl.ch.description;
    <varlistentry>
     <term><parameter>option</parameter></term>
     <listitem>
      <para>
       <constant>CURLINFO_<replaceable>*</replaceable></constant>
       定数のうち、ひとつを指定できます。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   <parameter>option</parameter> を指定した場合は、その値を返します。
   それ以外の場合は、以下の要素をもつ連想配列を返します
   (それぞれの要素が <parameter>option</parameter> に対応します)。
   失敗した場合は &false; を返します。
   <itemizedlist>
    <listitem>
     <simpara>
      "url"
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      "content_type"
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      "http_code"
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      "header_size"
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      "request_size"
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      "filetime"
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      "ssl_verify_result"
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      "redirect_count"
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      "total_time"
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      "namelookup_time"
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      "connect_time"
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      "pretransfer_time"
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      "size_upload"
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      "size_download"
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      "speed_download"
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      "speed_upload"
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      "download_content_length"
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      "upload_content_length"
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      "starttransfer_time"
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      "redirect_time"
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      "certinfo"
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      "primary_ip"
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      "primary_port"
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      "local_ip"
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      "local_port"
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      "redirect_url"
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      "request_header" (これが設定されるのは、事前に <function>curl_setopt</function>
      をコールしたときに <constant>CURLINFO_HEADER_OUT</constant> を設定した場合のみです)
     </simpara>
    </listitem>
   </itemizedlist>
   プライベートデータはこの連想配列には含まれず、<constant>CURLINFO_PRIVATE</constant> オプションで個別に取得しなければいけないことに注意しましょう。
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <para>
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>8.3.0</entry>
       <entry>
        <constant>CURLINFO_CAINFO</constant>
        と <constant>CURLINFO_CAPATH</constant> が追加されました。
       </entry>
      </row>
      <row>
       <entry>8.2.0</entry>
       <entry>
        <constant>CURLINFO_PROXY_ERROR</constant>,
        <constant>CURLINFO_REFERER</constant>,
        <constant>CURLINFO_RETRY_AFTER</constant> が追加されました。
       </entry>
      </row>
      &curl.changelog.handle-param;
      <row>
       <entry>8.0.0</entry>
       <entry>
        <parameter>option</parameter> は nullable になりました。
        これより前のバージョンでは、デフォルト値は <literal>0</literal> でした。
       </entry>
      </row>
      <row>
       <entry>7.3.0</entry>
       <entry>
        <constant>CURLINFO_CONTENT_LENGTH_DOWNLOAD_T</constant>,
        <constant>CURLINFO_CONTENT_LENGTH_UPLOAD_T</constant>,
        <constant>CURLINFO_HTTP_VERSION</constant>,
        <constant>CURLINFO_PROTOCOL</constant>,
        <constant>CURLINFO_PROXY_SSL_VERIFYRESULT</constant>,
        <constant>CURLINFO_SCHEME</constant>,
        <constant>CURLINFO_SIZE_DOWNLOAD_T</constant>,
        <constant>CURLINFO_SIZE_UPLOAD_T</constant>,
        <constant>CURLINFO_SPEED_DOWNLOAD_T</constant>,
        <constant>CURLINFO_SPEED_UPLOAD_T</constant>,
        <constant>CURLINFO_APPCONNECT_TIME_T</constant>,
        <constant>CURLINFO_CONNECT_TIME_T</constant>,
        <constant>CURLINFO_FILETIME_T</constant>,
        <constant>CURLINFO_NAMELOOKUP_TIME_T</constant>,
        <constant>CURLINFO_PRETRANSFER_TIME_T</constant>,
        <constant>CURLINFO_REDIRECT_TIME_T</constant>,
        <constant>CURLINFO_STARTTRANSFER_TIME_T</constant>,
        <constant>CURLINFO_TOTAL_TIME_T</constant> が追加されました。
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>curl_getinfo</function> の例</title>
    <programlisting role="php">
<![CDATA[
<?php
// cURL ハンドルを作成します
$ch = curl_init('http://www.example.com/');

// 実行します
curl_exec($ch);

// エラーが発生したかどうかを確認します
if (!curl_errno($ch)) {
  $info = curl_getinfo($ch);
  echo 'Took ', $info['total_time'], ' seconds to send a request to ', $info['url'], "\n";
}

// ハンドルを閉じます
curl_close($ch);
?>
]]>
    </programlisting>
   </example>
  </para>
  <para>
   <example>
    <title><function>curl_getinfo</function> で <parameter>option</parameter> パラメータを使う例</title>
    <programlisting role="php">
<![CDATA[
<?php
// cURL ハンドルを作成します
$ch = curl_init('http://www.example.com/');

// 実行します
curl_exec($ch);

// HTTP ステータスコードを調べます
if (!curl_errno($ch)) {
  switch ($http_code = curl_getinfo($ch, CURLINFO_HTTP_CODE)) {
    case 200:  # OK
      break;
    default:
      echo 'Unexpected HTTP code: ', $http_code, "\n";
  }
}

// ハンドルを閉じます
curl_close($ch);
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <para>
    この関数で収集した情報を、ハンドルを再利用するとそのまま保持されます。
    つまり、この関数で内部的に統計情報を上書きしない限りは以前の情報が返されるということです。
   </para>
  </note>
 </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
-->