class BrokenPostRequestException

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

Defines an exception used, when the POST HTTP body is broken.

Hierarchy

  • class \Drupal\Core\Form\Exception\BrokenPostRequestException implements \Symfony\Component\HttpKernel\Exception\BadRequestHttpException

Expanded class hierarchy of BrokenPostRequestException

4 files declare their use of BrokenPostRequestException
FormAjaxSubscriber.php in core/lib/Drupal/Core/Form/EventSubscriber/FormAjaxSubscriber.php
FormAjaxSubscriberTest.php in core/tests/Drupal/Tests/Core/Form/EventSubscriber/FormAjaxSubscriberTest.php
FormBuilder.php in core/lib/Drupal/Core/Form/FormBuilder.php
FormBuilderTest.php in core/tests/Drupal/Tests/Core/Form/FormBuilderTest.php

File

core/lib/Drupal/Core/Form/Exception/BrokenPostRequestException.php, line 12

Namespace

Drupal\Core\Form\Exception
View source
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;
  }

}

Members

Title Sort descending Modifiers Object type Summary
BrokenPostRequestException::$size protected property The maximum upload size.
BrokenPostRequestException::getSize public function Returns the maximum upload size in bytes.
BrokenPostRequestException::__construct public function Constructs a new BrokenPostRequestException.

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