Commit 80ce3980 authored by LONGMAN's avatar LONGMAN

Code rewrited on PSR-2 standard. Added CONTRIBUTING.md for contributors

parent e12787a9
Contributing
-------------
Before you contribute code to php-telegram-bot, please make sure it conforms to the PHPCS coding standard and that the php-telegram-bot unit tests still pass. The easiest way to contribute is to work on a checkout of the repository, or your own fork, rather than an installed PEAR version. If you do this, you can run the following commands to check if everything is ready to submit:
cd php-telegram-bot
composer update
vendor/bin/phpcs --report=full --extensions=php -p --standard=build/phpcs .
Which should give you no output, indicating that there are no coding standard errors. And then:
phpunit
Which should give you no failures or errors. You can ignore any skipped tests as these are for external tools.
\ No newline at end of file
......@@ -100,14 +100,14 @@ Create set.php and put:
```php
<?php
$loader = require __DIR__.'/vendor/autoload.php';
$loader = require \_\_DIR\_\_.'/vendor/autoload.php';
$API_KEY = 'your_bot_api_key';
$API\_KEY = 'your\_bot\_api\_key';
$BOT_NAME = 'namebot';
try {
// create Telegram API object
$telegram = new Longman\TelegramBot\Telegram($API_KEY, $BOT_NAME);
$telegram = new Longman\TelegramBot\Telegram($API\_KEY, $BOT\_NAME);
// set webhook
echo $telegram->setWebHook('https://yourdomain/yourpath_to_hook.php');
......@@ -123,9 +123,9 @@ After create hook.php and put:
```php
<?php
$loader = require __DIR__.'/vendor/autoload.php';
$loader = require \_\_DIR\_\_.'/vendor/autoload.php';
$API_KEY = 'your_bot_api_key';
$API\_KEY = 'your\_bot\_api\_key';
$BOT_NAME = 'namebot';
try {
......@@ -154,11 +154,19 @@ $telegram->enableMySQL($credentials);
This code is available on [Github][0]. Pull requests are welcome.
Troubleshooting
---------------
-------------
If you like living on the edge, please report any bugs you find on the [PHP Telegram Bot issues](https://github.com/akalongman/php-telegram-bot/issues) page.
Contributing
-------------
See [CONTRIBUTING.md](CONTRIBUTING.md) for information.
## Credits
Created by [Avtandil Kikabidze][1].
......
......@@ -17,51 +17,9 @@
<!-- Include some additional sniffs from the Generic standard -->
<rule ref="PEAR.Classes.ClassDeclaration"/>
<rule ref="Squiz.Classes.SelfMemberReference"/>
<rule ref="PEAR.Commenting.InlineComment"/>
<rule ref="Generic.Files.LineEndings"/>
<rule ref="PEAR.Formatting.MultiLineAssignment"/>
<rule ref="Generic.Functions.FunctionCallArgumentSpacing"/>
<rule ref="PEAR.NamingConventions.ValidClassName"/>
<rule ref="Generic.NamingConventions.UpperCaseConstantName"/>
<rule ref="Generic.PHP.DisallowShortOpenTag"/>
<rule ref="Generic.PHP.DeprecatedFunctions"/>
<rule ref="Generic.PHP.ForbiddenFunctions"/>
<rule ref="Squiz.Operators.IncrementDecrementUsage">
<exclude name="Squiz.Operators.IncrementDecrementUsage.processAssignment"/>
</rule>
<rule ref="Squiz.Scope.StaticThisUsage"/>
<rule ref="Squiz.WhiteSpace.ScopeClosingBrace"/>
<!-- Lines can be 85 chars long, but never show errors -->
<rule ref="Generic.Files.LineLength">
<properties>
<property name="lineLimit" value="150"/>
<property name="absoluteLineLimit" value="0"/>
</properties>
</rule>
<!-- Use Unix newlines -->
<rule ref="Generic.Files.LineEndings">
<properties>
<property name="eolChar" value="\n"/>
</properties>
</rule>
<!-- This message is not required as spaces are allowed for alignment -->
<rule ref="Generic.Functions.FunctionCallArgumentSpacing.TooMuchSpaceAfterComma">
<severity>0</severity>
<rule ref="PSR2">
<exclude name="PEAR.Functions.FunctionCallSignature"/>
<exclude name="PEAR.Functions.FunctionCallSignature.SpaceAfterCloseBracket"/>
</rule>
</ruleset>
......@@ -4,7 +4,7 @@
"Read more about it at https://getcomposer.org/doc/01-basic-usage.md#composer-lock-the-lock-file",
"This file is @generated automatically"
],
"hash": "02634aa637830c6e9324925abceb4624",
"hash": "e4b463e1eea6333a1eaf38457a54b29c",
"packages": [
{
"name": "hoa/compiler",
......@@ -1868,7 +1868,7 @@
"prefer-stable": false,
"prefer-lowest": false,
"platform": {
"php": ">=5.3.0",
"php": ">=5.4.0",
"ext-pdo": "*"
},
"platform-dev": []
......
<?php
/*
* This file is part of the TelegramBot package.
*
......@@ -6,7 +7,7 @@
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
*/
namespace Longman\TelegramBot;
use Longman\TelegramBot\Entities\Update;
......@@ -24,55 +25,63 @@ abstract class Command
protected $enabled = true;
protected $name = '';
public function __construct(Telegram $telegram) {
public function __construct(Telegram $telegram)
{
$this->telegram = $telegram;
}
public function setUpdate(Update $update) {
public function setUpdate(Update $update)
{
$this->update = $update;
$this->message = $this->update->getMessage();
return $this;
}
abstract public function execute();
public abstract function execute();
public function getUpdate() {
public function getUpdate()
{
return $this->update;
}
public function getMessage() {
public function getMessage()
{
return $this->message;
}
public function getTelegram() {
public function getTelegram()
{
return $this->telegram;
}
public function setCommand($command) {
public function setCommand($command)
{
$this->command = $command;
return $this;
}
public function getUsage() {
public function getUsage()
{
return $this->usage;
}
public function getVersion() {
public function getVersion()
{
return $this->version;
}
public function getDescription() {
public function getDescription()
{
return $this->description;
}
public function getName() {
public function getName()
{
return $this->name;
}
public function isEnabled() {
public function isEnabled()
{
return $this->enabled;
}
}
<?php
/*
* This file is part of the TelegramBot package.
*
......@@ -8,7 +9,7 @@
* file that was distributed with this source code.
*
* Written by Marco Boretto <marco.bore@gmail.com>
*/
*/
namespace Longman\TelegramBot\Commands;
use Longman\TelegramBot\Request;
......@@ -23,17 +24,15 @@ class CalcCommand extends Command
protected $version = '1.0.0';
protected $enabled = true;
public function execute() {
public function execute()
{
$update = $this->getUpdate();
$message = $this->getMessage();
$chat_id = $message->getChat()->getId();
$message_id = $message->getMessageId();
$text = $message->getText(true);
$data = array();
$data['chat_id'] = $chat_id;
$data['reply_to_message_id'] = $message_id;
......@@ -43,13 +42,11 @@ class CalcCommand extends Command
return $result;
}
protected function compute($expression) {
protected function compute($expression)
{
// Load the compiler
$compiler = \Hoa\Compiler\Llk::load(
new \Hoa\File\Read('hoa://Library/Math/Arithmetic.pp')
);
$compiler = \Hoa\Compiler\Llk::load(new \Hoa\File\Read('hoa://Library/Math/Arithmetic.pp'));
// Load the visitor, aka the "evaluator"
$visitor = new \Hoa\Math\Visitor\Arithmetic();
......@@ -62,7 +59,4 @@ class CalcCommand extends Command
return $result;
}
}
<?php
/*
* This file is part of the TelegramBot package.
*
......@@ -6,12 +7,13 @@
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
*/
namespace Longman\TelegramBot\Commands;
use Longman\TelegramBot\Request;
use Longman\TelegramBot\Command;
use Longman\TelegramBot\Entities\Update;
use Longman\TelegramBot\Exception\TelegramException;
class DateCommand extends Command
{
......@@ -21,24 +23,19 @@ class DateCommand extends Command
protected $version = '1.0.0';
protected $enabled = true;
private $google_api_key = '';
private $base_url = 'https://maps.googleapis.com/maps/api';
private $date_format = 'd-m-Y H:i:s';
private function getCoordinates($location) {
$url = $this->base_url.'/geocode/json?';
$params = 'address='.urlencode($location);
private function getCoordinates($location)
{
$url = $this->base_url . '/geocode/json?';
$params = 'address=' . urlencode($location);
if (!empty($this->google_api_key)) {
$params .= '&key='.$this->google_api_key;
$params.= '&key=' . $this->google_api_key;
}
$data = $this->request($url.$params);
$data = $this->request($url . $params);
if (empty($data)) {
return false;
}
......@@ -60,21 +57,18 @@ class DateCommand extends Command
return array($lat, $lng, $acc, $types);
}
private function getDate($lat, $lng) {
$url = $this->base_url.'/timezone/json?';
private function getDate($lat, $lng)
{
$url = $this->base_url . '/timezone/json?';
$timestamp = time();
$params = 'location='.urlencode($lat).','.urlencode($lng).'&timestamp='.urlencode($timestamp);
$params = 'location=' . urlencode($lat) . ',' . urlencode($lng) . '&timestamp=' . urlencode($timestamp);
if (!empty($this->google_api_key)) {
$params .= '&key='.$this->google_api_key;
$params.= '&key=' . $this->google_api_key;
}
$data = $this->request($url.$params);
$data = $this->request($url . $params);
if (empty($data)) {
return false;
}
......@@ -88,87 +82,75 @@ class DateCommand extends Command
return false;
}
$local_time = $timestamp + $data['rawOffset'] + $data['dstOffset'];
return array($local_time, $data['timeZoneId']);
}
private function getFormattedDate($location) {
private function getFormattedDate($location)
{
if (empty($location)) {
return 'The time in nowhere is never';
}
list($lat, $lng, $acc, $types) = $this->getCoordinates($location);
if (empty($lat) || empty($lng)) {
return 'It seems that in "'.$location.'" they do not have a concept of time.';
return 'It seems that in "' . $location . '" they do not have a concept of time.';
}
list($local_time, $timezone_id) = $this->getDate($lat, $lng);
$date_utc = new \DateTime(date('Y-m-d H:i:s', $local_time), new \DateTimeZone($timezone_id));
//$timestamp = $date_utc->format($this->date_format);
$return = 'The local time in '.$timezone_id.' is: '.date($this->date_format, $local_time).'';
$return = 'The local time in ' . $timezone_id . ' is: ' . date($this->date_format, $local_time) . '';
return $return;
}
private function request($url) {
private function request($url)
{
$ch = curl_init();
$curlConfig = array(
CURLOPT_URL => $url,
CURLOPT_RETURNTRANSFER => true,
);
$curlConfig = array(CURLOPT_URL => $url, CURLOPT_RETURNTRANSFER => true,);
curl_setopt_array($ch, $curlConfig);
$response = curl_exec($ch);
$http_code = curl_getinfo($ch, CURLINFO_HTTP_CODE);
if ($http_code !== 200) {
throw new \Exception('Error receiving data from url');
throw new TelegramException('Error receiving data from url');
}
curl_close($ch);
return $response;
}
public function execute() {
public function execute()
{
$update = $this->getUpdate();
$message = $this->getMessage();
$chat_id = $message->getChat()->getId();
$message_id = $message->getMessageId();
$text = $message->getText(true);
if (empty($text)) {
$text = 'You must specify location in format: /date <city>';
} else {
$date = $this->getformattedDate($text);
if (empty($date)) {
$text = 'Can not find date for location: '.$text;
$text = 'Can not find date for location: ' . $text;
} else {
$text = $date;
}
}
$data = array();
$data['chat_id'] = $chat_id;
$data['reply_to_message_id'] = $message_id;
$data['text'] = $text;
$result = Request::sendMessage($data);
}
}
<?php
/*
* This file is part of the TelegramBot package.
*
......@@ -6,7 +7,7 @@
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
*/
namespace Longman\TelegramBot\Commands;
use Longman\TelegramBot\Request;
......@@ -21,25 +22,19 @@ class EchoCommand extends Command
protected $version = '1.0.0';
protected $enabled = true;
public function execute() {
public function execute()
{
$update = $this->getUpdate();
$message = $this->getMessage();
$chat_id = $message->getChat()->getId();
$text = $message->getText(true);
$data = array();
$data['chat_id'] = $chat_id;
$data['text'] = $text;
$result = Request::sendMessage($data);
return $result;
}
}
<?php
/*
* This file is part of the TelegramBot package.
*
......@@ -6,7 +7,7 @@
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
*/
namespace Longman\TelegramBot\Commands;
use Longman\TelegramBot\Request;
......@@ -21,52 +22,45 @@ class HelpCommand extends Command
protected $version = '1.0.0';
protected $enabled = true;
public function execute() {
public function execute()
{
$update = $this->getUpdate();
$message = $this->getMessage();
$chat_id = $message->getChat()->getId();
$message_id = $message->getMessageId();
$text = $message->getText(true);
$commands = $this->telegram->getCommandsList();
if (empty($text)) {
$msg = 'GeoBot v. '.$this->telegram->getVersion()."\n\n";
$msg .= 'Commands List:'."\n";
foreach($commands as $command) {
$msg = 'GeoBot v. ' . $this->telegram->getVersion() . "\n\n";
$msg.= 'Commands List:' . "\n";
foreach ($commands as $command) {
if (!$command->isEnabled()) {
continue;
}
$msg .= '/'.$command->getName().' - '.$command->getDescription()."\n";
$msg.= '/' . $command->getName() . ' - ' . $command->getDescription() . "\n";
}
$msg .= "\n".'For exact command help type: /help <command>';
$msg.= "\n" . 'For exact command help type: /help <command>';
} else {
$text = str_replace('/', '', $text);
if (isset($commands[$text])) {
$command = $commands[$text];
$msg = 'Command: '.$command->getName().' v'.$command->getVersion()."\n";
$msg .= 'Description: '.$command->getDescription()."\n";
$msg .= 'Usage: '.$command->getUsage();
$msg = 'Command: ' . $command->getName() . ' v' . $command->getVersion() . "\n";
$msg.= 'Description: ' . $command->getDescription() . "\n";
$msg.= 'Usage: ' . $command->getUsage();
} else {
$msg = 'Command '.$text.' not found';
$msg = 'Command ' . $text . ' not found';
}
}
$data = array();
$data['chat_id'] = $chat_id;
$data['reply_to_message_id'] = $message_id;
$data['text'] = $msg;
$result = Request::sendMessage($data);
return $result;
}
}
<?php
/*
* This file is part of the TelegramBot package.
*
......@@ -6,7 +7,7 @@
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
*/
namespace Longman\TelegramBot\Commands;
use Longman\TelegramBot\Request;
......@@ -21,16 +22,16 @@ class WeatherCommand extends Command
protected $version = '1.0.0';
protected $enabled = true;
private function getWeather($location) {
$url = 'http://api.openweathermap.org/data/2.5/weather?q='.$location.'&units=metric';
private function getWeather($location)
{
$url = 'http://api.openweathermap.org/data/2.5/weather?q=' . $location . '&units=metric';
$ch = curl_init();
$curlConfig = array(
CURLOPT_URL => $url,
$curlConfig = array(CURLOPT_URL => $url,
//CURLOPT_POST => true,
CURLOPT_RETURNTRANSFER => true,
//CURLOPT_HTTPHEADER => array('Content-Type: text/plain'),
//CURLOPT_POSTFIELDS => $data
//CURLOPT_VERBOSE => true,
......@@ -46,13 +47,11 @@ class WeatherCommand extends Command
}
curl_close($ch);
return $response;
}
private function getWeatherString($location) {
private function getWeatherString($location)
{
if (empty($location)) {
return false;
}
......@@ -66,63 +65,56 @@ class WeatherCommand extends Command
}
$city = $decode['name'];
$country = $decode['sys']['country'];
$temp = 'The temperature in '.$city .' (' .$country.') is '.$decode['main']['temp'].'°C';
$conditions = 'Current conditions are: '.$decode['weather'][0]['description'];
$temp = 'The temperature in ' . $city . ' (' . $country . ') is ' . $decode['main']['temp'] . '°C';
$conditions = 'Current conditions are: ' . $decode['weather'][0]['description'];
switch(strtolower($decode['weather'][0]['main'])) {
switch (strtolower($decode['weather'][0]['main'])) {
case 'clear':
$conditions .= ' ☀';
$conditions.= ' ☀';
break;
case 'clouds':
$conditions .= ' ☁☁';
$conditions.= ' ☁☁';
break;
case 'rain':
$conditions .= ' ☔';
$conditions.= ' ☔';
break;
case 'thunderstorm':
$conditions .= ' ☔☔☔☔';
$conditions.= ' ☔☔☔☔';
break;
}
return $temp."\n".$conditions;
return $temp . "\n" . $conditions;
}
public function execute() {
public function execute()
{
$update = $this->getUpdate();
$message = $this->getMessage();
$chat_id = $message->getChat()->getId();
$message_id = $message->getMessageId();
$text = $message->getText(true);
if (empty($text)) {
$text = 'You must specify location in format: /weather <city>';
} else {
$weather = $this->getWeatherString($text);
if (empty($weather)) {
$text = 'Can not find weather for location: '.$text;
$text = 'Can not find weather for location: ' . $text;
} else {
$text = $weather;
}
}
$data = array();
$data['chat_id'] = $chat_id;
$data['reply_to_message_id'] = $message_id;
$data['text'] = $text;
$result = Request::sendMessage($data);
return $result;
}
}
<?php
/*
* This file is part of the TelegramBot package.
*
......@@ -8,7 +9,7 @@
* file that was distributed with this source code.
*
* Written by Marco Boretto <marco.bore@gmail.com>
*/
*/
namespace Longman\TelegramBot\Commands;
......@@ -24,12 +25,11 @@ class WhoamiCommand extends Command
protected $version = '1.0.0';
protected $enabled = true;
public function execute() {
public function execute()
{
$update = $this->getUpdate();
$message = $this->getMessage();
$chat_id = $message->getChat()->getId();
$message_id = $message->getMessageId();
$text = $message->getText(true);
......@@ -38,14 +38,11 @@ class WhoamiCommand extends Command
$data['chat_id'] = $chat_id;
$data['reply_to_message_id'] = $message_id;
$data['text'] = 'Your Id: ' . $message->getFrom()->getId();
$data['text'] .= "\n".'Name: ' . $message->getFrom()->getFirstName().' '.$message->getFrom()->getLastName();
$data['text'] .= "\n".'Username: ' . $message->getFrom()->getUsername();
$data['text'] .= "\n" . 'Name: ' . $message->getFrom()->getFirstName()
. ' ' . $message->getFrom()->getLastName();
$data['text'] .= "\n" . 'Username: ' . $message->getFrom()->getUsername();
$result = Request::sendMessage($data);
return $result;
}
}
<?php
/*
* This file is part of the TelegramBot package.
*
......@@ -6,7 +7,7 @@
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
*/
namespace Longman\TelegramBot\Entities;
use Longman\TelegramBot\Exception\TelegramException;
......@@ -20,7 +21,8 @@ class Chat extends Entity
protected $last_name;
protected $username;
public function __construct(array $data) {
public function __construct(array $data)
{
$this->id = isset($data['id']) ? $data['id'] : null;
if (empty($this->id)) {
......@@ -31,35 +33,35 @@ class Chat extends Entity
$this->first_name = isset($data['first_name']) ? $data['first_name'] : null;
$this->last_name = isset($data['last_name']) ? $data['last_name'] : null;
$this->username = isset($data['username']) ? $data['username'] : null;
}
public function getId() {
public function getId()
{
return $this->id;
}
public function getTitle() {
public function getTitle()
{
return $this->title;
}
public function getFirstName() {
public function getFirstName()
{
return $this->first_name;
}
public function getLastName() {
public function getLastName()
{
return $this->last_name;
}
public function getUsername() {
public function getUsername()
{
return $this->username;
}
}
<?php
/*
* This file is part of the TelegramBot package.
*
......@@ -6,21 +7,20 @@
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
*/
namespace Longman\TelegramBot\Entities;
class Entity
{
public function toJSON() {
public function toJSON()
{
$reflection = new \ReflectionObject($this);
$properties = $reflection->getProperties();
$fields = array();
foreach($properties as $property) {
foreach ($properties as $property) {
$name = $property->getName();
$property->setAccessible(true);
$value = $property->getValue($this);
......@@ -31,11 +31,4 @@ class Entity
return $json;
}
}
<?php
/*
* This file is part of the TelegramBot package.
*
......@@ -6,13 +7,11 @@
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
*/
namespace Longman\TelegramBot\Entities;
use Longman\TelegramBot\Exception\TelegramException;
class Message extends Entity
{
protected $message_id;
......@@ -57,12 +56,12 @@ class Message extends Entity
protected $group_chat_created;
protected $_command;
protected $command;
protected $bot_name;
public function __construct(array $data, $bot_name) {
public function __construct(array $data, $bot_name)
{
$this->bot_name = $bot_name;
......@@ -77,7 +76,6 @@ class Message extends Entity
}
$this->from = new User($this->from);
$this->date = isset($data['date']) ? $data['date'] : null;
if (empty($this->date)) {
throw new TelegramException('date is empty!');
......@@ -89,10 +87,8 @@ class Message extends Entity
}
$this->chat = new Chat($this->chat);
$this->text = isset($data['text']) ? $data['text'] : null;
$this->forward_from = isset($data['forward_from']) ? $data['forward_from'] : null;
if (!empty($this->forward_from)) {
$this->forward_from = new User($this->forward_from);
......@@ -104,20 +100,19 @@ class Message extends Entity
if (!empty($this->reply_to_message)) {
$this->reply_to_message = new Message($this->reply_to_message);
}
}
//return the entire command like /echo or /echo@bot1 if specified
public function getFullCommand(){
public function getFullCommand()
{
return strtok($this->text, ' ');
}
public function getCommand() {
if (!empty($this->_command)) {
return $this->_command;
public function getCommand()
{
if (!empty($this->command)) {
return $this->command;
}
$cmd = $this->getFullCommand();
......@@ -129,67 +124,68 @@ class Message extends Entity
$split_cmd = explode('@', $cmd);
if (isset($split_cmd[1])) {
//command is followed by name check if is addressed to me
if (strtolower($split_cmd[1]) == strtolower($this->bot_name)){
return $this->_command = $split_cmd[0];
if (strtolower($split_cmd[1]) == strtolower($this->bot_name)) {
return $this->command = $split_cmd[0];
}
} else {
//command is not followed by name
return $this->_command = $cmd;
return $this->command = $cmd;
}
}
return false;
}
public function getMessageId() {
public function getMessageId()
{
return $this->message_id;
}
public function getDate() {
public function getDate()
{
return $this->date;
}
public function getFrom() {
public function getFrom()
{
return $this->from;
}
public function getChat() {
public function getChat()
{
return $this->chat;
}
public function getForwardFrom() {
public function getForwardFrom()
{
return $this->forward_from;
}
public function getForwardDate() {
public function getForwardDate()
{
return $this->forward_date;
}
public function getReplyToMessage() {
public function getReplyToMessage()
{
return $this->reply_to_message;
}
public function getText($without_cmd = false) {
public function getText($without_cmd = false)
{
$text = $this->text;
if ($without_cmd) {
$command = $this->getFullCommand();
$text = substr($text, strlen($command.' '), strlen($text));
$text = substr($text, strlen($command . ' '), strlen($text));
}
return $text;
}
}
<?php
/*
* This file is part of the TelegramBot package.
*
......@@ -6,12 +7,11 @@
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
*/
namespace Longman\TelegramBot\Entities;
use Longman\TelegramBot\Exception\TelegramException;
class Update extends Entity
{
......@@ -19,10 +19,8 @@ class Update extends Entity
protected $message;
protected $bot_name;
public function __construct(array $data, $bot_name) {
public function __construct(array $data, $bot_name)
{
$update_id = isset($data['update_id']) ? $data['update_id'] : null;
......@@ -35,20 +33,17 @@ class Update extends Entity
$this->bot_name = $bot_name;
$this->update_id = $update_id;
$this->message = new Message($message, $bot_name);
}
public function getUpdateId() {
public function getUpdateId()
{
return $this->update_id;
}
public function getMessage() {
public function getMessage()
{
return $this->message;
}
}
<?php
/*
* This file is part of the TelegramBot package.
*
......@@ -6,7 +7,7 @@
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
*/
namespace Longman\TelegramBot\Entities;
use Longman\TelegramBot\Exception\TelegramException;
......@@ -19,10 +20,8 @@ class User extends Entity
protected $last_name;
protected $username;
public function __construct(array $data) {
public function __construct(array $data)
{
$this->id = isset($data['id']) ? $data['id'] : null;
if (empty($this->id)) {
......@@ -36,35 +35,29 @@ class User extends Entity
$this->last_name = isset($data['last_name']) ? $data['last_name'] : null;
$this->username = isset($data['username']) ? $data['username'] : null;
}
public function getId() {
public function getId()
{
return $this->id;
}
public function getFirstName() {
public function getFirstName()
{
return $this->first_name;
}
public function getLastName() {
public function getLastName()
{
return $this->last_name;
}
public function getUsername() {
public function getUsername()
{
return $this->username;
}
}
......@@ -6,13 +6,9 @@
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
*/
namespace Longman\TelegramBot\Exception;
class TelegramException extends \Exception
{
}
<?php
/*
* This file is part of the TelegramBot package.
*
......@@ -6,7 +7,7 @@
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
*/
namespace Longman\TelegramBot;
use Longman\TelegramBot\Exception\TelegramException;
......@@ -32,14 +33,13 @@ class Request
'setWebhook',
);
public static function initialize(Telegram $telegram) {
public static function initialize(Telegram $telegram)
{
self::$telegram = $telegram;
}
public static function getInput() {
public static function getInput()
{
if ($update = self::$telegram->getCustomUpdate()) {
self::$input = $update;
} else {
......@@ -49,8 +49,8 @@ class Request
return self::$input;
}
private static function log() {
private static function log()
{
if (!self::$telegram->getLogRequests()) {
return false;
}
......@@ -59,33 +59,31 @@ class Request
return false;
}
$status = file_put_contents($path, self::$input."\n", FILE_APPEND);
$status = file_put_contents($path, self::$input . "\n", FILE_APPEND);
return $status;
}
public static function send($action, array $data = null) {
public static function send($action, array $data = null)
{
if (defined('PHPUNIT_TESTSUITE')) {
return $data;
}
$ch = curl_init();
$curlConfig = array(
CURLOPT_URL => 'https://api.telegram.org/bot'.self::$telegram->getApiKey().'/'.$action,
CURLOPT_URL => 'https://api.telegram.org/bot' . self::$telegram->getApiKey() . '/' . $action,
CURLOPT_POST => true,
CURLOPT_RETURNTRANSFER => true
);
if (!empty($data)) {
if (!empty($data['text']) && substr($data['text'], 0, 1) === '@') {
$data['text'] = ' '.$data['text'];
$data['text'] = ' ' . $data['text'];
}
$curlConfig[CURLOPT_POSTFIELDS] = $data;
}
curl_setopt_array($ch, $curlConfig);
$result = curl_exec($ch);
curl_close($ch);
......@@ -93,9 +91,8 @@ class Request
return !empty($result) ? json_decode($result, true) : false;
}
public static function sendMessage(array $data) {
public static function sendMessage(array $data)
{
if (empty($data)) {
throw new TelegramException('Data is empty!');
......@@ -105,14 +102,9 @@ class Request
return $result;
}
public static function setWebhook($url) {
$result = self::send('setWebhook', array('url'=>$url));
public static function setWebhook($url)
{
$result = self::send('setWebhook', array('url' => $url));
return $result;
}
}
<?php
/*
* This file is part of the TelegramBot package.
*
......@@ -6,19 +7,11 @@
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
*/
namespace Longman\TelegramBot;
ini_set('max_execution_time', 0);
ini_set('memory_limit', -1);
date_default_timezone_set('UTC');
define('BASE_PATH', dirname(__FILE__));
use Longman\TelegramBot\Entities\Update;
use Longman\TelegramBot\Exception\TelegramException;
......@@ -31,6 +24,7 @@ use Longman\TelegramBot\Exception\TelegramException;
*/
class Telegram
{
/**
* Version
*
......@@ -52,7 +46,6 @@ class Telegram
*/
protected $bot_name = '';
/**
* Raw request data
*
......@@ -95,7 +88,6 @@ class Telegram
*/
protected $mysql_enabled;
/**
* MySQL credentials
*
......@@ -103,7 +95,6 @@ class Telegram
*/
protected $mysql_credentials = array();
/**
* PDO object
*
......@@ -111,13 +102,13 @@ class Telegram
*/
protected $pdo;
/**
* Constructor
*
* @param string $api_key
*/
public function __construct($api_key, $bot_name) {
public function __construct($api_key, $bot_name)
{
if (empty($api_key)) {
throw new TelegramException('API KEY not defined!');
}
......@@ -126,14 +117,12 @@ class Telegram
throw new TelegramException('Bot Username not defined!');
}
$this->api_key = $api_key;
$this->bot_name = $bot_name;
Request::initialize($this);
}
/**
* Set custom update string for debug purposes
*
......@@ -141,7 +130,8 @@ class Telegram
*
* @return \Longman\TelegramBot\Telegram
*/
public function setCustomUpdate($update) {
public function setCustomUpdate($update)
{
$this->update = $update;
return $this;
}
......@@ -151,28 +141,30 @@ class Telegram
*
* @return string $update
*/
public function getCustomUpdate() {
public function getCustomUpdate()
{
return $this->update;
}
/**
* Get commands list
*
* @return array $commands
*/
public function getCommandsList() {
public function getCommandsList()
{
$commands = array();
try {
$files = new \DirectoryIterator(BASE_PATH.'/Commands');
}
catch(\Exception $e) {
throw new TelegramException('Can not open path: '.BASE_PATH.'/Commands');
$files = new \DirectoryIterator(BASE_PATH . '/Commands');
} catch (\Exception $e) {
throw new TelegramException('Can not open path: ' . BASE_PATH . '/Commands');
}
foreach ($files as $fileInfo) {
if ($fileInfo->isDot()) continue;
if ($fileInfo->isDot()) {
continue;
}
$name = $fileInfo->getFilename();
$name = strtolower(str_replace('Command.php', '', $name));
$commands[$name] = $this->getCommandClass($name);
......@@ -185,7 +177,9 @@ class Telegram
}
foreach (new \DirectoryIterator($dir) as $fileInfo) {
if ($fileInfo->isDot()) continue;
if ($fileInfo->isDot()) {
continue;
}
$name = $fileInfo->getFilename();
$name = strtolower(str_replace('Command.php', '', $name));
$commands[$name] = $this->getCommandClass($name);
......@@ -196,10 +190,6 @@ class Telegram
return $commands;
}
/**
* Set log requests
*
......@@ -207,7 +197,8 @@ class Telegram
*
* @return \Longman\TelegramBot\Telegram
*/
public function setLogRequests($log_requests) {
public function setLogRequests($log_requests)
{
$this->log_requests = $log_requests;
return $this;
}
......@@ -217,12 +208,11 @@ class Telegram
*
* @return bool
*/
public function getLogRequests() {
public function getLogRequests()
{
return $this->log_requests;
}
/**
* Set log path
*
......@@ -230,7 +220,8 @@ class Telegram
*
* @return \Longman\TelegramBot\Telegram
*/
public function setLogPath($log_path) {
public function setLogPath($log_path)
{
$this->log_path = $log_path;
return $this;
}
......@@ -242,7 +233,8 @@ class Telegram
*
* @return string
*/
public function getLogPath() {
public function getLogPath()
{
return $this->log_path;
}
......@@ -251,25 +243,20 @@ class Telegram
*
* @return \Longman\TelegramBot\Telegram
*/
public function handle() {
public function handle()
{
$this->input = Request::getInput();
if (empty($this->input)) {
throw new TelegramException('Input is empty!');
}
$post = json_decode($this->input, true);
if (empty($post)) {
throw new TelegramException('Invalid JSON!');
}
$update = new Update($post, $this->bot_name);
$this->insertRequest($update);
......@@ -278,9 +265,6 @@ class Telegram
if (!empty($command)) {
return $this->executeCommand($command, $update);
}
}
/**
......@@ -288,7 +272,8 @@ class Telegram
*
* @return mixed
*/
protected function executeCommand($command, Update $update) {
protected function executeCommand($command, Update $update)
{
$class = $this->getCommandClass($command, $update);
if (empty($class)) {
return false;
......@@ -302,14 +287,15 @@ class Telegram
*
* @return object
*/
public function getCommandClass($command, Update $update = null) {
public function getCommandClass($command, Update $update = null)
{
$this->commands_dir = array_unique($this->commands_dir);
$this->commands_dir = array_reverse($this->commands_dir);
$class_name = ucfirst($command).'Command';
$class_name = ucfirst($command) . 'Command';
foreach($this->commands_dir as $dir) {
if (is_file($dir.'/'.$class_name.'.php')) {
require_once($dir.'/'.$class_name.'.php');
foreach ($this->commands_dir as $dir) {
if (is_file($dir . '/' . $class_name . '.php')) {
require_once($dir . '/' . $class_name . '.php');
$class = new $class_name($this);
if (!empty($update)) {
$class->setUpdate($update);
......@@ -332,13 +318,13 @@ class Telegram
return false;
}
/**
* Insert request in db
*
* @return bool
*/
protected function insertRequest(Update $update) {
protected function insertRequest(Update $update)
{
if (empty($this->pdo)) {
return false;
}
......@@ -366,7 +352,6 @@ class Telegram
}
$text = $message->getText();
$sth->bindParam(1, $update_id, \PDO::PARAM_INT);
$sth->bindParam(2, $message_id, \PDO::PARAM_INT);
$sth->bindParam(3, $from, \PDO::PARAM_STR, 255);
......@@ -379,10 +364,6 @@ class Telegram
$status = $sth->execute();
/*$status = $executeQuery->execute(
array(
$update_id, $message_id, $from, $date, $chat, $forward_from,
......@@ -390,25 +371,20 @@ class Telegram
)
);*/
}
catch(PDOException $e) {
} catch (PDOException $e) {
throw new TelegramException($e->getMessage());
}
return true;
}
/**
* Add custom commands path
*
* @return object
*/
public function addCommandsPath($folder) {
public function addCommandsPath($folder)
{
if (!is_dir($folder)) {
throw new TelegramException('Commands folder not exists!');
}
......@@ -421,7 +397,8 @@ class Telegram
*
* @return string
*/
public function getApiKey() {
public function getApiKey()
{
return $this->api_key;
}
......@@ -430,7 +407,8 @@ class Telegram
*
* @return string
*/
public function getBotName() {
public function getBotName()
{
return $this->bot_name;
}
......@@ -439,7 +417,8 @@ class Telegram
*
* @return string
*/
public function getVersion() {
public function getVersion()
{
return $this->version;
}
......@@ -448,20 +427,20 @@ class Telegram
*
* @return string
*/
public function setWebHook($url){
public function setWebHook($url)
{
if (empty($url)) {
throw new TelegramException('Hook url is empty!');
}
$result = Request::setWebhook($url);
if (!$result['ok']) {
throw new TelegramException('Webhook was not set! Error: '.$result['description']);
throw new TelegramException('Webhook was not set! Error: ' . $result['description']);
}
return $result['description'];
}
/**
* Enable MySQL integration
*
......@@ -469,21 +448,19 @@ class Telegram
*
* @return string
*/
public function enableMySQL(array $credentials){
public function enableMySQL(array $credentials)
{
if (empty($credentials)) {
throw new TelegramException('MySQL credentials not provided!');
}
$this->mysql_credentials = $credentials;
$dsn = 'mysql:host='.$credentials['host'].';dbname='.$credentials['database'];
$options = array(
\PDO::MYSQL_ATTR_INIT_COMMAND => 'SET NAMES utf8',
);
$dsn = 'mysql:host=' . $credentials['host'] . ';dbname=' . $credentials['database'];
$options = array(\PDO::MYSQL_ATTR_INIT_COMMAND => 'SET NAMES utf8',);
try {
$pdo = new \PDO($dsn, $credentials['user'], $credentials['password'], $options);
$pdo->setAttribute (\PDO::ATTR_ERRMODE, \PDO::ERRMODE_WARNING);
}
catch (\PDOException $e) {
$pdo->setAttribute(\PDO::ATTR_ERRMODE, \PDO::ERRMODE_WARNING);
} catch (\PDOException $e) {
throw new TelegramException($e->getMessage());
}
......@@ -492,7 +469,4 @@ class Telegram
return $this;
}
}
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment