PHP Classes
elePHPant
Icontem

File: README.md

Recommend this page to a friend!
  Classes of Josantonius  >  PHP HTTP Status Code  >  README.md  >  Download  
File: README.md
Role: Documentation
Content type: text/markdown
Description: Documentation
Class: PHP HTTP Status Code
Get descriptions of HTTP response status codes
Author: By
Last change: Updated to 1.1.5 version
Updated to 1.1.4 version
Date: 11 days ago
Size: 6,967 bytes
 

Contents

Class file image Download

PHP HTTPStatusCode library

Latest Stable Version Latest Unstable Version License Codacy BadgeTotal Downloads Travis PSR2 PSR4 CodeCov

Versión en español

PHP library to get the meaning from HTTP response status codes.

Requirements

This library is supported by PHP versions 5.6 or higher and is compatible with HHVM versions 3.0 or higher.

Installation

The preferred way to install this extension is through Composer.

To install PHP HTTPStatusCode library, simply:

$ composer require Josantonius/HTTPStatusCode

The previous command will only install the necessary files, if you prefer to download the entire source code you can use:

$ composer require Josantonius/HTTPStatusCode --prefer-source

You can also clone the complete repository with Git:

$ git clone https://github.com/Josantonius/PHP-HTTPStatusCode.git

Or install it manually:

Download HTTPStatusCode.php:

$ wget https://raw.githubusercontent.com/Josantonius/PHP-HTTPStatusCode/master/src/HTTPStatusCode.php

Download HTTPStatusCodeCollection.php:

$ wget https://raw.githubusercontent.com/Josantonius/PHP-HTTPStatusCodeCollection/master/src/HTTPStatusCodeCollection.php

Available Methods

Available methods in this library:

- Get meaning from an HTTP response code:

HTTPStatusCode::get($code, $lang, $size);

| Attribute | Description | Type | Required | Default | --- | --- | --- | --- | --- | | $code| HTTP response code. | mixed | Yes | | | $lang| Language for definition: 'es' or 'en' | string | No | 'en' | | $size| Definition size: 'short' or 'large' | string | No | 'short' |

# Return (string|false) ? HTTP status code definition or false if not exists

- Get all meanings in a array:

HTTPStatusCode::getAll($lang);

| Attribute | Description | Type | Required | Default | --- | --- | --- | --- | --- | | $lang| Language for definition: 'es' or 'en' | string | No | 'en' |

# Return (array|false) ? all definitions of HTTP response codes

Quick Start

To use this library with Composer:

require __DIR__ . '/vendor/autoload.php';

use Josantonius\HTTPStatusCode\HTTPStatusCode;

Or If you installed it manually, use it:

require_once __DIR__ . '/HTTPStatusCode.php';

use Josantonius\HTTPStatusCode\HTTPStatusCode;

Usage

Example of use for this library:

- Get the short english meaning of an HTTP response code:

HTTPStatusCode::get(200);

- Get the short spanish meaning of an HTTP response code:

HTTPStatusCode::get(200, 'es');

- Get the detailed english meaning of an HTTP response code:

HTTPStatusCode::get(200, 'en', 'large');

- Get the detailed spanish meaning of an HTTP response code:

HTTPStatusCode::get(200, 'es', 'large');

- Get the short english meaning of an HTTP response code:

HTTPStatusCode::get(200, 'en', 'short');

- Get the short spanish meaning of an HTTP response code:

HTTPStatusCode::get(200, 'es', 'short');

- Get a english HTTP response code array:

HTTPStatusCode::getAll();

- Get a spanish HTTP response code array:

HTTPStatusCode::getAll('es');

List in JSON format

Go to the resource.

Tests

To run tests you just need composer and to execute the following:

$ git clone https://github.com/Josantonius/PHP-HTTPStatusCode.git

$ cd PHP-HTTPStatusCode

$ composer install

Run unit tests with PHPUnit:

$ composer phpunit

Run PSR2 code standard tests with PHPCS:

$ composer phpcs

Run PHP Mess Detector tests to detect inconsistencies in code style:

$ composer phpmd

Run all previous tests:

$ composer tests

? TODO

  • [ ] Add new feature
  • [ ] Improve tests
  • [ ] Improve documentation
  • [ ] Refactor code

Contribute

If you would like to help, please take a look at the list of issues or the To Do checklist.

Pull requests

  • Fork and clone.
  • Run the command composer install to install the dependencies. This will also install the dev dependencies.
  • Run the command composer fix to excute code standard fixers.
  • Run the tests.
  • Create a branch, commit, push and send me a pull request.

Repository

The file structure from this repository was created with PHP-Skeleton.

License

This project is licensed under MIT license. See the LICENSE file for more info.

Copyright

2017 Josantonius, josantonius.com

If you find it useful, let me know :wink:

You can contact me on Twitter or through my email.