# Snatch PHP #
Copyright (c) 2017-2018 Manuel Rubio
__Authors:__ "Manuel Rubio" ([`manuel@altenwald.com`](mailto:manuel@altenwald.com)).
[](https://travis-ci.org/snatch-xmpp/snatch_php)
[](https://codecov.io/gh/snatch-xmpp/snatch_php)
[](https://raw.githubusercontent.com/snatch-xmpp/snatch_php/master/LICENSE)
[](https://hex.pm/packages/snatch_php)
Snatch PHP is an extension for [snatch](https://github.com/snatch-xmpp/snatch) to provide to the system of a way use PHP to handle the incoming information from the claws.
Installation
------------
The system requires OTP 19+ and we prefer to use [rebar3](http://www.rebar3.org) instead of older versions. To install claws_rest only needs:
```erlang
{deps, [
{snatch_php, "0.2.1"}
]}
```
Or if you are using [erlang.mk](https://erlang.mk) instead, you can use:
```Makefile
DEPS += snatch_php
dep_snatch = git https://github.com/snatch-xmpp/snatch_php.git 0.2.1
```
You'll need a C/C++ compiler installed in your system for [fast_xml](https://github.com/processone/fast_xml) and [stringprep](https://github.com/processone/stringprep).
For further information [check this doc](doc/how-to/snatch_php.md).
Getting Started
---------------
First of all, you need to have clear the concepts behind XMPP. What's a XMPP Server? What's a XMPP Component? How works XMPP? You don't need to be an expert but you have to have an acknowledge about those concepts before start.
What we are going to create this time is a bot client. This means we're not going to use it as XMPP Component. We are going to create the client to perform the auth against a XMPP Server and then wait for incoming requests from other clients.
The most tricky part will be the roster concept to add to others when the real users wanted to add to us in their rosters.
You can follow [the whole text here](https://medium.com/@bosqueviejo/developing-a-bot-using-tdd-on-erlang-without-write-a-single-line-of-code-in-erlang-5278e28b0356)
Troubleshooting
---------------
Feel free to create an issue in github to point a bug, flaw or improvement and even send a pull request with a specific change. Read the [LICENSE](http://github.com/snatch-xmpp/snatch-php/blob/master/doc/LICENSE) if you have doubts about what you can do with the code.
Enjoy!
## Modules ##
<table width="100%" border="0" summary="list of modules">
<tr><td><a href="http://github.com/snatch-xmpp/snatch-php/blob/master/doc/ephp_lib_snatch.md" class="module">ephp_lib_snatch</a></td></tr>
<tr><td><a href="http://github.com/snatch-xmpp/snatch-php/blob/master/doc/snatch_php.md" class="module">snatch_php</a></td></tr></table>
