Class Forms

[Строка 23]

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

Описание

Класс модуля "Формы"

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

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

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

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

Методы

int ConfirmGetForm()
Определение права пользователя отправлять форму
mixed CopyForms()
Копирование структуры формы и ее полей
mixed CopyFormsField()
Копирование структуры поля формы
boolean DelFillForms()
Удаление бланка заполненной формы
boolean DelFillValues()
Удаление значения одного из полей отправленной формы
boolean DelForms()
Удаление данных о форме
boolean DelFormsFields()
Удаление поля формы
resource GetAllForms()
Получение информации о всех формах
resource GetCountFormsFill()
Получение количества заполнений формы.
array GetFillForm()
Получение списка и значения полей для заполненной формы.
resource GetFillForms()
Получение списка заполненных форм для формы $forms_id.
resource GetFillFormsFields()
Получение списка и значения полей для заполненной формы.
boolean GetForm()
Обработка содержимого отправленной формы
mixed GetFormFields()
Получение данных о полях формы
mixed GetFormInfo()
Получение информации о форме
mixed InsertForms()
Вставка/обновление информации о форме
mixed InsertFormsFields()
Вставка/обновление информации о поле формы
mixed InsertFormsFill()
Вставка/обновление информации о заполнении формы
mixed InsertFormsFillValues()
Вставка/обновление значений заполненной формы
mixed SelectForms()
Получение данных о формах
mixed SelectFormsFields()
Получение данных о поле формы
boolean ShowForm()
Отображение формы

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

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

Forms::ConfirmGetForm

ConfirmGetForm( int $forms_id, string $date, string $forms_fill_ip );

Описание

Определение права пользователя отправлять форму

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

$forms_id

идентификатор отправляемой формы

$date

дата и время (в формате MySQL) отправки формы

$forms_fill_ip

ip-адрес компьютера отправителя формы

 <?php
 $Form = new Forms();
 
 $form_id = 6;
 $date = date('Y-m-d H:i:s');
 $forms_fill_ip = '';
 
 $result = $Form->ConfirmGetForm($forms_id, $date, $forms_fill_ip);
 
 // Распечатаем результат
 if ($result)
 {
     echo 'Пользователь имеет право отправлять данные';
 }
 else
 {
     echo 'Пользователь не имеет право отправлять данные';
 }
 ?>

Возвращает

1 – пользователь может отправлять данные формы, 0 – пользователь не может отправлять данные формы

[ Наверх ]

Forms::CopyForms

CopyForms( int $forms_id, [int $site_id = false] );

Описание

Копирование структуры формы и ее полей

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

$forms_id

идентификатор формы, структуру которой необходимо скопировать

$site_id

идентификатор сайта, куда следует скопировать форму, если не передан, используется текущий сайт

 <?php
 $Form = new Forms();
 
 $forms_id = 6;
 
 $newid = $Form->CopyForms($forms_id);
 
 // Распечатаем результат
 echo $newid;
 ?>

Возвращает

идентификатор новой формы в случае успешного выполнения, false - в противном случае

[ Наверх ]

Forms::CopyFormsField

CopyFormsField( int $forms_field_id, [array $param = array()] );

Описание

Копирование структуры поля формы

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

$forms_field_id

идентификатор поля формы, копию которого необходимо сделать

$param

ассоциативный массив параметров

$param['show_text_copy'] параметр, определяющий будет добавляться текcт "Копия [датавремя создания копии]" к названию копии поля формы (true - добавлять текст, false - не добавлять), по умолчанию $param['show_text_copy'] = true
```
 <?php
 $Form = new Forms();
 
 $forms_field_id = 6;
 
 $newid = $Form->CopyFormsField($forms_field_id);
 
 // Распечатаем результат
 echo $newid;
 ?>
```

Возвращает

идентификатор нового (скопированного) поля формы, false в противном случае

[ Наверх ]

Forms::DelFillForms

DelFillForms( int $forms_fill_id );

Описание

Удаление бланка заполненной формы

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

$forms_fill_id

