Contents

Cms\Classes\AjaxApiResponse

Overview

AjaxResponse

Extends
  • Illuminate\Http\Response
  • Symfony\Component\HttpFoundation\Response
Implements
  • Stringable
  • ArrayAccess

Public Properties

There are no public properties in the class.

Show inherited public properties

Inherited Public Properties

  • $headers - (defined in Symfony\Component\HttpFoundation\Response)
  • $statusTexts - Status codes translation table. (defined in Symfony\Component\HttpFoundation\Response)
  • $original - The original content of the response. (defined in Illuminate\Http\Response)
  • $exception - The exception that triggered the error response (if applicable). (defined in Illuminate\Http\Response)

Protected Properties

protected array $pageVars

pageVars are variables included on the page

protected string $ajaxRedirectUrl

protected array $ajaxFlashMessages

Show inherited protected properties

Inherited Protected Properties

  • $content - (defined in Symfony\Component\HttpFoundation\Response)
  • $version - (defined in Symfony\Component\HttpFoundation\Response)
  • $statusCode - (defined in Symfony\Component\HttpFoundation\Response)
  • $statusText - (defined in Symfony\Component\HttpFoundation\Response)
  • $charset - (defined in Symfony\Component\HttpFoundation\Response)
  • $macros - The registered string macros. (defined in Illuminate\Http\Response)

Public Methods

public addFlashMessages()

public addFlashMessages($messages): static

addFlashMessages is used internally

public addPageVars()

public addPageVars($vars): static

addPageVars is used internally

public getAjaxRedirectUrl()

public getAjaxRedirectUrl(): string

getRedirectUrl

public isAjaxRedirect()

public isAjaxRedirect(): bool

public offsetExists()

public offsetExists($offset): bool

offsetExists implementation

public offsetGet()

public offsetGet($offset): mixed

offsetGet implementation

public offsetSet()

public offsetSet($offset, $value): void

offsetSet implementation

public offsetUnset()

public offsetUnset($offset): void

offsetUnset implementation

public setAjaxRedirect()

public setAjaxRedirect($response): void

setRedirectUrl

public setHandlerException()

public setHandlerException($exception): static

setException

public setHandlerResponse()

public setHandlerResponse($content): static

setContent captures the variables from a handler and merges any resulting data

public withPageVars()

public withPageVars(): static

withPageVars includes the page vars in the response. This does not happen by default for security reasons.

public withVars()

public withVars($vars): static

withVars the given variables in to the response data.

Show inherited public methods

