jumper423 / decaptcha

src/core/DeCaptchaWiki.php

Doc Comments +10 added lines, -1 removed lines

@@ -14,11 +14,17 @@ 
     private $class;
     private $lang = 'en';
 
+    /**
+     * @param string $lang
+     */
     public function setLang($lang)
     {
         $this->lang = $lang;
     }
 
+    /**
+     * @param DeCaptchaBase $class
+     */
     public function __construct($class)
     {
         $this->class = $class;
@@ -251,7 +257,7 @@ 
     }
 
     /**
-     * @param string|array $name
+     * @param string[] $name
      * @param string       $separator
      *
      * @return string|array
@@ -397,6 +403,9 @@ 
         return $str;
     }
 
+    /**
+     * @param string $keyMask
+     */
     private function getNameConst($keyMask, $value)
     {
         $constants = (new \ReflectionClass($this->class))->getConstants();

Spacing +98 added lines, -98 removed lines

@@ -31,160 +31,160 @@ 
             'recognize_data'      => [
                 ($this->class)::ACTION_FIELD_FILE => 'http://site.com/captcha.jpg',
             ],
-            'field_main_name_'.($this->class)::ACTION_FIELD_KEY => [
+            'field_main_name_' . ($this->class)::ACTION_FIELD_KEY => [
                 'ru' => 'Ключ',
             ],
-            'field_main_desc_'.($this->class)::ACTION_FIELD_KEY => [
+            'field_main_desc_' . ($this->class)::ACTION_FIELD_KEY => [
                 'ru' => 'Ключ от учетной записи',
             ],
-            'field_main_name_'.($this->class)::ACTION_FIELD_LANGUAGE => [
+            'field_main_name_' . ($this->class)::ACTION_FIELD_LANGUAGE => [
                 'ru' => 'Язык',
             ],
-            'field_main_desc_'.($this->class)::ACTION_FIELD_LANGUAGE => [
+            'field_main_desc_' . ($this->class)::ACTION_FIELD_LANGUAGE => [
                 'ru' => 'На каком языке текст на капче',
             ],
-            'field_main_name_'.($this->class)::ACTION_FIELD_FILE => [
+            'field_main_name_' . ($this->class)::ACTION_FIELD_FILE => [
                 'ru' => 'Картинка',
             ],
-            'field_main_desc_'.($this->class)::ACTION_FIELD_FILE => [
+            'field_main_desc_' . ($this->class)::ACTION_FIELD_FILE => [
                 'ru' => 'Путь на файл с картинкой или ссылка на него',
             ],
-            'field_main_name_'.($this->class)::ACTION_FIELD_PHRASE => [
+            'field_main_name_' . ($this->class)::ACTION_FIELD_PHRASE => [
                 'ru' => 'Несколько слов',
             ],
-            'field_main_desc_'.($this->class)::ACTION_FIELD_PHRASE => [
+            'field_main_desc_' . ($this->class)::ACTION_FIELD_PHRASE => [
                 'ru' => 'Работник должен ввести текст с одним или несколькими пробелами',
             ],
-            'field_main_name_'.($this->class)::ACTION_FIELD_REGSENSE => [
+            'field_main_name_' . ($this->class)::ACTION_FIELD_REGSENSE => [
                 'ru' => 'Регистр',
             ],
-            'field_main_desc_'.($this->class)::ACTION_FIELD_REGSENSE => [
+            'field_main_desc_' . ($this->class)::ACTION_FIELD_REGSENSE => [
                 'ru' => 'Работник должен ввсести ответ с учетом регистра',
             ],
-            'field_main_name_'.($this->class)::ACTION_FIELD_NUMERIC => [
+            'field_main_name_' . ($this->class)::ACTION_FIELD_NUMERIC => [
                 'ru' => 'Символы',
             ],
-            'field_main_desc_'.($this->class)::ACTION_FIELD_NUMERIC => [
+            'field_main_desc_' . ($this->class)::ACTION_FIELD_NUMERIC => [
                 'ru' => 'Какие символы используется в капче',
             ],
-            'field_main_name_'.($this->class)::ACTION_FIELD_CALC => [
+            'field_main_name_' . ($this->class)::ACTION_FIELD_CALC => [
                 'ru' => 'Вычисление',
             ],
-            'field_main_desc_'.($this->class)::ACTION_FIELD_CALC => [
+            'field_main_desc_' . ($this->class)::ACTION_FIELD_CALC => [
                 'ru' => 'На капче изображенно математичекая выражение и её необходимо решить',
             ],
-            'field_main_name_'.($this->class)::ACTION_FIELD_MIN_LEN => [
+            'field_main_name_' . ($this->class)::ACTION_FIELD_MIN_LEN => [
                 'ru' => 'Длина min',
             ],
-            'field_main_desc_'.($this->class)::ACTION_FIELD_MIN_LEN => [
+            'field_main_desc_' . ($this->class)::ACTION_FIELD_MIN_LEN => [
                 'ru' => 'Минимальная длина капчи',
             ],
-            'field_main_name_'.($this->class)::ACTION_FIELD_MAX_LEN => [
+            'field_main_name_' . ($this->class)::ACTION_FIELD_MAX_LEN => [
                 'ru' => 'Длина max',
             ],
-            'field_main_desc_'.($this->class)::ACTION_FIELD_MAX_LEN => [
+            'field_main_desc_' . ($this->class)::ACTION_FIELD_MAX_LEN => [
                 'ru' => 'Максимальная длина капчи',
             ],
-            'field_main_name_'.($this->class)::ACTION_FIELD_QUESTION => [
+            'field_main_name_' . ($this->class)::ACTION_FIELD_QUESTION => [
                 'ru' => 'Вопрос',
             ],
-            'field_main_desc_'.($this->class)::ACTION_FIELD_QUESTION => [
+            'field_main_desc_' . ($this->class)::ACTION_FIELD_QUESTION => [
                 'ru' => 'На изображении задан вопрос, работник должен написать ответ',
             ],
-            'field_main_name_'.($this->class)::ACTION_FIELD_IS_RUSSIAN => [
+            'field_main_name_' . ($this->class)::ACTION_FIELD_IS_RUSSIAN => [
                 'ru' => 'Кириллица',
             ],
-            'field_main_desc_'.($this->class)::ACTION_FIELD_IS_RUSSIAN => [
+            'field_main_desc_' . ($this->class)::ACTION_FIELD_IS_RUSSIAN => [
                 'ru' => 'На изображении присутствуют русские символы',
             ],
-            'field_main_name_'.($this->class)::ACTION_FIELD_LANGUAGE => [
+            'field_main_name_' . ($this->class)::ACTION_FIELD_LANGUAGE => [
                 'ru' => 'Язык',
             ],
-            'field_main_desc_'.($this->class)::ACTION_FIELD_LANGUAGE => [
+            'field_main_desc_' . ($this->class)::ACTION_FIELD_LANGUAGE => [
                 'ru' => 'Символы какого языка размещенны на капче',
             ],
-            'field_main_name_'.($this->class)::ACTION_FIELD_HEADER_ACAO => [
+            'field_main_name_' . ($this->class)::ACTION_FIELD_HEADER_ACAO => [
                 'ru' => 'Кросс-доменный',
             ],
-            'field_main_desc_'.($this->class)::ACTION_FIELD_HEADER_ACAO => [
+            'field_main_desc_' . ($this->class)::ACTION_FIELD_HEADER_ACAO => [
                 'ru' => 'Необходимо для кросс-доменных AJAX запросов в браузерных приложениях.',
             ],
-            'field_main_name_'.($this->class)::ACTION_FIELD_INSTRUCTIONS => [
+            'field_main_name_' . ($this->class)::ACTION_FIELD_INSTRUCTIONS => [
                 'ru' => 'Инструкция',
             ],
-            'field_main_desc_'.($this->class)::ACTION_FIELD_INSTRUCTIONS => [
+            'field_main_desc_' . ($this->class)::ACTION_FIELD_INSTRUCTIONS => [
                 'ru' => 'Текстовая капча или инструкция для прохождения капчи.',
             ],
-            'field_main_name_'.($this->class)::ACTION_FIELD_PINGBACK => [
+            'field_main_name_' . ($this->class)::ACTION_FIELD_PINGBACK => [
                 'ru' => 'Ответ на',
             ],
-            'field_main_desc_'.($this->class)::ACTION_FIELD_PINGBACK => [
+            'field_main_desc_' . ($this->class)::ACTION_FIELD_PINGBACK => [
                 'ru' => 'Указание для сервера, что после распознания изображения, нужно отправить ответ на указанный адрес.',
             ],
-            'field_main_name_'.($this->class)::ACTION_FIELD_LABEL => [
+            'field_main_name_' . ($this->class)::ACTION_FIELD_LABEL => [
                 'ru' => 'От куда',
             ],
-            'field_main_desc_'.($this->class)::ACTION_FIELD_LABEL => [
+            'field_main_desc_' . ($this->class)::ACTION_FIELD_LABEL => [
                 'ru' => 'Пояснение от куда пришла капча ("vk", "google", "recaptcha", "yandex", "mailru", "yahoo" и т.д.).',
             ],
-            'field_main_name_'.($this->class)::ACTION_FIELD_PAGEURL => [
+            'field_main_name_' . ($this->class)::ACTION_FIELD_PAGEURL => [
                 'ru' => 'Адрес',
             ],
-            'field_main_desc_'.($this->class)::ACTION_FIELD_PAGEURL => [
+            'field_main_desc_' . ($this->class)::ACTION_FIELD_PAGEURL => [
                 'ru' => 'Адрес страницы на которой решается капча.',
             ],
-            'field_main_name_'.($this->class)::ACTION_FIELD_GOOGLEKEY => [
+            'field_main_name_' . ($this->class)::ACTION_FIELD_GOOGLEKEY => [
                 'ru' => 'Google key',
             ],
-            'field_main_desc_'.($this->class)::ACTION_FIELD_GOOGLEKEY => [
+            'field_main_desc_' . ($this->class)::ACTION_FIELD_GOOGLEKEY => [
                 'ru' => 'Ключ-индентификатор рекапчи на целевой странице. <div class="g-recaptcha" data-sitekey="ВОТ_ЭТОТ"></div>',
             ],
-            'field_main_name_'.($this->class)::ACTION_FIELD_GOOGLETOKEN => [
+            'field_main_name_' . ($this->class)::ACTION_FIELD_GOOGLETOKEN => [
                 'ru' => 'Google token',
             ],
-            'field_main_desc_'.($this->class)::ACTION_FIELD_GOOGLETOKEN => [
+            'field_main_desc_' . ($this->class)::ACTION_FIELD_GOOGLETOKEN => [
                 'ru' => 'Секретный токен для предыдущей версии рекапчи. В большинстве случаев сайты используют новую версию и этот токен не требуется. Секретный токен генерируется на сервере Google и вставляется на страницу в атрибуте data-stoken. Выглядит это примерно так: <script type="text/javascript" src="...." data-type="normal"  data-ray="..." async data-sitekey="..." data-stoken="ВОТ_ЭТОТ"></script> Токен действует пару минут после генерации, затем нужно снова зайти на страницу и получить его.',
             ],
-            'field_main_name_'.($this->class)::ACTION_FIELD_PROXYTYPE => [
+            'field_main_name_' . ($this->class)::ACTION_FIELD_PROXYTYPE => [
                 'ru' => 'Тип прокси',
             ],
-            'field_main_desc_'.($this->class)::ACTION_FIELD_PROXYTYPE => [
+            'field_main_desc_' . ($this->class)::ACTION_FIELD_PROXYTYPE => [
                 'ru' => 'Тип прокси (http, socks4, ...)',
             ],
-            'field_main_name_'.($this->class)::ACTION_FIELD_PROXY => [
+            'field_main_name_' . ($this->class)::ACTION_FIELD_PROXY => [
                 'ru' => 'Адрес прокси',
             ],
-            'field_main_desc_'.($this->class)::ACTION_FIELD_PROXY => [
+            'field_main_desc_' . ($this->class)::ACTION_FIELD_PROXY => [
                 'ru' => 'IP адрес прокси ipv4/ipv6.',
             ],
-            'field_main_name_'.($this->class)::ACTION_FIELD_PROXYPORT => [
+            'field_main_name_' . ($this->class)::ACTION_FIELD_PROXYPORT => [
                 'ru' => 'Порт прокси',
             ],
-            'field_main_desc_'.($this->class)::ACTION_FIELD_PROXYPORT => [
+            'field_main_desc_' . ($this->class)::ACTION_FIELD_PROXYPORT => [
                 'ru' => 'Порт прокси.',
             ],
-            'field_main_name_'.($this->class)::ACTION_FIELD_PROXYLOGIN => [
+            'field_main_name_' . ($this->class)::ACTION_FIELD_PROXYLOGIN => [
                 'ru' => 'Логин прокси',
             ],
-            'field_main_desc_'.($this->class)::ACTION_FIELD_PROXYLOGIN => [
+            'field_main_desc_' . ($this->class)::ACTION_FIELD_PROXYLOGIN => [
                 'ru' => 'Логин от прокси-сервера.',
             ],
-            'field_main_name_'.($this->class)::ACTION_FIELD_PROXYPASS => [
+            'field_main_name_' . ($this->class)::ACTION_FIELD_PROXYPASS => [
                 'ru' => 'Пароль прокси',
             ],
-            'field_main_desc_'.($this->class)::ACTION_FIELD_PROXYPASS => [
+            'field_main_desc_' . ($this->class)::ACTION_FIELD_PROXYPASS => [
                 'ru' => 'Пароль от прокси-сервера.',
             ],
-            'field_main_name_'.($this->class)::ACTION_FIELD_USERAGENT => [
+            'field_main_name_' . ($this->class)::ACTION_FIELD_USERAGENT => [
                 'ru' => 'User-Agent браузера',
             ],
-            'field_main_desc_'.($this->class)::ACTION_FIELD_USERAGENT => [
+            'field_main_desc_' . ($this->class)::ACTION_FIELD_USERAGENT => [
                 'ru' => 'User-Agent браузера, используемый в эмуляции. Необходимо использовать подпись современного браузера, иначе Google будет возвращать ошибку, требуя обновить браузер.',
             ],
-            'field_main_name_'.($this->class)::ACTION_FIELD_COOKIES => [
+            'field_main_name_' . ($this->class)::ACTION_FIELD_COOKIES => [
                 'ru' => 'Куки',
             ],
-            'field_main_desc_'.($this->class)::ACTION_FIELD_COOKIES => [
+            'field_main_desc_' . ($this->class)::ACTION_FIELD_COOKIES => [
                 'ru' => 'Дополнительные cookies которые мы должны использовать во время взаимодействия с целевой страницей.',
             ],
             'table_th_name' => [
@@ -258,7 +258,7 @@ 
      */
     public function getText($name, $separator = '; ')
     {
-        $getResult = function ($name, $texts) {
+        $getResult = function($name, $texts) {
             if (is_array($name)) {
                 $name = implode('_', $name);
             }
@@ -293,51 +293,51 @@ 
     {
         $rc = (new \ReflectionClass($this->class));
 
-        $str = "#####{$this->getText(['example', 'initialization'])}".PHP_EOL;
-        $str.= "```".PHP_EOL;
-        $str.= "use {$rc->getName()};".PHP_EOL;
-        $str.= "".PHP_EOL;
-        $str.= '$captcha = new '.$rc->getShortName().'(['.PHP_EOL;
+        $str = "#####{$this->getText(['example', 'initialization'])}" . PHP_EOL;
+        $str .= "```" . PHP_EOL;
+        $str .= "use {$rc->getName()};" . PHP_EOL;
+        $str .= "" . PHP_EOL;
+        $str .= '$captcha = new ' . $rc->getShortName() . '([' . PHP_EOL;
         foreach ($this->texts['constructor_data'] as $key => $val) {
-            $str.= "    {$rc->getShortName()}::{$this->getNameConst('ACTION_FIELD_', $key)} => ";
+            $str .= "    {$rc->getShortName()}::{$this->getNameConst('ACTION_FIELD_', $key)} => ";
             if (is_string($val)) {
-                $str.= "'{$val}'";
+                $str .= "'{$val}'";
             } else {
-                $str.= "{$val}";
+                $str .= "{$val}";
             }
-            $str.= ",".PHP_EOL;
+            $str .= "," . PHP_EOL;
         }
-        $str.= "]);".PHP_EOL;
-        $str.= "```".PHP_EOL;
+        $str .= "]);" . PHP_EOL;
+        $str .= "```" . PHP_EOL;
 
-        $str.= "#####{$this->getText(['example', 'recognize'])}".PHP_EOL;
-        $str.= "```".PHP_EOL;
+        $str .= "#####{$this->getText(['example', 'recognize'])}" . PHP_EOL;
+        $str .= "```" . PHP_EOL;
         $str .= 'if ($captcha->recognize(';
         if ($this->texts['recognize_file']) {
             $str .= "'{$this->getText(['recognize', 'data', 'file'])}'";
         }
         if ($this->texts['recognize_data']) {
             if ($this->texts['recognize_file']) {
-                $str.= ", ";
+                $str .= ", ";
             }
-            $str.= "[".PHP_EOL;
+            $str .= "[" . PHP_EOL;
             foreach ($this->texts['recognize_data'] as $key => $val) {
-                $str.= "    {$rc->getShortName()}::{$this->getNameConst('ACTION_FIELD_', $key)} => ";
+                $str .= "    {$rc->getShortName()}::{$this->getNameConst('ACTION_FIELD_', $key)} => ";
                 if (is_string($val)) {
-                    $str.= "'{$val}'";
+                    $str .= "'{$val}'";
                 } else {
-                    $str.= "{$val}";
+                    $str .= "{$val}";
                 }
-                $str.= ",".PHP_EOL;
+                $str .= "," . PHP_EOL;
             }
-            $str.= "]";
+            $str .= "]";
         }
-        $str.= ")) {".PHP_EOL;
-        $str.= '    $code = $captcha->getCode();'.PHP_EOL;
-        $str.= "} else {".PHP_EOL;
-        $str.= '    $error = $captcha->getError());'.PHP_EOL;
-        $str.= "}".PHP_EOL;
-        $str.= "```".PHP_EOL;
+        $str .= ")) {" . PHP_EOL;
+        $str .= '    $code = $captcha->getCode();' . PHP_EOL;
+        $str .= "} else {" . PHP_EOL;
+        $str .= '    $error = $captcha->getError());' . PHP_EOL;
+        $str .= "}" . PHP_EOL;
+        $str .= "```" . PHP_EOL;
 
         /*  constructor_data
         use jumper423\decaptcha\services\Anticaptcha;
@@ -363,8 +363,8 @@ 
 
     private function viewFields()
     {
-        $str = " {$this->getText(['table', 'th', 'name'])} | {$this->getText(['table', 'th', 'code'])} | {$this->getText(['table', 'th', 'type'])} | {$this->getText(['table', 'th', 'req'])} | {$this->getText(['table', 'th', 'def'])} | {$this->getText(['table', 'th', 'enum'])} | {$this->getText(['table', 'th', 'desc'])} ".PHP_EOL;
-        $str .= ' --- | --- | --- | --- | --- | --- | --- '.PHP_EOL;
+        $str = " {$this->getText(['table', 'th', 'name'])} | {$this->getText(['table', 'th', 'code'])} | {$this->getText(['table', 'th', 'type'])} | {$this->getText(['table', 'th', 'req'])} | {$this->getText(['table', 'th', 'def'])} | {$this->getText(['table', 'th', 'enum'])} | {$this->getText(['table', 'th', 'desc'])} " . PHP_EOL;
+        $str .= ' --- | --- | --- | --- | --- | --- | --- ' . PHP_EOL;
         foreach ($this->class->actions[($this->class)::ACTION_RECOGNIZE][($this->class)::ACTION_FIELDS] as $param => $setting) {
             if (array_key_exists(($this->class)::ACTION_FIELDS, $setting) && is_array($setting[($this->class)::ACTION_FIELDS])) {
                 foreach ($setting[($this->class)::ACTION_FIELDS] as $param1 => $setting1) {
@@ -387,9 +387,9 @@ 
     {
         $str = " {$this->getText(['field', 'main', 'name', $param])} |";
         $str .= " {$this->getNameConst('ACTION_FIELD_', $param)} |";
-        $str .= ' '.substr($this->getNameConst('PARAM_FIELD_TYPE_', $setting[($this->class)::PARAM_SLUG_TYPE]), 17).' |';
-        $str .= ' '.(array_key_exists(($this->class)::PARAM_SLUG_REQUIRE, $setting) ? '+' : '-').' |';
-        $str .= ' '.(array_key_exists(($this->class)::PARAM_SLUG_DEFAULT, $setting) ? $setting[($this->class)::PARAM_SLUG_DEFAULT] : '').' |';
+        $str .= ' ' . substr($this->getNameConst('PARAM_FIELD_TYPE_', $setting[($this->class)::PARAM_SLUG_TYPE]), 17) . ' |';
+        $str .= ' ' . (array_key_exists(($this->class)::PARAM_SLUG_REQUIRE, $setting) ? '+' : '-') . ' |';
+        $str .= ' ' . (array_key_exists(($this->class)::PARAM_SLUG_DEFAULT, $setting) ? $setting[($this->class)::PARAM_SLUG_DEFAULT] : '') . ' |';
         $str .= " {$this->getText(['field', 'slug', ($this->class)::PARAM_SLUG_ENUM, $param])} |";
         $str .= " {$this->getText(['field', 'main', 'desc', $param])} |";
         $str .= PHP_EOL;
@@ -411,20 +411,20 @@ 
 
     public function view()
     {
-        $str = $this->getText(['service', 'name']).PHP_EOL;
-        $str .= '=============='.PHP_EOL;
-        $str .= "###{$this->getText(['slug', 'link'])}".PHP_EOL;
-        $str .= "[{$this->getText(['slug', 'link', 'to_service'])} {$this->getText(['service', 'name'])}]({$this->getText(['service', 'href'])})".PHP_EOL.PHP_EOL;
-        $str .= "###{$this->getText(['slug', 'service', 'desc'])}".PHP_EOL;
-        $str .= "{$this->getText(['service', 'desc'])}".PHP_EOL.PHP_EOL;
-        $str .= "###{$this->getText(['slug', 'price'])}".PHP_EOL;
-        $str .= "{$this->getText(['recognize', 'price'])}".PHP_EOL.PHP_EOL;
-        $str .= "###{$this->getText(['slug', 'recognize', 'desc'])}".PHP_EOL;
-        $str .= "{$this->getText(['recognize', 'desc'])}".PHP_EOL.PHP_EOL;
-        $str .= "###{$this->getText(['example'])}".PHP_EOL;
-        $str .= "{$this->viewExamples()}".PHP_EOL.PHP_EOL;
-        $str .= "###{$this->getText(['slug', 'fields', 'desc'])}".PHP_EOL;
-        $str .= $this->viewFields().PHP_EOL;
+        $str = $this->getText(['service', 'name']) . PHP_EOL;
+        $str .= '==============' . PHP_EOL;
+        $str .= "###{$this->getText(['slug', 'link'])}" . PHP_EOL;
+        $str .= "[{$this->getText(['slug', 'link', 'to_service'])} {$this->getText(['service', 'name'])}]({$this->getText(['service', 'href'])})" . PHP_EOL . PHP_EOL;
+        $str .= "###{$this->getText(['slug', 'service', 'desc'])}" . PHP_EOL;
+        $str .= "{$this->getText(['service', 'desc'])}" . PHP_EOL . PHP_EOL;
+        $str .= "###{$this->getText(['slug', 'price'])}" . PHP_EOL;
+        $str .= "{$this->getText(['recognize', 'price'])}" . PHP_EOL . PHP_EOL;
+        $str .= "###{$this->getText(['slug', 'recognize', 'desc'])}" . PHP_EOL;
+        $str .= "{$this->getText(['recognize', 'desc'])}" . PHP_EOL . PHP_EOL;
+        $str .= "###{$this->getText(['example'])}" . PHP_EOL;
+        $str .= "{$this->viewExamples()}" . PHP_EOL . PHP_EOL;
+        $str .= "###{$this->getText(['slug', 'fields', 'desc'])}" . PHP_EOL;
+        $str .= $this->viewFields() . PHP_EOL;
 
         return $str;
     }