идентификатор удаляемого бланка

 <?php
 $Form = new Forms();
 
 $forms_fill_id = 2;
 
 $result = $Form->DelFillForms($forms_fill_id);
 
 if ($result)
 {
     echo "Удаление выполнено успешно";
 }
 else
 {
     echo "Ошибка удаления";
 }
 ?>

Возвращает

true в случае успешного удаления, false в противном случае

[ Наверх ]

Forms::DelFillValues

DelFillValues( int $forms_fill_values_id );

Описание

Удаление значения одного из полей отправленной формы

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

$forms_fill_values_id

идентификатор записи, содержащей значение поля отправленной формы

 <?php
 $Form = new Forms();
 
 $forms_fill_values_id = 4;
 
 $result = $Form->DelFillValues($forms_fill_values_id);
 
 if ($result)
 {
     echo "Удаление выполнено успешно";
 }
 else
 {
     echo "Ошибка удаления";
 }
 ?>

Возвращает

true в случае успешного удаления значения поля отправленной формы, false в противном случае

[ Наверх ]

Forms::DelForms

DelForms( int $forms_id );

Описание

Удаление данных о форме

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

$forms_id

идентификатор формы, информацию о которой необходимо удалить

 <?php
 $Form = new Forms();
 
 $forms_id = 4;
 
 $result = $Form->DelForms($forms_id);
 
 if ($result)
 {
     echo "Удаление выполнено успешно";
 }
 else
 {
     echo "Ошибка удаления";
 }
 ?>

Возвращает

true в случае успешного удаления формы, false в противном случае

[ Наверх ]

Forms::DelFormsFields

DelFormsFields( int $forms_fields_id );

Описание

Удаление поля формы

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

$forms_fields_id

идентификатор удаляемого поля формы

 <?php
 $Form = new Forms();
 
 $forms_fields_id = 8;
 
 $result = $Form->DelFormsFields($forms_fields_id);
 
 if ($result)
 {
     echo "Удаление выполнено успешно";
 }
 else
 {
     echo "Ошибка удаления";
 }
 ?>

Возвращает

true в случае успешного удаления поля формы, false в противном случае

[ Наверх ]

Forms::GetAllForms

GetAllForms( [mixed $site_id = 0] );

Описание

Получение информации о всех формах

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

$site_id

идентификатор сайта, для которого необходимо получить список форм

(по умолчанию получаем список форм текущего сайта, false - информация о формах всех сайтов)

 <?php
 $Form = new Forms();
 
 $site_id = 1;
 
 $resource = $Form->GetAllForms($site_id);
 
 // Распечатаем результат
 while($row = mysql_fetch_assoc($resource))
 {
     print_r($row);
 }
 ?>

Возвращает

или false

[ Наверх ]

Forms::GetCountFormsFill

GetCountFormsFill( [int $forms_id = 0] );

Описание

Получение количества заполнений формы.

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

$forms_id

 <?php
 $Form = new Forms();
 
 $forms_id = 0;
 
 $resource = $Form->GetCountFormsFill($forms_id);
 
 // Распечатаем результат
 print_r ($resource);
 ?>

[ Наверх ]

Forms::GetFillForm

GetFillForm( int $fill_forms_id );

Описание

Получение списка и значения полей для заполненной формы.

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

$fill_forms_id

 <?php
 $Form = new Forms();
 
 $fill_forms_id = 1;
 
 $row = $Form->GetFillForm($fill_forms_id);
 
 // Распечатаем результат
 print_r ($row);
 ?>

Возвращает

массив с информацией о заполненной форме

[ Наверх ]

Forms::GetFillForms

GetFillForms( [int $forms_id = false] );

Описание

Получение списка заполненных форм для формы $forms_id.

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

$forms_id

- идентификатор формы, если false - все заполненные формы всех форм

 <?php
 $Form = new Forms();
 
 $forms_id = false;
 
 $resource = $Form->GetFillForms($forms_id);
 
 // Распечатаем результат
 while($row = mysql_fetch_assoc($resource))
 {
     print_r($row);
 }
 ?>

[ Наверх ]

Forms::GetFillFormsFields

GetFillFormsFields( int $fill_forms_id );

Описание

Получение списка и значения полей для заполненной формы.

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

