mirror of
https://github.com/FOSSBilling/FOSSBilling.git
synced 2026-11-21 20:34:57 +09:00
328 lines
10 KiB
PHP
328 lines
10 KiB
PHP
<?php
|
|
/**
|
|
* BoxBilling
|
|
*
|
|
* @copyright BoxBilling, Inc (http://www.boxbilling.com)
|
|
* @license Apache-2.0
|
|
*
|
|
* Copyright BoxBilling, Inc
|
|
* This source file is subject to the Apache-2.0 License that is bundled
|
|
* with this source code in the file LICENSE
|
|
*/
|
|
|
|
/**
|
|
* Manage custom orders forms
|
|
*/
|
|
|
|
namespace Box\Mod\Formbuilder\Api;
|
|
|
|
class Admin extends \Api_Abstract
|
|
{
|
|
/**
|
|
* Create custom order form for product
|
|
*
|
|
* @param string $name - Name of new form
|
|
*
|
|
* @optional string $style - Style/Type of the form. Default value is "horizontal". Other possible types are "inline", "search", "actions"
|
|
*
|
|
*
|
|
* @return int - ID of the created form
|
|
* @throws Box_Exception
|
|
*/
|
|
public function create_form($data)
|
|
{
|
|
$required = array(
|
|
'name' => 'Form name was not provided',
|
|
);
|
|
$this->di['validator']->checkRequiredParamsForArray($required, $data);
|
|
|
|
if (isset($data["type"]) && (strtolower($data["type"])!= "horizontal" || strtolower($data["type"])!= "default" )){
|
|
throw new \Box_Exception ("Form style was not found in predefined list", null, 3657);
|
|
}
|
|
|
|
$service = $this->getService();
|
|
$formId = $service->addNewForm($data);
|
|
|
|
return $formId;
|
|
}
|
|
|
|
/**
|
|
* Add new field to form
|
|
*
|
|
* @param string $type - Field type
|
|
* @param int $form_id - ID of the field form
|
|
*
|
|
* @optional
|
|
* @optional string $label - Label of the field which will be shown. Default value "Type X" where X is number of fields in form. For example "Checkbox 2"
|
|
* @optional string $name - Name of the field. Dafault value "new_type_X" where X is number of fields in the form. For example "new_checkbox_2"
|
|
* @optional bool $hide_label - Option either hide label of field or not
|
|
* @optional string $description - Description of a field
|
|
* @optional mixed $default_value - Default value of field. If field is checkbox or radio this variable must be array, otherwise it is string
|
|
* @optional bool $required - Option wither field need to have "required" attribute (Not applicable for checkboxes)
|
|
* @optional bool $hidden - Option either field should be hidden
|
|
* @optional bool $readonly - Option either field needs to be readonly
|
|
* @optional string $prefix - Prefix for "text" type fields
|
|
* @optional string $suffix - Suffix for "text" type fields
|
|
* @optional array $options - Array of options for "select", "checkbox" and "radio" type fields. Key represents label and value will be field's value. Array must be unique.
|
|
* @optional bool $show_initial - Either show initial or not
|
|
* @optional bool $show_middle - Either show middle or not
|
|
* @optional bool $show_prefix - Either to show prefix or not
|
|
* @optional bool $show_suffix - Either to show suffix or not
|
|
* @optional int $text_size - Prefered text size
|
|
*
|
|
* @return int - ID of created field
|
|
* @throws Box_Exception
|
|
*/
|
|
public function add_field($data)
|
|
{
|
|
$service = $this->getService();
|
|
if (!isset($data['type']) || !$service->typeValidation($data['type'])) {
|
|
throw new \Box_Exception('Form field type is not valid', null, 2684);
|
|
}
|
|
if (isset($data['options']) && is_array(($data['options'])) && !$service->isArrayUnique($data['options'])) {
|
|
throw new \Box_Exception('This input type must have unique values', null, 3658);
|
|
}
|
|
if (!isset($data['form_id'])) {
|
|
throw new \Box_Exception('Form id was not passed', null, 9846);
|
|
}
|
|
|
|
$fieldId = $service->addNewField($data);
|
|
return $fieldId;
|
|
}
|
|
|
|
/**
|
|
* Get form data by it's id
|
|
*
|
|
* @param int $id - ID of the form
|
|
*
|
|
* @return array
|
|
* @throws Box_Exception
|
|
*/
|
|
|
|
public function get_form($data)
|
|
{
|
|
$required = array(
|
|
'id' => 'Form id was not passed',
|
|
);
|
|
$this->di['validator']->checkRequiredParamsForArray($required, $data, null, 2391);
|
|
|
|
$service = $this->getService();
|
|
return $service->getForm($data['id']);
|
|
}
|
|
|
|
/**
|
|
* Get fields data by form's id
|
|
*
|
|
* @param int $form_id - ID of form
|
|
*
|
|
* @return array
|
|
* @throws Box_Exception
|
|
*/
|
|
public function get_form_fields($data)
|
|
{
|
|
$required = array(
|
|
'form_id' => 'Form id was not passed',
|
|
);
|
|
$this->di['validator']->checkRequiredParamsForArray($required, $data, null, 1822);
|
|
|
|
$service = $this->getService();
|
|
$fields = $service->getFormFields($data['form_id']);
|
|
|
|
return $fields;
|
|
}
|
|
|
|
|
|
/**
|
|
* Get field data by field id
|
|
*
|
|
* @param int $id - ID of the fields
|
|
*
|
|
* @return array
|
|
* @throws Box_Exception
|
|
*/
|
|
public function get_field($data)
|
|
{
|
|
$required = array(
|
|
'id' => 'Field id was not passed',
|
|
);
|
|
$this->di['validator']->checkRequiredParamsForArray($required, $data, null, 3547);
|
|
|
|
$service = $this->getService();
|
|
$field = $service->getField($data['id']);
|
|
|
|
return $field;
|
|
}
|
|
|
|
/**
|
|
* Get array of forms
|
|
*
|
|
*
|
|
*
|
|
* @return multidimensional array
|
|
* @throws Box_Exception
|
|
*/
|
|
public function get_forms()
|
|
{
|
|
$service = $this->getService();
|
|
$forms = $service->getForms();
|
|
return $forms;
|
|
}
|
|
|
|
/**
|
|
* Delete form and it's form fields
|
|
*
|
|
* @param int $id - ID of the form
|
|
*
|
|
* @return bool
|
|
* @throws Box_Exception
|
|
*/
|
|
public function delete_form($data)
|
|
{
|
|
$required = array(
|
|
'id' => 'Form id was not passed',
|
|
);
|
|
$this->di['validator']->checkRequiredParamsForArray($required, $data, null, 9958);
|
|
|
|
$service = $this->getService();
|
|
$service->removeForm($data['id']);
|
|
return true;
|
|
}
|
|
|
|
|
|
/**
|
|
* Delete field by id
|
|
*
|
|
* @param int $id - ID of the field
|
|
*
|
|
* @return bool
|
|
* @throws Box_Exception
|
|
*/
|
|
public function delete_field($data)
|
|
{
|
|
$required = array(
|
|
'id' => 'Field id was not passed',
|
|
);
|
|
$this->di['validator']->checkRequiredParamsForArray($required, $data, null, 9959);
|
|
|
|
$service = $this->getService();
|
|
$service->removeField($data);
|
|
return true;
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
* Update form
|
|
*
|
|
* @param array
|
|
*
|
|
* @param string $type - Field type
|
|
* @param int $form_id - ID of the field form
|
|
*
|
|
* @optional
|
|
* @optional string $label - Label of the field which will be shown. Default value "Type X" where X is number of fields in form. For example "Checkbox 2"
|
|
* @optional string $name - Name of the field. Dafault value "new_type_X" where X is number of fields in the form. For example "new_checkbox_2"
|
|
* @optional bool $hide_label - Option either hide label of field or not
|
|
* @optional string $description - Description of a field
|
|
* @optional mixed $default_value - Default value of field. If field is checkbox or radio this variable must be array, otherwise it is string
|
|
* @optional bool $required - Option wither field need to have "required" attribute (Not applicable for checkboxes)
|
|
* @optional bool $hidden - Option either field should be hidden
|
|
* @optional bool $readonly - Option either field needs to be readonly
|
|
* @optional string $prefix - Prefix for "text" type fields
|
|
* @optional string $suffix - Suffix for "text" type fields
|
|
* @optional array $options - Array of options for "select", "checkbox" and "radio" type fields. Key represents label and value will be field's value. Array must be unique.
|
|
* @optional bool $show_initial - Either show initial or not
|
|
* @optional bool $show_middle - Either show middle or not
|
|
* @optional bool $show_prefix - Eithor to show prefix or not
|
|
* @optional bool $show_suffix - Either to show suffix or not
|
|
* @optional int $text_size - Prefered text size
|
|
*
|
|
* @return int - ID of the field
|
|
* @throws Box_Exception
|
|
*/
|
|
public function update_field($data)
|
|
{
|
|
$required = array(
|
|
'id' => 'Field id was not passed',
|
|
);
|
|
$this->di['validator']->checkRequiredParamsForArray($required, $data, null, 9958);
|
|
|
|
$service = $this->getService();
|
|
if (isset($data['options']) && !$service->isArrayUnique($data['options'])) {
|
|
throw new \Box_Exception('This input type must have unique values', null, 3658);
|
|
}
|
|
|
|
$fieldId = $service->updateField($data);
|
|
|
|
return $fieldId;
|
|
}
|
|
|
|
|
|
/**
|
|
* Get form pairs
|
|
*
|
|
* @return mixed
|
|
*/
|
|
public function get_pairs($data)
|
|
{
|
|
$service = $this->getService();
|
|
return $service->getFormPairs();
|
|
}
|
|
|
|
|
|
/**
|
|
* Dublicate form with its fields in database
|
|
*
|
|
* @param int $form_id - ID of the origin form
|
|
* @param string $name - Name of copied form
|
|
*
|
|
*
|
|
* @return int - ID of the new form
|
|
* @throws Box_Exception
|
|
*/
|
|
public function copy_form($data)
|
|
{
|
|
if (!isset($data['form_id'])) {
|
|
throw new \Box_Exception('Form id was not passed', null, 9958);
|
|
}
|
|
if (!isset($data['name'])) {
|
|
throw new \Box_Exception('Form name was not passed', null, 9842);
|
|
}
|
|
|
|
$service = $this->getService();
|
|
$new_form_id = $service->dublicateForm($data);
|
|
return $new_form_id;
|
|
}
|
|
|
|
/**
|
|
* Update form name and style
|
|
*
|
|
* @param int $form_id - ID of the form
|
|
* @param string $form_name - New name of the form
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function update_form_settings($data)
|
|
{
|
|
if (!isset($data['form_id']) || (trim($data['form_id']) == "")) {
|
|
throw new \Box_Exception('Form id was not passed', null, 1654);
|
|
}
|
|
if (!isset($data['form_name'])) {
|
|
throw new \Box_Exception('Form name was not passed', null, 9241);
|
|
}
|
|
|
|
if (!isset($data['type'])) {
|
|
throw new \Box_Exception('Form type was not passed', null, 3794);
|
|
}
|
|
|
|
if ($data['type'] !='horizontal' && $data['type'] != 'default') {
|
|
throw new \Box_Exception('Field type not supported', null, 3207);
|
|
}
|
|
|
|
$service = $this->getService();
|
|
return $service->updateFormSettings($data);
|
|
|
|
}
|
|
|
|
|
|
} |