gedcomx-php-client
  • Namespace
  • Class

Namespaces

  • Gedcomx
    • Agent
    • Atom
    • Common
    • Conclusion
    • Extensions
      • FamilySearch
        • Platform
          • Artifacts
          • Discussions
          • Tree
          • Users
        • Rs
          • Client
            • FamilyTree
            • Helpers
            • Memories
            • Util
        • Rt
        • Types
    • GedcomxFile
    • Links
    • Records
    • Rs
      • Client
        • Exception
        • Options
        • Util
    • Rt
    • Search
    • Source
    • Support
    • Types
    • Util
    • Vocab

Classes

  • AncestryNode
  • AncestryTree
  • DataSource
  • DescendancyNode
  • DescendancyTree
  • EmbeddedLinkLoader
  • Embedding
  • GedcomxBaseSearchQueryBuilder
  • GedcomxPersonSearchQueryBuilder
  • GedcomxPlaceSearchQueryBuilder
  • HttpStatus
  • RdfCollection
  • RdfNode
  • SearchParameter

Class HttpStatus

A helper class with a predefined list of HTTP status codes and names.

Class HttpStatus

Namespace: Gedcomx\Rs\Client\Util
Package: Gedcomx\Rs\Client\Util
Located at Rs/Client/Util/HttpStatus.php

Methods summary

public static mixed
# getText( $code )

Gets the status name for the specified HTTP status code.

Gets the status name for the specified HTTP status code.

Parameters

$code

Returns

mixed

Constants summary

integer CONTINUE_

Equivalent to HTTP status 100. CONTINUE_ indicates that the client can continue with its request.

Equivalent to HTTP status 100. CONTINUE_ indicates that the client can continue with its request.
# 100
integer SWITCHING_PROTOCOLS

Equivalent to HTTP status 101. SWITCHING_PROTOCOLS indicates that the protocol version or protocol is being changed.

Equivalent to HTTP status 101. SWITCHING_PROTOCOLS indicates that the protocol version or protocol is being changed.
# 101
integer PROCESSING

Equivalent to HTTP status 102. PROCESSING indicates that the server has received and is processing the request, but no response is available yet.

Equivalent to HTTP status 102. PROCESSING indicates that the server has received and is processing the request, but no response is available yet.
# 102
integer OK

Equivalent to HTTP status 200. OK indicates that the request succeeded and that the requested information is in the response. This is the most common status code to receive.

Equivalent to HTTP status 200. OK indicates that the request succeeded and that the requested information is in the response. This is the most common status code to receive.
# 200
integer CREATED

Equivalent to HTTP status 201. CREATED indicates that the request resulted in a new resource created before the response was sent.

Equivalent to HTTP status 201. CREATED indicates that the request resulted in a new resource created before the response was sent.
# 201
integer ACCEPTED

Equivalent to HTTP status 202. ACCEPTED indicates that the request has been accepted for further processing.

Equivalent to HTTP status 202. ACCEPTED indicates that the request has been accepted for further processing.
# 202
integer NON_AUTHORITATIVE_INFORMATION

Equivalent to HTTP status 203. NON_AUTHORITATIVE_INFORMATION indicates that the returned metainformation is from a cached copy instead of the origin server and therefore may be incorrect.

Equivalent to HTTP status 203. NON_AUTHORITATIVE_INFORMATION indicates that the returned metainformation is from a cached copy instead of the origin server and therefore may be incorrect.
# 203
integer NO_CONTENT

Equivalent to HTTP status 204. NO_CONTENT indicates that the request has been successfully processed and that the response is intentionally blank.

Equivalent to HTTP status 204. NO_CONTENT indicates that the request has been successfully processed and that the response is intentionally blank.
# 204
integer RESET_CONTENT

Equivalent to HTTP status 205. RESET_CONTENT indicates that the client should reset (not reload) the current resource.

Equivalent to HTTP status 205. RESET_CONTENT indicates that the client should reset (not reload) the current resource.
# 205
integer PARTIAL_CONTENT

Equivalent to HTTP status 206. PARTIAL_CONTENT indicates that the response is a partial response as requested by a'GET' request that includes a byte range.

