Class Captcha

---

[Строка 16]

Размещен: /Kernel/Captcha.class.php

---

Описание

Система управления сайтом HostCMS v. 5.xx

Copyright © 2005-2010 ООО "Хостмэйк" (Hostmake LLC), http://www.hostcms.ru

Ядро, класс для работы с CAPTCHA.

Файл: /modules/Kernel/captcha.class.php

author

Hostmake LLC

version

5.x

---

Свойства класса

• $allowed_symbols =  '1234567890'
  Разрешенные символы. Исключены похожие по написанию o=0, 1=l, i=j, t=f:
• $distortion_amplitude =  10
  амплитуда искажения
• $fonts_dir =  'hostcmsfiles/captcha/fonts'
  Путь к шрифтам
• $image_extension =  'gif'
  Расширение рисунка CAPTCHA
• $image_height =  50
  Высота изображения с CAPTCHA
• $image_width =  120
  Ширина изображения с CAPTCHA
• $keystring =  ''
  Значение CAPTCHA
• $max_lenght =  4
  Максимальная длина строки CAPTCHA
• $min_lenght =  4
  Минимальная длина строки CAPTCHA
• $no_spaces =  true
  Флаг, указывающий, слитно писать символы CAPTCHA или нет
• $polygon_max_corner =  6
  Максимальное значение количества углов многоугольника на фоне CAPTCHA
• $polygon_max_radius =  15
  Максимальное значение радиуса многоугольника на фоне CAPTCHA
• $polygon_min_corner =  6
  Минимальное значение количества углов многоугольника на фоне CAPTCHA
• $polygon_min_radius =  10
  Минимальное значение радиуса многоугольника на фоне CAPTCHA
• $simbols =  '0123456789abcdefghijklmnopqrstuvwxyz'
  Порядок символов в шрифтах

---

Константы класса

---

Унаследованные константы класса

---

Унаследованные свойства класса

---

Методы

• void BuildCapture()
  Метод для построения изображения CAPTCHA и помещения его текста в сессию
• str GenerateKeyString()
  Генерация строки CAPTCHA
• int GetCaptchaId()
  Метод генерирует и возвращает уникальный индекс для CAPTCHA
• boolean ValidCaptcha()
  Метод проверки соответствия введенного пользователем текста хранимому в сессии Пример использования метода см. в руководстве по интеграции.

Унаследованные методы

---

Описания методов

Captcha::BuildCapture

BuildCapture( int $captcha_id, [array $param = array ()] );

Описание

Метод для построения изображения CAPTCHA и помещения его текста в сессию

Принимаемые параметры

$captcha_id

- уникальный номер CAPTCHA

$param

- $param['alphabet'] Символы используемые в тексте

• $param['allowed_symbols'] Символы, исключающие ошибки распознавания (o = 0, i = j, 1 = l) используются для формирования строки
• $param['fontsdir'] Путь к шрифтам
• $param['length'] Количество символов
• $param['width'] Ширина базового изображения
• $param['height'] Высота базового изображения
• $param['dest_x'] Ширина реального изображения
• $param['dest_y'] Высота реального изображения
• $param['foreground_color'] Цвет текста в RGB задаётся массивом
• $param['background_color'] Цвет фона в RGB задаётся массивом
• $param['image_extension'] Расширение выходного изображения CAPTCHA (jpg, gif или png)

[ Наверх ]




Captcha::GenerateKeyString

GenerateKeyString( );

Описание

Генерация строки CAPTCHA

[ Наверх ]




Captcha::GetCaptchaId

GetCaptchaId( );

Описание

Метод генерирует и возвращает уникальный индекс для CAPTCHA

[ Наверх ]




Captcha::ValidCaptcha

ValidCaptcha( int $captcha_id, string $text );

Описание

Метод проверки соответствия введенного пользователем текста хранимому в сессии Пример использования метода см. в руководстве по интеграции.

Принимаемые параметры

$captcha_id

уникальный номер CAPTCHA

$text

текст, введённый пользователем

[ Наверх ]

---

Описания переменных

• $allowed_symbols =  '1234567890' [Строка 46]
• Data type: mixed

Описание

Разрешенные символы. Исключены похожие по написанию o=0, 1=l, i=j, t=f:



• $distortion_amplitude =  10 [Строка 61]
• Data type: mixed

Описание

амплитуда искажения



• $fonts_dir =  'hostcmsfiles/captcha/fonts' [Строка 21]
• Data type: mixed

Описание

Путь к шрифтам



• $image_extension =  'gif' [Строка 71]
• Data type: mixed

Описание

Расширение рисунка CAPTCHA



• $image_height =  50 [Строка 56]
• Data type: mixed

Описание

Высота изображения с CAPTCHA



• $image_width =  120 [Строка 51]
• Data type: mixed

Описание

Ширина изображения с CAPTCHA



• $keystring =  '' [Строка 31]
• Data type: mixed

Описание

Значение CAPTCHA



• $max_lenght =  4 [Строка 36]
• Data type: mixed

Описание

Максимальная длина строки CAPTCHA



• $min_lenght =  4 [Строка 41]
• Data type: mixed

Описание

Минимальная длина строки CAPTCHA



• $no_spaces =  true [Строка 66]
• Data type: mixed

Описание

Флаг, указывающий, слитно писать символы CAPTCHA или нет



• $polygon_max_corner =  6 [Строка 91]
• Data type: mixed

Описание

Максимальное значение количества углов многоугольника на фоне CAPTCHA



• $polygon_max_radius =  15 [Строка 81]
• Data type: mixed

Описание

Максимальное значение радиуса многоугольника на фоне CAPTCHA



• $polygon_min_corner =  6 [Строка 86]
• Data type: mixed

Описание

Минимальное значение количества углов многоугольника на фоне CAPTCHA



• $polygon_min_radius =  10 [Строка 76]
• Data type: mixed

Описание

Минимальное значение радиуса многоугольника на фоне CAPTCHA



• $simbols =  '0123456789abcdefghijklmnopqrstuvwxyz' [Строка 26]
• Data type: mixed

Описание

Порядок символов в шрифтах

---

Описание констант класса

---