https://github.com/pxgamer/phishtank-php
A simple PHP wrapper for the PhishTank API.
https://github.com/pxgamer/phishtank-php
api phishtank php wrapper
Last synced: 3 months ago
JSON representation
A simple PHP wrapper for the PhishTank API.
- Host: GitHub
- URL: https://github.com/pxgamer/phishtank-php
- Owner: pxgamer
- License: mit
- Created: 2017-02-27T16:18:36.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2018-06-22T15:02:59.000Z (over 7 years ago)
- Last Synced: 2025-01-23T19:38:42.510Z (9 months ago)
- Topics: api, phishtank, php, wrapper
- Language: PHP
- Homepage: https://packagist.org/packages/pxgamer/phishtank-php
- Size: 40 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# phishtank-php
[![Latest Version on Packagist][ico-version]][link-packagist]
[![Software License][ico-license]](LICENSE.md)
[![Build Status][ico-travis]][link-travis]
[![Style CI][ico-styleci]][link-styleci]
[![Code Coverage][ico-code-quality]][link-code-quality]
[![Total Downloads][ico-downloads]][link-downloads]
A simple PHP wrapper for the [PhishTank][pt] API.
## Structure
If any of the following are applicable to your project, then the directory structure should follow industry best practises by being named the following.
```
src/
tests/
vendor/
```
## Install
Via Composer
``` bash
$ composer require pxgamer/phishtank-php
```
## Usage
**__construct($url, $api_key = null)**
This will initialise the object with all details.
```php
// Api Key parameter is optional. Should be a string if included.
$client = new \pxgamer\PhishTank\Hook($url);
```
**getResults()**
This will refresh the results and fetch new ones from the server.
#### Example code
```php
use pxgamer\PhishTank\Hook;
$result = new Hook('https://github.com');
echo '
' . print_r($result, true) . '
';
```
#### Example response
```php
pxgamer\PhishTank\Hook Object
(
[url:pxgamer\PhishTank\Hook:private] => https://github.com
[requestData:pxgamer\PhishTank\Hook:private] => Array
(
[format] => json
[url] => https://github.com
)
[app_key:pxgamer\PhishTank\Hook:private] =>
[meta:pxgamer\PhishTank\Hook:private] => pxgamer\PhishTank\Meta Object
(
[timestamp:protected] => DateTime Object
(
[date] => 2017-08-07 13:18:13.000000
[timezone_type] => 1
[timezone] => +00:00
)
[serverid:protected] => ab9f6c17
[status:protected] => 1
[requestid:protected] => 146.112.225.22.59886895b52782.72884672
)
[results:pxgamer\PhishTank\Hook:private] => pxgamer\PhishTank\Results Object
(
[url:protected] => https://github.com
[in_database:protected] =>
[phish_id:protected] =>
[phish_detail_page:protected] =>
[verified:protected] =>
[verified_at:protected] =>
[valid:protected] =>
)
)
```
## Change log
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Testing
``` bash
$ composer test
```
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) and [CODE_OF_CONDUCT](CODE_OF_CONDUCT.md) for details.
## Security
If you discover any security related issues, please email owzie123@gmail.com instead of using the issue tracker.
## Credits
- [pxgamer][link-author]
- [All Contributors][link-contributors]
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
[pt]: https://www.phishtank.com
[ico-version]: https://img.shields.io/packagist/v/pxgamer/phishtank-php.svg?style=flat-square
[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square
[ico-travis]: https://img.shields.io/travis/pxgamer/phishtank-php/master.svg?style=flat-square
[ico-styleci]: https://styleci.io/repos/83330775/shield
[ico-code-quality]: https://img.shields.io/codecov/c/github/pxgamer/phishtank-php.svg?style=flat-square
[ico-downloads]: https://img.shields.io/packagist/dt/pxgamer/phishtank-php.svg?style=flat-square
[link-packagist]: https://packagist.org/packages/pxgamer/phishtank-php
[link-travis]: https://travis-ci.org/pxgamer/phishtank-php
[link-styleci]: https://styleci.io/repos/83330775
[link-code-quality]: https://codecov.io/gh/pxgamer/phishtank-php
[link-downloads]: https://packagist.org/packages/pxgamer/phishtank-php
[link-author]: https://github.com/pxgamer
[link-contributors]: ../../contributors