Equivalent to HTTP status 206. PARTIAL_CONTENT indicates that the response is a partial response as requested by a'GET' request that includes a byte range.
# 206
integer MULTI_STATUS

Equivalent to HTTP status 207. MULTI_STATUS indicates the message body that follows is an XML message and can contain a number of separate response codes, depending on how many sub-requests were made.

Equivalent to HTTP status 207. MULTI_STATUS indicates the message body that follows is an XML message and can contain a number of separate response codes, depending on how many sub-requests were made.
# 207
integer ALREADY_REPORTED

Equivalent to HTTP status 208. ALREADY_REPORTED indicates the members of a DAV binding have already been enumerated in a previous reply to this request, and are not being included again.

Equivalent to HTTP status 208. ALREADY_REPORTED indicates the members of a DAV binding have already been enumerated in a previous reply to this request, and are not being included again.
# 208
integer IM_USED

Equivalent to HTTP status 226. IM_USED indicates the server has fulfilled a request for the resource, and the response is a representation of the result of one or more instance-manipulations applied to the current instance.

Equivalent to HTTP status 226. IM_USED indicates the server has fulfilled a request for the resource, and the response is a representation of the result of one or more instance-manipulations applied to the current instance.
# 226
integer MULTIPLE_CHOICES

Equivalent to HTTP status 300. MULTIPLE_CHOICES (or AMBIGUOUS) indicates that the requested information has multiple representations. The default action is to treat this status as a redirect and follow the contents of the Location header associated with this response.

Equivalent to HTTP status 300. MULTIPLE_CHOICES (or AMBIGUOUS) indicates that the requested information has multiple representations. The default action is to treat this status as a redirect and follow the contents of the Location header associated with this response.
# 300
integer MOVED_PERMANENTLY

Equivalent to HTTP status 301. MOVED_PERMANENTLY (or MOVED) indicates that the requested information has been moved to the URI specified in the Location header. The default action when this status is received is to follow the Location header associated with the response.

Equivalent to HTTP status 301. MOVED_PERMANENTLY (or MOVED) indicates that the requested information has been moved to the URI specified in the Location header. The default action when this status is received is to follow the Location header associated with the response.
# 301
integer FOUND

Equivalent to HTTP status 302. FOUND (or REDIRECT) indicates that the requested information is located at the URI specified in the Location header. The default action when this status is received is to follow the Location header associated with the response. When the original request method was POST, the redirected request will use the'GET' method.

Equivalent to HTTP status 302. FOUND (or REDIRECT) indicates that the requested information is located at the URI specified in the Location header. The default action when this status is received is to follow the Location header associated with the response. When the original request method was POST, the redirected request will use the'GET' method.
# 302
integer SEE_OTHER

Equivalent to HTTP status 303. SEE_OTHER (or REDIRECT_METHOD) automatically redirects the client to the URI specified in the Location header as the result of a POST. The request to the resource specified by the Location header will be made with a'GET'.

Equivalent to HTTP status 303. SEE_OTHER (or REDIRECT_METHOD) automatically redirects the client to the URI specified in the Location header as the result of a POST. The request to the resource specified by the Location header will be made with a'GET'.
# 303
integer NOT_MODIFIED

Equivalent to HTTP status 304. NOT_MODIFIED indicates that the client's cached copy is up to date. The contents of the resource are not transferred.

Equivalent to HTTP status 304. NOT_MODIFIED indicates that the client's cached copy is up to date. The contents of the resource are not transferred.
# 304
integer USE_PROXY

Equivalent to HTTP status 305. USE_PROXY indicates that the request should use the proxy server at the URI specified in the Location header.

Equivalent to HTTP status 305. USE_PROXY indicates that the request should use the proxy server at the URI specified in the Location header.
# 305
integer TEMPORARY_REDIRECT

Equivalent to HTTP status 307. TEMPORARY_REDIRECT (or REDIRECT_KEEP_VERB) indicates that the request information is located at the URI specified in the Location header. The default action when this status is received is to follow the Location header associated with the response. When the original request method was POST, the redirected request will also use the POST method.

