README.md 2.59 KB
Newer Older
Simon Welsh's avatar
Simon Welsh committed
1 2 3 4 5
# Hack wrappers for request-based super globals

[![build status][build-image]][build-link]

This package provides Hack wrappers for the `$_GET`, `$_POST`, `$_REQUEST`,
6
`$_COOKIE`, `$_FILES` and `$_SERVER` super globals.
Simon Welsh's avatar
Simon Welsh committed
7

8 9 10 11
## Quick start

A quick start guide is provided in the [wiki][wiki-quick]

Simon Welsh's avatar
Simon Welsh committed
12 13 14 15 16 17 18
## Installation

The easiest way to install this package is with [Composer][composer].

Manual installation simply involves downloading the provided source code and
copying it into your repository.

19 20 21 22 23 24
Detailed installation steps are provided in the [wiki][wiki-install].

## Usage

Usgae information is provided in the [wiki][wiki-usage].

Simon Welsh's avatar
Simon Welsh committed
25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45
## Issues

Issues can be submitted to the [issue tacker][issues].

If you are unable to create an issue through this, or think that it should not
be publicly disclosed, they can also be emailed directly to
[issues@91carriage.com][issue-email] or brought to my attention on IRC, where I
go by the handles `simon_w` and `simon_w|air` in the offical [#hhvm][hhvm-irc]
channel on FreeNode.

## Contributing

Contributions are very welcome. Please make sure that you run `hh_client` in the
source directory with `assume_php=false` in your `.hhconfig` and no errors are
reported.

### Code style

For Hack files, the coding style is enforced by the `hh_format` command, which
is included with the Hack tools alongside `hh_client`.

Simon Welsh's avatar
Simon Welsh committed
46 47
All Hack files should be in strict mode. When a super global needs to be
accessed, use a `/* HH_FIXME */` comment to surppress the typechecker's errors.
Simon Welsh's avatar
Simon Welsh committed
48 49 50 51 52 53

For other files, the basic requirements are:
* Lines are no more than 80 characters wherever possible.
* Indentation is 2 spaces.
* Unix-style (`\n`) line endings.

54 55 56 57
## Documentation

Documentation is provided in the [wiki][wiki-home].

Simon Welsh's avatar
Simon Welsh committed
58 59 60 61 62 63
## License

This code is provided under the MIT (X11 variant) license. The full text of
which can be found in the [LICENSE.md](LICENSE.md) file.

<!-- Please keep these sorted alphabetically. -->
Simon Welsh's avatar
Simon Welsh committed
64 65
[build-image]: https://git.simon.geek.nz/91-carriage/hack-requests/badges/master/build.svg
[build-link]: https://git.simon.geek.nz/91-carriage/hack-requests/commits/master
Simon Welsh's avatar
Simon Welsh committed
66 67 68
[composer]: https://getcomposer.org/
[hhvm-irc]: http://webchat.freenode.net/?channels=hhvm
[issue-email]: mailto:issues@91carriage.com
69
[issues]: https://git.simon.geek.nz/91-carriage/hack-requests/issues
70 71 72 73
[wiki-home]: https://git.simon.geek.nz/91-carriage/hack-requests/wikis/Home
[wiki-install]: https://git.simon.geek.nz/91-carriage/hack-requests/wikis/Installation
[wiki-quick]: https://git.simon.geek.nz/91-carriage/hack-requests/wikis/Quick-start
[wiki-usage]: https://git.simon.geek.nz/91-carriage/hack-requests/wikis/Basic-usage