$fill_forms_id

 <?php
 $Form = new Forms();
 
 $fill_forms_id = 1;
 
 $resource = $Form->GetFillFormsFields($fill_forms_id);
 
 // Распечатаем результат
 while($row = mysql_fetch_assoc($resource))
 {
     print_r($row);
 }
 ?>

[ Наверх ]

Forms::GetForm

GetForm( int $form_id, string $xsl_forms, string $xsl_email, [array $param = array()], [array $external_propertys = array()] );

Описание

Обработка содержимого отправленной формы

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

$form_id

идентификатор отправленной формы

$xsl_forms

XSL-шаблон, формирующий сообщение пользователю при отправке формы

$xsl_email

XSL-шаблон, формирующий текст письма куратору отправленной формы с данными, переданными в форме

$param

массив дополнительных параметров, имеет следующую структуру

$param['e-mail'] - поле формы, содержащее email адрес отправителя;
$param['e-mail-to'] - строка со списком электронных адресов получателей.

$param['subject'] - тема письма куратору формы;
$param['type'] - тип письма (0 - text/html, 1 - text/plain);
$param['bound'] - граница прикрепляемого файла. Если не передан, создается

$external_propertys

массив дополнительных свойств для включения в исходный XML код

Возвращает

true в случае успешного отправления формы, false в противном случае

[ Наверх ]

Forms::GetFormFields

GetFormFields( int $form_id );

Описание

Получение данных о полях формы

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

$form_id

идентификатор формы

 <?php
 $Form = new Forms();
 
 $form_id = 6;
 
 $resource = $Form->GetFormFields($form_id);
 
 // Распечатаем результат
 while($row = mysql_fetch_assoc($resource))
 {
     print_r($row);
 }
 ?>

Возвращает

resorce в случае успешного выполнения, false в противном случае

[ Наверх ]

Forms::GetFormInfo

GetFormInfo( int $form_id );

Описание

Получение информации о форме

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

$form_id

идентификатор формы

 <?php
 $Form = new Forms();
 
 $form_id = 6;
 
 $row = $Form->GetFormInfo($form_id);
 
 // Распечатаем результат
 print_r ($row);
 ?>

Возвращает

ассоциативный массив с данными о форме в случае успешного выполнения, false - в противном случае

[ Наверх ]

Forms::InsertForms

InsertForms( int $type, int $forms_id, string $forms_name, string $forms_description, string $forms_email, int $forms_button_type, string $forms_button_name, string $forms_button_value, string $forms_button_text_value, [array $param = array()], [string $forms_mail_subject = ''], [int $users_id = false], [int $site_id = false] );

Описание

Вставка/обновление информации о форме

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

$type

параметр, определяющий производится вставка или обновление информации о форме( 0 – вставка, 1 обновление)

$forms_id

идентификатор обновляемой формы (при вставке равен 0)

$forms_name

имя формы

$forms_description

описание формы

$forms_email

e-mail куратора формы

$forms_button_type

тип кнопки для формы (0 – простая кнопка, 1 - кнопка типа button)

$forms_button_name

название кнопки (английское)

$forms_button_value

значение, передаваемое при нажатии кнопки

$forms_button_text_value

текст на кнопке

$param

массив дополнительных параметров
$param['forms_captcha_used'] параметр, определяющий использовать при отображении формы captcha (1 использовать, 0 не использовать)

$forms_mail_subject

тема письма администратору об отправке формы

$users_id

идентификатор пользователя, если false - берется текущий пользователь

$site_id

идентификатор сайта, если false - берется текущий сайт

 <?php
 $Form = new Forms();
 
 $type = 0;
 $forms_id = 0;
 $forms_name = 'Новая форма';
 $forms_description = '';
 $forms_email = '';
 $forms_button_type = 1;
 $forms_button_name = 'Btn';
 $forms_button_value = '';
 $forms_button_text_value = '';
 $param = array();
 $forms_mail_subject = '';
 
 $newid = $Form->InsertForms($type, $forms_id, $forms_name, $forms_description, $forms_email, $forms_button_type, $forms_button_name, $forms_button_value, $forms_button_text_value);
 
 // Распечатаем результат
 echo $newid;
 ?>

Возвращает