Equivalent to HTTP status 307. TEMPORARY_REDIRECT (or REDIRECT_KEEP_VERB) indicates that the request information is located at the URI specified in the Location header. The default action when this status is received is to follow the Location header associated with the response. When the original request method was POST, the redirected request will also use the POST method.
# 307
integer PERMANENT_REDIRECT

Equivalent to HTTP status 308. PERMANENT_REDIRECT indicates the request, and all future requests should be repeated using another URI. 307 and 308 parallel the behaviours of 302 and 301, but do not allow the HTTP method to change.

Equivalent to HTTP status 308. PERMANENT_REDIRECT indicates the request, and all future requests should be repeated using another URI. 307 and 308 parallel the behaviours of 302 and 301, but do not allow the HTTP method to change.
# 308
integer BAD_REQUEST

Equivalent to HTTP status 400. BAD_REQUEST indicates that the request could not be understood by the server. BAD_REQUEST is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code.

Equivalent to HTTP status 400. BAD_REQUEST indicates that the request could not be understood by the server. BAD_REQUEST is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code.
# 400
integer UNAUTHORIZED

Equivalent to HTTP status 401. UNAUTHORIZED indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication.

Equivalent to HTTP status 401. UNAUTHORIZED indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication.
# 401
integer PAYMENT_REQUIRED

Equivalent to HTTP status 402. PAYMENT_REQUIRED is reserved for future use.

Equivalent to HTTP status 402. PAYMENT_REQUIRED is reserved for future use.
# 402
integer FORBIDDEN

Equivalent to HTTP status 403. FORBIDDEN indicates that the server refuses to fulfill the request.

Equivalent to HTTP status 403. FORBIDDEN indicates that the server refuses to fulfill the request.
# 403
integer NOT_FOUND

Equivalent to HTTP status 404. NOT_FOUND indicates that the requested resource does not exist on the server.

Equivalent to HTTP status 404. NOT_FOUND indicates that the requested resource does not exist on the server.
# 404
integer METHOD_NOT_ALLOWED

Equivalent to HTTP status 405. METHOD_NOT_ALLOWED indicates that the request method (POST or'GET') is not allowed on the requested resource.

Equivalent to HTTP status 405. METHOD_NOT_ALLOWED indicates that the request method (POST or'GET') is not allowed on the requested resource.
# 405
integer NOT_ACCEPTABLE

Equivalent to HTTP status 406. NOT_ACCEPTABLE indicates that the client has indicated with Accept headers that it will not accept any of the available representations of the resource.

Equivalent to HTTP status 406. NOT_ACCEPTABLE indicates that the client has indicated with Accept headers that it will not accept any of the available representations of the resource.
# 406
integer PROXY_AUTHENTICATION_REQUIRED

Equivalent to HTTP status 407. PROXY_AUTHENTICATION_REQUIRED indicates that the requested proxy requires authentication. The Proxy-authenticate header contains the details of how to perform the authentication.

Equivalent to HTTP status 407. PROXY_AUTHENTICATION_REQUIRED indicates that the requested proxy requires authentication. The Proxy-authenticate header contains the details of how to perform the authentication.
# 407
integer REQUEST_TIMEOUT

Equivalent to HTTP status 408. REQUEST_TIMEOUT indicates that the client did not send a request within the time the server was expecting the request.

Equivalent to HTTP status 408. REQUEST_TIMEOUT indicates that the client did not send a request within the time the server was expecting the request.
# 408
integer CONFLICT

Equivalent to HTTP status 409. CONFLICT indicates that the request could not be carried out because of a conflict on the server.

Equivalent to HTTP status 409. CONFLICT indicates that the request could not be carried out because of a conflict on the server.
# 409
integer GONE

Equivalent to HTTP status 410. GONE indicates that the requested resource is no longer available.

Equivalent to HTTP status 410. GONE indicates that the requested resource is no longer available.
# 410
integer LENGTH_REQUIRED

Equivalent to HTTP status 411. LENGTH_REQUIRED indicates that the required Content-length header is missing.

Equivalent to HTTP status 411. LENGTH_REQUIRED indicates that the required Content-length header is missing.
# 411
integer PRECONDITION_FAILED

