CakePHP
  • Documentation
    • Book
    • API
    • Videos
    • Reporting Security Issues
    • Privacy Policy
    • Logos & Trademarks
  • Business Solutions
  • Swag
  • Road Trip
  • Team
  • Community
    • Community
    • Get Involved
    • Issues (Github)
    • Bakery
    • Featured Resources
    • Training
    • Meetups
    • My CakePHP
    • CakeFest
    • Newsletter
    • Linkedin
    • YouTube
    • Facebook
    • Twitter
    • Mastodon
    • Help & Support
    • Forum
    • Stack Overflow
    • IRC
    • Slack
    • Paid Support
CakePHP

C CakePHP 4.6 Strawberry API

  • Project:
    • CakePHP
      • CakePHP
      • Authentication
      • Authorization
      • Chronos
      • Elastic Search
      • Queue
  • Version:
    • 4.6
      • 5.2
      • 5.1
      • 5.0
      • 4.6
      • 4.5
      • 4.4
      • 4.3
      • 4.2
      • 4.1
      • 4.0
      • 3.10
      • 3.9
      • 3.8
      • 3.7
      • 3.6
      • 3.5
      • 3.4
      • 3.3
      • 3.2
      • 3.1
      • 3.0
      • 2.10
      • 2.9
      • 2.8
      • 2.7
      • 2.6
      • 2.5
      • 2.4
      • 2.3
      • 2.2
      • 2.1
      • 2.0
      • 1.3
      • 1.2

Namespaces

  • Global
  • Cake
    • Auth
    • Cache
    • Collection
    • Command
    • Console
    • Controller
    • Core
    • Database
    • Datasource
    • Error
    • Event
    • Filesystem
    • Form
    • Http
      • Client
        • Adapter
        • Auth
        • Exception
      • Cookie
      • Exception
      • Middleware
      • Session
      • TestSuite
    • I18n
    • Log
    • Mailer
    • Network
    • ORM
    • Routing
    • Shell
    • TestSuite
    • Utility
    • Validation
    • View

Class FormData

Provides an interface for building multipart/form-encoded message bodies.

Used by Http\Client to upload POST/PUT data and files.

Namespace: Cake\Http\Client

Property Summary

  • $_boundary protected
    string

    Boundary marker.

  • $_hasComplexPart protected
    bool

    Whether this formdata object has a complex part.

  • $_hasFile protected
    bool

    Whether this formdata object has attached files.

  • $_parts protected
    array<Cake\Http\Client\FormDataPart>

    The parts in the form data.

Method Summary

  • __toString() public

    Converts the FormData and its parts into a string suitable for use in an HTTP request.

  • add() public

    Add a new part to the data.

  • addFile() public

    Add either a file reference (string starting with @) or a file handle.

  • addMany() public

    Add multiple parts at once.

  • addRecursive() public

    Recursively add data.

  • boundary() public

    Get the boundary marker

  • contentType() public

    Get the content type for this payload.

  • count() public

    Returns the count of parts inside this object.

  • hasFile() public

    Check whether the current payload has any files.

  • isMultipart() public

    Check whether the current payload is multipart.

  • newPart() public

    Method for creating new instances of Part

Method Detail

__toString() ¶ public

__toString(): string

Converts the FormData and its parts into a string suitable for use in an HTTP request.

Returns
string

add() ¶ public

add(Cake\Http\Client\FormDataPart|string $name, mixed $value = null): $this

Add a new part to the data.

The value for a part can be a string, array, int, float, filehandle, or object implementing __toString()

If the $value is an array, multiple parts will be added. Files will be read from their current position and saved in memory.

Parameters
Cake\Http\Client\FormDataPart|string $name

The name of the part to add, or the part data object.

mixed $value optional

The value for the part.

Returns
$this

addFile() ¶ public

addFile(string $name, string|resource|Psr\Http\Message\UploadedFileInterface $value): Cake\Http\Client\FormDataPart

Add either a file reference (string starting with @) or a file handle.

Parameters
string $name

The name to use.

string|resource|Psr\Http\Message\UploadedFileInterface $value

Either a string filename, or a filehandle, or a UploadedFileInterface instance.

Returns
Cake\Http\Client\FormDataPart

addMany() ¶ public

addMany(array $data): $this

Add multiple parts at once.

Iterates the parameter and adds all the key/values.

Parameters
array $data

Array of data to add.

Returns
$this

addRecursive() ¶ public

addRecursive(string $name, mixed $value): void

Recursively add data.

Parameters
string $name

The name to use.

mixed $value

The value to add.

Returns
void

boundary() ¶ public

boundary(): string

Get the boundary marker

Returns
string

contentType() ¶ public

contentType(): string

Get the content type for this payload.

If this object contains files, multipart/form-data will be used, otherwise application/x-www-form-urlencoded will be used.

Returns
string

count() ¶ public

count(): int

Returns the count of parts inside this object.

Returns
int

hasFile() ¶ public

hasFile(): bool

Check whether the current payload has any files.

Returns
bool

isMultipart() ¶ public

isMultipart(): bool

Check whether the current payload is multipart.

A payload will become multipart when you add files or use add() with a Part instance.

Returns
bool

newPart() ¶ public

newPart(string $name, string $value): Cake\Http\Client\FormDataPart

Method for creating new instances of Part

Parameters
string $name

The name of the part.

string $value

The value to add.

Returns
Cake\Http\Client\FormDataPart

Property Detail

$_boundary ¶ protected

Boundary marker.

Type
string

$_hasComplexPart ¶ protected

Whether this formdata object has a complex part.

Type
bool

$_hasFile ¶ protected

Whether this formdata object has attached files.

Type
bool

$_parts ¶ protected

The parts in the form data.

Type
array<Cake\Http\Client\FormDataPart>
OpenHub
Pingping
Linode
  • Business Solutions
  • Showcase
  • Documentation
  • Book
  • API
  • Videos
  • Reporting Security Issues
  • Privacy Policy
  • Logos & Trademarks
  • Community
  • Get Involved
  • Issues (Github)
  • Bakery
  • Featured Resources
  • Training
  • Meetups
  • My CakePHP
  • CakeFest
  • Newsletter
  • Linkedin
  • YouTube
  • Facebook
  • Twitter
  • Mastodon
  • Help & Support
  • Forum
  • Stack Overflow
  • IRC
  • Slack
  • Paid Support

Generated using CakePHP API Docs