Inherited Public Methods

  • __call() - Dynamically handle calls to the class. (defined in Illuminate\Http\Response)
  • __callStatic() - Dynamically handle calls to the class. (defined in Illuminate\Http\Response)
  • __clone() - Clones the current Response instance. (defined in Symfony\Component\HttpFoundation\Response)
  • __construct() - Create a new HTTP response. (defined in Illuminate\Http\Response)
  • __toString() - Returns the Response as an HTTP string. (defined in Symfony\Component\HttpFoundation\Response)
  • closeOutputBuffers() - Cleans or flushes output buffers up to target level. (defined in Symfony\Component\HttpFoundation\Response)
  • content() - Get the content of the response. (defined in Illuminate\Http\Response)
  • cookie() - Add a cookie to the response. (defined in Illuminate\Http\Response)
  • expire() - Marks the response stale by setting the Age header to be equal to the maximum age of the response. (defined in Symfony\Component\HttpFoundation\Response)
  • flushMacros() - Flush the existing macros. (defined in Illuminate\Http\Response)
  • getAge() - Returns the age of the response in seconds. (defined in Symfony\Component\HttpFoundation\Response)
  • getCallback() - Get the callback of the response. (defined in Illuminate\Http\Response)
  • getCharset() - Retrieves the response charset. (defined in Symfony\Component\HttpFoundation\Response)
  • getContent() - Get the response content. (defined in Illuminate\Http\Response)
  • getDate() - Returns the Date header as a DateTime instance. (defined in Symfony\Component\HttpFoundation\Response)
  • getEtag() - Returns the literal value of the ETag HTTP header. (defined in Symfony\Component\HttpFoundation\Response)
  • getExpires() - Returns the value of the Expires header as a DateTime instance. (defined in Symfony\Component\HttpFoundation\Response)
  • getLastModified() - Returns the Last-Modified HTTP header as a DateTime instance. (defined in Symfony\Component\HttpFoundation\Response)
  • getMaxAge() - Returns the number of seconds after the time specified in the response's Date. (defined in Symfony\Component\HttpFoundation\Response)
  • getOriginalContent() - Get the original response content. (defined in Illuminate\Http\Response)
  • getProtocolVersion() - Gets the HTTP protocol version. (defined in Symfony\Component\HttpFoundation\Response)
  • getStatusCode() - Retrieves the status code for the current web response. (defined in Symfony\Component\HttpFoundation\Response)
  • getTtl() - Returns the response's time-to-live in seconds. (defined in Symfony\Component\HttpFoundation\Response)
  • getVary() - Returns an array of header names given in the Vary header. (defined in Symfony\Component\HttpFoundation\Response)
  • hasMacro() - Checks if macro is registered. (defined in Illuminate\Http\Response)
  • hasVary() - Returns true if the response includes a Vary header. (defined in Symfony\Component\HttpFoundation\Response)
  • header() - Set a header on the Response. (defined in Illuminate\Http\Response)
  • isCacheable() - Returns true if the response may safely be kept in a shared (surrogate) cache. (defined in Symfony\Component\HttpFoundation\Response)
  • isClientError() - Is there a client error? (defined in Symfony\Component\HttpFoundation\Response)
  • isEmpty() - Is the response empty? (defined in Symfony\Component\HttpFoundation\Response)
  • isForbidden() - Is the response forbidden? (defined in Symfony\Component\HttpFoundation\Response)
  • isFresh() - Returns true if the response is "fresh". (defined in Symfony\Component\HttpFoundation\Response)
  • isImmutable() - Returns true if the response is marked as "immutable". (defined in Symfony\Component\HttpFoundation\Response)
  • isInformational() - Is response informative? (defined in Symfony\Component\HttpFoundation\Response)
  • isInvalid() - Is response invalid? (defined in Symfony\Component\HttpFoundation\Response)
  • isNotFound() - Is the response a not found error? (defined in Symfony\Component\HttpFoundation\Response)
  • isNotModified() - Determines if the Response validators (ETag, Last-Modified) match. (defined in Symfony\Component\HttpFoundation\Response)
  • isOk() - Is the response OK? (defined in Symfony\Component\HttpFoundation\Response)
  • isRedirect() - Is the response a redirect of some form? (defined in Symfony\Component\HttpFoundation\Response)
  • isRedirection() - Is the response a redirect? (defined in Symfony\Component\HttpFoundation\Response)
  • isServerError() - Was there a server side error? (defined in Symfony\Component\HttpFoundation\Response)
  • isSuccessful() - Is response successful? (defined in Symfony\Component\HttpFoundation\Response)
  • isValidateable() - Returns true if the response includes headers that can be used to validate. (defined in Symfony\Component\HttpFoundation\Response)
  • macro() - Register a custom macro. (defined in Illuminate\Http\Response)
  • macroCall() - Dynamically handle calls to the class. (defined in Illuminate\Http\Response)
  • mixin() - Mix another object into the class. (defined in Illuminate\Http\Response)
  • mustRevalidate() - Returns true if the response must be revalidated by shared caches once it has become stale. (defined in Symfony\Component\HttpFoundation\Response)
  • prepare() - Prepares the Response before it is sent to the client. (defined in Symfony\Component\HttpFoundation\Response)
  • send() - Sends HTTP headers and content. (defined in Symfony\Component\HttpFoundation\Response)
  • sendContent() - Sends content for the current web response. (defined in Symfony\Component\HttpFoundation\Response)
  • sendHeaders() - Sends HTTP headers. (defined in Symfony\Component\HttpFoundation\Response)
  • setCache() - Sets the response's cache headers (validation and/or expiration). (defined in Symfony\Component\HttpFoundation\Response)
  • setCharset() - Sets the response charset. (defined in Symfony\Component\HttpFoundation\Response)
  • setClientTtl() - Sets the response's time-to-live for private/client caches in seconds. (defined in Symfony\Component\HttpFoundation\Response)
  • setContent() - Set the content on the response. (defined in Illuminate\Http\Response)
  • setContentSafe() - Marks a response as safe according to RFC8674. (defined in Symfony\Component\HttpFoundation\Response)
  • setDate() - Sets the Date header. (defined in Symfony\Component\HttpFoundation\Response)
  • setEtag() - Sets the ETag value. (defined in Symfony\Component\HttpFoundation\Response)
  • setExpires() - Sets the Expires HTTP header with a DateTime instance. (defined in Symfony\Component\HttpFoundation\Response)
  • setImmutable() - Marks the response as "immutable". (defined in Symfony\Component\HttpFoundation\Response)
  • setLastModified() - Sets the Last-Modified HTTP header with a DateTime instance. (defined in Symfony\Component\HttpFoundation\Response)
  • setMaxAge() - Sets the number of seconds after which the response should no longer be considered fresh. (defined in Symfony\Component\HttpFoundation\Response)
  • setNotModified() - Modifies the response so that it conforms to the rules defined for a 304 status code. (defined in Symfony\Component\HttpFoundation\Response)
  • setPrivate() - Marks the response as "private". (defined in Symfony\Component\HttpFoundation\Response)
  • setProtocolVersion() - Sets the HTTP protocol version (1.0 or 1.1). (defined in Symfony\Component\HttpFoundation\Response)
  • setPublic() - Marks the response as "public". (defined in Symfony\Component\HttpFoundation\Response)
  • setSharedMaxAge() - Sets the number of seconds after which the response should no longer be considered fresh by shared caches. (defined in Symfony\Component\HttpFoundation\Response)
  • setStaleIfError() - Sets the number of seconds after which the response should no longer be returned by shared caches when backend is down. (defined in Symfony\Component\HttpFoundation\Response)
  • setStaleWhileRevalidate() - Sets the number of seconds after which the response should no longer return stale content by shared caches. (defined in Symfony\Component\HttpFoundation\Response)
  • setStatusCode() - Sets the response status code. (defined in Symfony\Component\HttpFoundation\Response)
  • setTtl() - Sets the response's time-to-live for shared caches in seconds. (defined in Symfony\Component\HttpFoundation\Response)
  • setVary() - Sets the Vary header. (defined in Symfony\Component\HttpFoundation\Response)
  • status() - Get the status code for the response. (defined in Illuminate\Http\Response)
  • statusText() - Get the status text for the response. (defined in Illuminate\Http\Response)
  • throwResponse() - Throws the response in a HttpResponseException instance. (defined in Illuminate\Http\Response)
  • withCookie() - Add a cookie to the response. (defined in Illuminate\Http\Response)
  • withCookies() - Add multiple cookies to the response. (defined in Illuminate\Http\Response)
  • withException() - Set the exception to attach to the response. (defined in Illuminate\Http\Response)
  • withHeaders() - Add an array of headers to the response. (defined in Illuminate\Http\Response)
  • withoutCookie() - Expire a cookie when sending the response. (defined in Illuminate\Http\Response)
  • withoutCookies() - Expire multiple cookies when sending the response. (defined in Illuminate\Http\Response)
  • withoutHeader() - Remove a header(s) from the response. (defined in Illuminate\Http\Response)

Protected Methods

Show inherited protected methods

Inherited Protected Methods

  • ensureIEOverSSLCompatibility() - Checks if we need to remove Cache-Control for SSL encrypted downloads when using IE < 9. (defined in Symfony\Component\HttpFoundation\Response)
  • morphToJson() - Morph the given content into JSON. (defined in Illuminate\Http\Response)
  • shouldBeJson() - Determine if the given content should be turned into JSON. (defined in Illuminate\Http\Response)