aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorValentin Popov <dev@valentineus.link>2016-09-21 17:38:59 +0300
committerValentin Popov <dev@valentineus.link>2016-09-21 17:38:59 +0300
commitf44d37a204b1f0b0e6874c04893bbfc050a54fbd (patch)
tree8fdbaed45a1dba786fbd2a2e5b6b5267183005a9
parent07c1b99cb5880f9f3b54ab417387487365db87ac (diff)
downloadiii-module-f44d37a204b1f0b0e6874c04893bbfc050a54fbd.tar.xz
iii-module-f44d37a204b1f0b0e6874c04893bbfc050a54fbd.zip
Final touches
-rw-r--r--demo/components/functions.php (renamed from demo/components/class-application.php)3
-rw-r--r--demo/index.php2
-rw-r--r--src/bot.php33
3 files changed, 20 insertions, 18 deletions
diff --git a/demo/components/class-application.php b/demo/components/functions.php
index 317795d..e3f872a 100644
--- a/demo/components/class-application.php
+++ b/demo/components/functions.php
@@ -2,6 +2,7 @@
/**
* The function returns the current ID.
* Returns zero if no ID is stored.
+* @return integer - ID session.
*/
function GetID() {
// Search current ID...
@@ -21,6 +22,7 @@ function GetID() {
* init or returns zero on failure.
* @param $token - The values of the token.
* @param $bot - Initialized bot.
+* @return string - ID bot session.
*/
function GetSession($token, $bot) {
// Search the old session
@@ -44,6 +46,7 @@ function GetSession($token, $bot) {
* the specified or the next. If any missing ID
* returns the one.
* @param $id - Current ID.
+* @return integer - Next ID.
*/
function SetID($id) {
// Process the specified ID...
diff --git a/demo/index.php b/demo/index.php
index ec526d1..cb000c3 100644
--- a/demo/index.php
+++ b/demo/index.php
@@ -19,7 +19,7 @@
<body>
<?php // Connect all of the dependencies
include("../src/bot.php"); // Class for working with AI
- include("components/class-application.php"); // Class to work with application logic
+ include("components/functions.php"); // Class to work with application logic
include("components/navbar.php"); // Connect the navigation bar
include("components/settings.php"); // Connecting a modal window with the settings
?>
diff --git a/src/bot.php b/src/bot.php
index c04bb1c..86042c5 100644
--- a/src/bot.php
+++ b/src/bot.php
@@ -5,15 +5,16 @@
private $salt = 'some very-very long string without any non-latin characters due to different string representations inside of variable programming languages';
/**
- * @param $key - Ключ из урла после создания инфа
+ * @param $key - The session key of the row address.
*/
public function __construct($key) {
$this->key = $key;
}
/**
- * @param null $session - Идентификатор сессии существующей, если нет то создается новая
- * @return string Идентификатор текущей сессии
+ * The function of creating the session.
+ * @param $session - Session ID.
+ * @return string - The ID of the current session.
*/
public function session($session = null) {
if ($session === null) {
@@ -22,14 +23,14 @@
} else {
$this->session = $session;
}
-
+ // We issue results
return $this->session;
}
/**
- * ОТправить сообщение боту
- * @param string $message Сообщение
- * @return string Ответ
+ * Function send a message to the bot.
+ * @param $message - Message text.
+ * @return string - Returns a response from a bot.
*/
public function say($message) {
$request = '["'.$this->session.'","'.$message.'"]';
@@ -42,41 +43,39 @@
));
$response = curl_exec($myCurl);
curl_close($myCurl);
-
+ // We issue results
return $this->decode($response)->result->text->tts;
}
/**
- * Кодирование сообщения
- * @param $message
- * @return string
+ * Encode message before sending it.
+ * @param $message - The response from the bot.
+ * @return string - A coded message.
*/
private function encode($message) {
$message = base64_encode($message);
$ml = strlen($message);
$kl = strlen($this->salt);
- $encoded = "";
for ($i = 0; $i < $ml; $i++) {
$encoded = $encoded . ($message[$i] ^ $this->salt[$i % $kl]);
}
-
+ // We issue results
return base64_encode($encoded);
}
/**
- * Декодирование сообщения
- * @param $message
+ * The function of decoding the received message.
+ * @param $message - The response from the bot.
* @return mixed|null
*/
private function decode($message) {
$msg = base64_decode($message);
$ml = strlen($msg);
$kl = strlen($this->salt);
- $decoded = "";
for ($i = 0; $i < $ml; $i++) {
$decoded.= ($msg[$i] ^ $this->salt[$i % $kl]);
}
-
+ // We issue results
return json_decode(base64_decode($decoded));
}
}