Equivalent to HTTP status 412. PRECONDITION_FAILED indicates that a condition set for this request failed, and the request cannot be carried out. Conditions are set with conditional request headers like If-Match, If-None-Match, or If-Unmodified-Since.

Equivalent to HTTP status 412. PRECONDITION_FAILED indicates that a condition set for this request failed, and the request cannot be carried out. Conditions are set with conditional request headers like If-Match, If-None-Match, or If-Unmodified-Since.
# 412
integer REQUEST_ENTITY_TOO_LARGE

Equivalent to HTTP status 413. REQUEST_ENTITY_TOO_LARGE indicates that the request is too large for the server to process.

Equivalent to HTTP status 413. REQUEST_ENTITY_TOO_LARGE indicates that the request is too large for the server to process.
# 413
integer REQUEST_URI_TOO_LONG

Equivalent to HTTP status 414. REQUEST_URI_TOO_LONG indicates that the URI is too long.

Equivalent to HTTP status 414. REQUEST_URI_TOO_LONG indicates that the URI is too long.
# 414
integer UNSUPPORTED_MEDIA_TYPE

Equivalent to HTTP status 415. UNSUPPORTED_MEDIA_TYPE indicates that the request is an unsupported type.

Equivalent to HTTP status 415. UNSUPPORTED_MEDIA_TYPE indicates that the request is an unsupported type.
# 415
integer REQUESTED_RANGE_NOT_SATISFIABLE

Equivalent to HTTP status 416. REQUESTED_RANGE_NOT_SATISFIABLE indicates that the range of data requested from the resource cannot be returned, either because the beginning of the range is before the beginning of the resource, or the end of the range is after the end of the resource.

Equivalent to HTTP status 416. REQUESTED_RANGE_NOT_SATISFIABLE indicates that the range of data requested from the resource cannot be returned, either because the beginning of the range is before the beginning of the resource, or the end of the range is after the end of the resource.
# 416
integer EXPECTATION_FAILED

Equivalent to HTTP status 417. EXPECTATION_FAILED indicates that an expectation given in an Expect header could not be met by the server.

Equivalent to HTTP status 417. EXPECTATION_FAILED indicates that an expectation given in an Expect header could not be met by the server.
# 417
integer UNPROCESSABLE_ENTITY

Equivalent to HTTP status 422. UNPROCESSABLE_ENTITY indicates the server cannot meet the requirements of the Expect request-header field.

Equivalent to HTTP status 422. UNPROCESSABLE_ENTITY indicates the server cannot meet the requirements of the Expect request-header field.
# 422
integer LOCKED

Equivalent to HTTP status 423. LOCKED indicates the resource that is being accessed is locked.

Equivalent to HTTP status 423. LOCKED indicates the resource that is being accessed is locked.
# 423
integer FAILED_DEPENDENCY

Equivalent to HTTP status 424. FAILED_DEPENDENCY indicates the request failed due to failure of a previous request.

Equivalent to HTTP status 424. FAILED_DEPENDENCY indicates the request failed due to failure of a previous request.
# 424
integer RESERVED_FOR_WEBDAV_ADVANCED_COLLECTIONS_EXPIRED_PROPOSAL

Equivalent to HTTP status 425.

Equivalent to HTTP status 425.
# 425
integer UPGRADE_REQUIRED

Equivalent to HTTP status 426. UPGRADE_REQUIRED indicates the client should switch to a different protocol such as TLS/1.0.

Equivalent to HTTP status 426. UPGRADE_REQUIRED indicates the client should switch to a different protocol such as TLS/1.0.
# 426
integer PRECONDITION_REQUIRED

Equivalent to HTTP status 428. PRECONDITION_REQUIRED indicates the origin server requires the request to be conditional.

Equivalent to HTTP status 428. PRECONDITION_REQUIRED indicates the origin server requires the request to be conditional.
# 428
integer TOO_MANY_REQUESTS

Equivalent to HTTP status 429. TOO_MANY_REQUESTS indicates the user has sent too many requests in a given amount of time.

Equivalent to HTTP status 429. TOO_MANY_REQUESTS indicates the user has sent too many requests in a given amount of time.
# 429
integer REQUEST_HEADER_FIELDS_TOO_LARGE

