https://github.com/p-seven-v/telegraph-api

https://github.com/p-seven-v/telegraph-api

Last synced: about 14 hours ago
JSON representation

• Host: GitHub
• URL: https://github.com/p-seven-v/telegraph-api
• Owner: p-seven-v
• License: mit
• Created: 2021-12-19T23:46:48.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2022-04-28T09:02:05.000Z (over 2 years ago)
• Last Synced: 2024-04-17T12:00:50.654Z (7 months ago)
• Language: PHP
• Size: 104 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Telegra.ph API for PHP

[![Packagist](https://img.shields.io/packagist/v/p7v/telegraph-api.svg)](https://packagist.org/packages/p7v/telegraph-api)

[![License](https://img.shields.io/github/license/mashape/apistatus.svg)](LICENSE.md)

This package lets you work with [telegra.ph](http://telegra.ph) API.

## Contents

- [Installation](#installation)

- [Usage](#usage)

- [Changelog](#changelog)

- [Roadmap](#roadmap)

- [Contributing](#contributing)

- [Credits](#credits)

- [License](#license)

## Disclaimer

^1.0 version here is a copy of deploykit/telegraph-api project. That package is discontinued in favor of this one.

This package replaces that one, and for backward compatibility it even contains legacy namespace.

^2.0 will have it changed to correspond to vendor name - P7V.

## Installation

To get the latest version of Telegra.ph API client simply require the project using [Composer](https://getcomposer.org):

```bash

$ composer require p7v/telegraph-api

```

Or you can manually update your require block and run `composer update` if you choose so:

```json

{

    "require": {

        "p7v/telegraph-api": "^1.0"

    }

}

```

## Usage

All methods in Telegraph Client class correspond to API methods that are described in [Telegraph API documentation](http://telegra.ph/api).

```php

$telegraph = new \Deploykit\Telegraph\Client();

$telegraph->createAccount('Author', 'Author name', 'http://example.com');

```

All entities' classes implement ArrayAccess, so any property of any class can be accessed either in object style or in array style.

For all methods that require `access_token`, you can either provide a string with your token or provide instance of `\Deploykit\Telegraph\Entities\Account` class.

## Changelog

Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.

## Roadmap

All future features are documented in [Roadmap GitHub project](https://github.com/p7v/telegraph-api/projects/1).

## Contributing

Please see [CONTRIBUTING](CONTRIBUTING.md) for details.

## Credits

- [Alexey Plekhanov](https://github.com/alexsoft)

- [All Contributors](../../contributors)

## License

The MIT License (MIT). Please see [License File](LICENSE) for more information.