【PHP8.x】postnameプロパティの使い方

postnameプロパティの使い方について、初心者にもわかりやすく解説します。

作成日: 更新日:

基本的な使い方

postnameプロパティは、CURLFileオブジェクトが表すファイルをHTTPリクエストでアップロードする際に、そのファイルに割り当てるフォームフィールド名を保持するプロパティです。PHPのCURL拡張機能を使用し、Webサーバーにファイルを送信する際に利用されます。

CURLFileクラスは、アップロードするファイルのパス、MIMEタイプ、そしてこのpostnameプロパティで指定するフォームフィールド名をカプセル化するために設計されています。通常、Webアプリケーションにおいてファイルをサーバーへアップロードする場合、そのファイルは特定の「名前」を付けて送信されます。例えば、HTMLフォームで<input type="file" name="document">と指定されていれば、サーバー側ではdocumentという名前でファイルを受け取ります。このpostnameプロパティは、このようなフォームフィールド名をプログラム側から指定するために使用されます。

もしこのpostnameプロパティが明示的に設定されない場合、デフォルトではCURLFileオブジェクトが表す元のファイル名がフォームフィールド名として使用されます。サーバー側でファイルを特定の名前で受け取る必要がある場合や、元のファイル名とは異なる論理的な名前を付けて送信したい場合に、このpostnameプロパティを設定することが重要です。これにより、アップロード処理の柔軟性が高まります。

構文(syntax)

1<?php
2$curlFile = new CURLFile('/path/to/file.txt', 'text/plain');
3$curlFile->postname = 'my_upload_field';

引数(parameters)

戻り値(return)

string

CURLFile オブジェクトにアップロードされるファイルの名前を表す文字列です。

【PHP8.x】postnameプロパティの使い方 | いっしー@Webエンジニア