идентификатор вставленной/обновленной формы в случае успешного выполнения, false в противном случае

[ Наверх ]

Forms::InsertFormsFields

InsertFormsFields( int $type, int $forms_fields_id, int $forms_id, int $lists_id, int $forms_fields_type, string $forms_fields_name, string $forms_fields_text_name, string $forms_fields_default_value, int $forms_fields_order, int $forms_fields_size, int $forms_fields_rows, int $forms_fields_cols, int $forms_fields_checked, string $forms_fields_comment, [int $forms_fields_obligatory = 0], [int $users_id = false] );

Описание

Вставка/обновление информации о поле формы

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

$type

параметр, определяющий производится вставка или обновление информации о поле формы (0 – вставка, 1 обновление)

$forms_fields_id

идентификатор обновляемого поля формы (при вставке равен 0)

$forms_id

идентификатор формы, к которой относится обновляемое/добавляемое поле

$lists_id

идентификатор списка, с которым связано поле (для полей типа «радиогруппа», «выпадающий список»)

$forms_fields_type

– тип поля формы (0 – текстовое поле, 1 – поле пароля, 2 – поле загрузки файла, 3 – радиокнопка, 4 – checkbox, 5 – большое текстовое поле, 6 – список, 7 – скрытое поле, 9 - список из чекбоксов)

$forms_fields_name

английское название поля (тег “name”)

$forms_fields_text_name

поясняющий текст для поля формы

$forms_fields_default_value

значение по умолчанию

$forms_fields_order

порядоковый номер поля

$forms_fields_size

ширина поля формы (для текстового поля и поля пароля)

$forms_fields_rows

высота большого текстового поля

$forms_fields_cols

ширина большого текстового поля

$forms_fields_checked

параметр, определяющий отображать поле типа checkbox выбранным или нет (0 – не выбрано, 1 выбрано)

$forms_fields_comment

поясняющий комментарий к полю

$forms_fields_obligatory

параметр, определяющий является поле обязательным для заполнения (0 – необязательное (по умолчанию), 1 – обязательное)

$users_id

идентификатор пользователя, если false - берется текущий пользователь.

 <?php
 $Form = new Forms();
 
 $type = 0;
 $forms_fields_id = 0;
 $forms_id = 6;
 $lists_id = 1;
 $forms_fields_type = 0;
 $forms_fields_name = 'Field';
 $forms_fields_text_name = 'Поле';
 $forms_fields_default_value = '';
 $forms_fields_order = 10;
 $forms_fields_size = '';
 $forms_fields_rows = '';
 $forms_fields_cols = '';
 $forms_fields_checked = 0;
 $forms_fields_comment = '';
 $forms_fields_obligatory = 0;
 
 newid = $Form->InsertFormsFields($type, $forms_fields_id, $forms_id, $lists_id, $forms_fields_type, $forms_fields_name, $forms_fields_text_name, $forms_fields_default_value, $forms_fields_order, $forms_fields_size, $forms_fields_rows, $forms_fields_cols, $forms_fields_checked, $forms_fields_comment);
 
 // Распечатаем результат
 echo $newid;
 
 ?>

Возвращает

идентификатор вставленной/обновленной записи с информацией о поле формы в случае успешного выполнения, false в противном случае

[ Наверх ]

Forms::InsertFormsFill

InsertFormsFill( int $type, int $forms_fill_id, int $forms_id, int $forms_fill_ip, string $forms_fill_date );

Описание

Вставка/обновление информации о заполнении формы

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

$type

параметр, определяющий производится вставка или обновление информации о заполнении формы

$forms_fill_id

идентификатор редактируемой записи с информацией о заполненной форме (при вставке равен 0)

$forms_id

идентификатор формы

$forms_fill_ip

ip-адрес компьютера пользователя, отправившего данные формы

$forms_fill_date

дата заполнения формы

 <?php
 $Form = new Forms();
 
 $type = 0;
 $forms_fill_id = 0;
 $forms_id = 6;
 $forms_fill_ip = '';
 $forms_fill_date = date('Y-m-d H:i:s');
 
 $newid = $Form->InsertFormsFill($type, $forms_fill_id, $forms_id, $forms_fill_ip, $forms_fill_date);
 
 // Распечатаем результат
 echo $newid;
 ?>

