BrokenPostRequestException.php

Same filename in other branches
  1. 9 core/lib/Drupal/Core/Form/Exception/BrokenPostRequestException.php
  2. 8.9.x core/lib/Drupal/Core/Form/Exception/BrokenPostRequestException.php
  3. 11.x core/lib/Drupal/Core/Form/Exception/BrokenPostRequestException.php

Namespace

Drupal\Core\Form\Exception

File

core/lib/Drupal/Core/Form/Exception/BrokenPostRequestException.php

View source
<?php

declare (strict_types=1);
namespace Drupal\Core\Form\Exception;

use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;

/**
 * Defines an exception used, when the POST HTTP body is broken.
 */
class BrokenPostRequestException extends BadRequestHttpException {
    
    /**
     * The maximum upload size.
     *
     * @var int
     */
    protected int $size;
    
    /**
     * Constructs a new BrokenPostRequestException.
     *
     * @param int $max_upload_size
     *   The size of the maximum upload size in bytes.
     * @param string $message
     *   The internal exception message.
     * @param \Exception|null $previous
     *   The previous exception.
     * @param int $code
     *   The internal exception code.
     */
    public function __construct(int $max_upload_size, string $message = '', ?\Exception $previous = NULL, int $code = 0) {
        parent::__construct($message, $previous, $code);
        $this->size = $max_upload_size;
    }
    
    /**
     * Returns the maximum upload size in bytes.
     *
     * @return int
     *   The file size limit in bytes based on the PHP upload_max_filesize and
     *   post_max_size.
     */
    public function getSize() : int {
        return $this->size;
    }

}

Classes

Title Deprecated Summary
BrokenPostRequestException Defines an exception used, when the POST HTTP body is broken.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.