Equivalent to HTTP status 431. REQUEST_HEADER_FIELDS_TOO_LARGE indicates the server is unwilling to process the request because either an individual header field, or all the header fields collectively, are too large.

Equivalent to HTTP status 431. REQUEST_HEADER_FIELDS_TOO_LARGE indicates the server is unwilling to process the request because either an individual header field, or all the header fields collectively, are too large.
# 431
integer INTERNAL_SERVER_ERROR

Equivalent to HTTP status 500. INTERNAL_SERVER_ERROR indicates that a generic error has occurred on the server.

Equivalent to HTTP status 500. INTERNAL_SERVER_ERROR indicates that a generic error has occurred on the server.
# 500
integer NOT_IMPLEMENTED

Equivalent to HTTP status 501. NOT_IMPLEMENTED indicates that the server does not support the requested function.

Equivalent to HTTP status 501. NOT_IMPLEMENTED indicates that the server does not support the requested function.
# 501
integer BAD_GATEWAY

Equivalent to HTTP status 502. BAD_GATEWAY indicates that an intermediate proxy server received a bad response from another proxy or the origin server.

Equivalent to HTTP status 502. BAD_GATEWAY indicates that an intermediate proxy server received a bad response from another proxy or the origin server.
# 502
integer SERVICE_UNAVAILABLE

Equivalent to HTTP status 503. SERVICE_UNAVAILABLE indicates that the server is temporarily unavailable, usually due to high load or maintenance.

Equivalent to HTTP status 503. SERVICE_UNAVAILABLE indicates that the server is temporarily unavailable, usually due to high load or maintenance.
# 503
integer GATEWAY_TIMEOUT

Equivalent to HTTP status 504. GATEWAY_TIMEOUT indicates that an intermediate proxy server timed out while waiting for a response from another proxy or the origin server.

Equivalent to HTTP status 504. GATEWAY_TIMEOUT indicates that an intermediate proxy server timed out while waiting for a response from another proxy or the origin server.
# 504
integer HTTP_VERSION_NOT_SUPPORTED

Equivalent to HTTP status 505. HTTP_VERSION_NOT_SUPPORTED indicates that the requested HTTP version is not supported by the server.

Equivalent to HTTP status 505. HTTP_VERSION_NOT_SUPPORTED indicates that the requested HTTP version is not supported by the server.
# 505
integer VARIANT_ALSO_NEGOTIATES_EXPERIMENTAL

Equivalent to HTTP status 506. VARIANT_ALSO_NEGOTIATES_EXPERIMENTAL indicates the transparent content negotiation for the request results in a circular reference.

Equivalent to HTTP status 506. VARIANT_ALSO_NEGOTIATES_EXPERIMENTAL indicates the transparent content negotiation for the request results in a circular reference.
# 506
integer INSUFFICIENT_STORAGE

Equivalent to HTTP status 507. INSUFFICIENT_STORAGE indicates the server is unable to store the representation needed to complete the request.

Equivalent to HTTP status 507. INSUFFICIENT_STORAGE indicates the server is unable to store the representation needed to complete the request.
# 507
integer LOOP_DETECTED

Equivalent to HTTP status 508. LOOP_DETECTED indicates the server detected an infinite loop while processing the request (sent in lieu of 208 Already Reported).

Equivalent to HTTP status 508. LOOP_DETECTED indicates the server detected an infinite loop while processing the request (sent in lieu of 208 Already Reported).
# 508
integer NOT_EXTENDED

Equivalent to HTTP status 510. NOT_EXTENDED indicates that further extensions to the request are required for the server to fulfil it.

Equivalent to HTTP status 510. NOT_EXTENDED indicates that further extensions to the request are required for the server to fulfil it.
# 510
integer NETWORK_AUTHENTICATION_REQUIRED

Equivalent to HTTP status 511. NETWORK_AUTHENTICATION_REQUIRED indicates the client needs to authenticate to gain network access.

Equivalent to HTTP status 511. NETWORK_AUTHENTICATION_REQUIRED indicates the client needs to authenticate to gain network access.
# 511
gedcomx-php-client API documentation generated by ApiGen