Возвращает

идентификатор вставленной/обновленной записи с информацией о заполнении поле формы в случае успешного выполнения, false в противном случае

[ Наверх ]

Forms::InsertFormsFillValues

InsertFormsFillValues( int $type, int $forms_fill_values_id, int $forms_fill_id, int $forms_fields_id, string $forms_fill_values_value );

Описание

Вставка/обновление значений заполненной формы

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

$type

параметр, определяющий производится вставка или обновление значений заполненной формы (0 - вставка, 1- обновление)

$forms_fill_values_id

идентификатор записи, хранящей данные одного из элементов формы

$forms_fill_id

идентификатор записи, хранящей данные о заполненной форме

$forms_fields_id

идентификатор элемента заполняемой формы

$forms_fill_values_value

значение элемента формы

 <?php
 $Form = new Forms();
 
 $type = 0;
 $forms_fill_values_id = '';
 $forms_fill_id = 6;
 $forms_fields_id = 0;
 $forms_fill_values_value = '';
 
 $newid = $Form->InsertFormsFillValues($type, $forms_fill_values_id, $forms_fill_id, $forms_fields_id, $forms_fill_values_value);
 
 // Распечатаем результат
 echo $newid;
 ?>

Возвращает

идентификатор добавленной/отредактированной записи, хранящей данные о значении, переданном из формы в случае успешного выполнения, false в противном случае

[ Наверх ]

Forms::SelectForms

SelectForms( int $forms_id );

Описание

Получение данных о формах

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

$forms_id

идентификатор формы, данные о которой необходимо получить, если $forms_id = -1, то получаем данные о всех формах

 <?php
 $Form = new Forms();
 
 $forms_id = 6;
 
 $resource = $Form->SelectForms($forms_id);
 
 // Распечатаем результат
 while($row = mysql_fetch_assoc($resource))
 {
     print_r($row);
 }
 ?>

Возвращает

resource в случае успешного выполнения, false в потивном случае

[ Наверх ]

Forms::SelectFormsFields

SelectFormsFields( int $field_id );

Описание

Получение данных о поле формы

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

$field_id

идентификатор поля формы, данные о котором необходимо получить

 <?php
 $Form = new Forms();
 
 $field_id = 6;
 
 $resource = $Form->SelectFormsFields($field_id);
 
 // Распечатаем результат
 $row = mysql_fetch_assoc($resource);
 
 print_r($row);
 
 ?>

Возвращает

resource в случае успешного выполнения, false в противном случае

[ Наверх ]

Forms::ShowForm

ShowForm( int $form_id, string $xsl_name, [array $external_propertys = array()], [array $fill_value = array()] );

Описание

Отображение формы

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

$form_id

идентификатор формы

$xsl_name

название XSL-шаблона

$external_propertys

массив дополнительных свойств для включения в исходный XML код

$fill_value

массив заполненых значений для полей. Если не передан, используются данные, переданные методом POST

 <?php
 $Form = new Forms();
 
 $form_id = 6;
 $xsl_name = 'ОтобразитьФорму';
 
 $result = $Form->ShowForm($form_id, $xsl_name);
 
 if ($result)
 {
     echo "Удаление выполнено успешно";
 }
 else
 {
     echo "Ошибка удаления";
 }
 ?>

Возвращает

true в случае успешного выполнения, false в противном случае

[ Наверх ]

Class Forms

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

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

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

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

Методы

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

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

Forms::ConfirmGetForm

Forms::CopyForms

Forms::CopyFormsField

Forms::DelFillForms

Forms::DelFillValues

Forms::DelForms

Forms::DelFormsFields

Forms::GetAllForms

Forms::GetCountFormsFill

Forms::GetFillForm

Forms::GetFillForms

Forms::GetFillFormsFields

Forms::GetForm

Forms::GetFormFields

Forms::GetFormInfo

Forms::InsertForms

Forms::InsertFormsFields

Forms::InsertFormsFill

Forms::InsertFormsFillValues

Forms::SelectForms

Forms::SelectFormsFields

Forms::ShowForm

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

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