PostFileInterface.php

<?php

namespace Guzzle\Http\Message;

use Guzzle\Common\Exception\InvalidArgumentException;

/**
 * POST file upload
 */
interface PostFileInterface {

  /**
   * Set the name of the field
   *
   * @param string $name Field name
   *
   * @return self
   */
  public function setFieldName($name);

  /**
   * Get the name of the field
   *
   * @return string
   */
  public function getFieldName();

  /**
   * Set the path to the file
   *
   * @param string $path Full path to the file
   *
   * @return self
   * @throws InvalidArgumentException if the file cannot be read
   */
  public function setFilename($path);

  /**
   * Get the full path to the file
   *
   * @return string
   */
  public function getFilename();

  /**
   * Set the Content-Type of the file
   *
   * @param string $type Content type
   *
   * @return self
   */
  public function setContentType($type);

  /**
   * Get the Content-Type of the file
   *
   * @return string
   */
  public function getContentType();

  /**
   * Get a cURL ready string for the upload
   *
   * @return string
   */
  public function getCurlString();

}