mirror of
https://github.com/Lastorder-DC/rhymix.git
synced 2026-01-04 01:01:41 +09:00
Implement default extravar skin to replace hardcoded HTML in ExtraItem class
This commit is contained in:
Kijin Sung
parent
dd06193a1d
commit
31fa498b19
14 changed files with 604 additions and 590 deletions
|
|
@ -1,592 +1,4 @@
|
|||
<?php
|
||||
|
||||
/**
|
||||
* A class to handle extra variables used in posts, member and others
|
||||
*
|
||||
* @author NAVER (developers@xpressengine.com)
|
||||
*/
|
||||
class ExtraVar
|
||||
{
|
||||
|
||||
/**
|
||||
* sequence of module
|
||||
* @var int
|
||||
*/
|
||||
var $module_srl = null;
|
||||
|
||||
/**
|
||||
* Current module's Set of ExtraItem
|
||||
* @var ExtraItem[]
|
||||
*/
|
||||
var $keys = array();
|
||||
|
||||
/**
|
||||
* Get instance of ExtraVar (singleton)
|
||||
*
|
||||
* @param int $module_srl Sequence of module
|
||||
* @return ExtraVar
|
||||
*/
|
||||
public static function getInstance($module_srl)
|
||||
{
|
||||
return new ExtraVar($module_srl);
|
||||
}
|
||||
|
||||
/**
|
||||
* Constructor
|
||||
*
|
||||
* @param int $module_srl Sequence of module
|
||||
* @return void
|
||||
*/
|
||||
function __construct($module_srl)
|
||||
{
|
||||
$this->module_srl = $module_srl;
|
||||
}
|
||||
|
||||
/**
|
||||
* Register a key of extra variable
|
||||
*
|
||||
* @param object[] $extra_keys Array of extra variable. A value of array is object that contains module_srl, idx, name, default, desc, is_required, search, value, eid.
|
||||
* @return void
|
||||
*/
|
||||
function setExtraVarKeys($extra_keys)
|
||||
{
|
||||
if(!is_array($extra_keys) || count($extra_keys) < 1)
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
foreach($extra_keys as $val)
|
||||
{
|
||||
$obj = new ExtraItem($val->module_srl, $val->idx, $val->name, $val->type, $val->default, $val->desc, $val->is_required, $val->search, $val->value ?? null, $val->eid);
|
||||
$this->keys[$val->idx] = $obj;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns an array of ExtraItem
|
||||
*
|
||||
* @return ExtraItem[]
|
||||
*/
|
||||
function getExtraVars()
|
||||
{
|
||||
return $this->keys;
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
/**
|
||||
* Each value of the extra vars
|
||||
*
|
||||
* @author NAVER (developers@xpressengine.com)
|
||||
*/
|
||||
class ExtraItem
|
||||
{
|
||||
|
||||
/**
|
||||
* Sequence of module
|
||||
* @var int
|
||||
*/
|
||||
var $module_srl = 0;
|
||||
|
||||
/**
|
||||
* Index of extra variable
|
||||
* @var int
|
||||
*/
|
||||
var $idx = 0;
|
||||
|
||||
/**
|
||||
* Name of extra variable
|
||||
* @var string
|
||||
*/
|
||||
var $name = 0;
|
||||
|
||||
/**
|
||||
* Type of extra variable
|
||||
* @var string text, homepage, email_address, tel, textarea, checkbox, date, select, radio, kr_zip
|
||||
*/
|
||||
var $type = 'text';
|
||||
|
||||
/**
|
||||
* Default values
|
||||
* @var string[]
|
||||
*/
|
||||
var $default = null;
|
||||
|
||||
/**
|
||||
* Description
|
||||
* @var string
|
||||
*/
|
||||
var $desc = '';
|
||||
|
||||
/**
|
||||
* Whether required or not requred this extra variable
|
||||
* @var string Y, N
|
||||
*/
|
||||
var $is_required = 'N';
|
||||
|
||||
/**
|
||||
* Whether can or can not search this extra variable
|
||||
* @var string Y, N
|
||||
*/
|
||||
var $search = 'N';
|
||||
|
||||
/**
|
||||
* Value
|
||||
* @var string
|
||||
*/
|
||||
var $value = null;
|
||||
|
||||
/**
|
||||
* Unique id of extra variable in module
|
||||
* @var string
|
||||
*/
|
||||
var $eid = '';
|
||||
|
||||
/**
|
||||
* Constructor
|
||||
*
|
||||
* @param int $module_srl Sequence of module
|
||||
* @param int $idx Index of extra variable
|
||||
* @param string $type Type of extra variable. text, homepage, email_address, tel, textarea, checkbox, date, sleect, radio, kr_zip
|
||||
* @param string[] $default Default values
|
||||
* @param string $desc Description
|
||||
* @param string $is_required Whether required or not requred this extra variable. Y, N
|
||||
* @param string $search Whether can or can not search this extra variable
|
||||
* @param string $value Value
|
||||
* @param string $eid Unique id of extra variable in module
|
||||
* @return void
|
||||
*/
|
||||
function __construct($module_srl, $idx, $name, $type = 'text', $default = null, $desc = '', $is_required = 'N', $search = 'N', $value = null, $eid = '')
|
||||
{
|
||||
if(!$idx)
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
$this->module_srl = $module_srl;
|
||||
$this->idx = $idx;
|
||||
$this->name = $name;
|
||||
$this->type = $type;
|
||||
$this->default = $default;
|
||||
$this->desc = $desc;
|
||||
$this->is_required = $is_required;
|
||||
$this->search = $search;
|
||||
$this->value = $value;
|
||||
$this->eid = $eid;
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets Value
|
||||
*
|
||||
* @param string $value The value to set
|
||||
* @return void
|
||||
*/
|
||||
function setValue($value)
|
||||
{
|
||||
$this->value = $value;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a given value converted based on its type
|
||||
*
|
||||
* @param string $type Type of variable
|
||||
* @param string $value Value
|
||||
* @return string|array Returns a converted value
|
||||
*/
|
||||
function _getTypeValue($type, $value)
|
||||
{
|
||||
$value = trim($value ?? '');
|
||||
if($value === '')
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
switch($type)
|
||||
{
|
||||
case 'homepage' :
|
||||
if($value && !preg_match('/^([a-z]+):\/\//i', $value))
|
||||
{
|
||||
$value = 'http://' . $value;
|
||||
}
|
||||
return escape($value, false);
|
||||
|
||||
case 'tel':
|
||||
case 'tel_v2':
|
||||
case 'tel_intl':
|
||||
case 'tel_intl_v2':
|
||||
if(is_array($value))
|
||||
{
|
||||
$values = $value;
|
||||
}
|
||||
elseif(strpos($value, '|@|') !== FALSE)
|
||||
{
|
||||
$values = explode('|@|', $value);
|
||||
}
|
||||
elseif(strpos($value, ',') !== FALSE)
|
||||
{
|
||||
$values = explode(',', $value);
|
||||
}
|
||||
else
|
||||
{
|
||||
$values = array($value);
|
||||
}
|
||||
|
||||
$values = array_values($values);
|
||||
for($i = 0, $c = count($values); $i < $c; $i++)
|
||||
{
|
||||
$values[$i] = trim(escape($values[$i], false));
|
||||
}
|
||||
return $values;
|
||||
case 'checkbox' :
|
||||
case 'radio' :
|
||||
case 'select' :
|
||||
if(is_array($value))
|
||||
{
|
||||
$values = $value;
|
||||
}
|
||||
elseif(strpos($value, '|@|') !== FALSE)
|
||||
{
|
||||
$values = explode('|@|', $value);
|
||||
}
|
||||
elseif(strpos($value, ',') !== FALSE)
|
||||
{
|
||||
$values = explode(',', $value);
|
||||
}
|
||||
else
|
||||
{
|
||||
$values = array($value);
|
||||
}
|
||||
|
||||
$values = array_values($values);
|
||||
for($i = 0, $c = count($values); $i < $c; $i++)
|
||||
{
|
||||
$values[$i] = trim(escape($values[$i], false));
|
||||
}
|
||||
return $values;
|
||||
|
||||
case 'kr_zip' :
|
||||
if(is_array($value))
|
||||
{
|
||||
$values = $value;
|
||||
}
|
||||
elseif(strpos($value, '|@|') !== false)
|
||||
{
|
||||
$values = explode('|@|', $value);
|
||||
}
|
||||
else
|
||||
{
|
||||
$values = array($value);
|
||||
}
|
||||
|
||||
$values = array_values($values);
|
||||
for($i = 0, $c = count($values); $i < $c; $i++)
|
||||
{
|
||||
$values[$i] = trim(escape($values[$i], false));
|
||||
}
|
||||
return $values;
|
||||
|
||||
//case 'date' :
|
||||
//case 'time' :
|
||||
//case 'email_address' :
|
||||
//case 'text' :
|
||||
//case 'textarea' :
|
||||
//case 'password' :
|
||||
default :
|
||||
return escape($value, false);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a value for HTML
|
||||
*
|
||||
* @return string|array Returns filtered value
|
||||
*/
|
||||
function getValue()
|
||||
{
|
||||
return $this->_getTypeValue($this->type, $this->value);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a value for HTML
|
||||
*
|
||||
* @return string Returns a value expressed in HTML.
|
||||
*/
|
||||
function getValueHTML()
|
||||
{
|
||||
$value = $this->_getTypeValue($this->type, $this->value);
|
||||
|
||||
switch($this->type)
|
||||
{
|
||||
case 'homepage' :
|
||||
return ($value) ? (sprintf('<a href="%s" target="_blank">%s</a>', $value, strlen($value) > 60 ? substr($value, 0, 40) . '...' . substr($value, -10) : $value)) : "";
|
||||
|
||||
case 'email_address' :
|
||||
return ($value) ? sprintf('<a href="mailto:%s">%s</a>', $value, $value) : "";
|
||||
|
||||
case 'tel' :
|
||||
case 'tel_v2' :
|
||||
return $value ? implode('-', $value) : '';
|
||||
case 'tel_intl' :
|
||||
case 'tel_intl_v2' :
|
||||
$country_number = $value[0] ?? '';
|
||||
$array_slice = $value ? array_slice($value, 1) : [];
|
||||
$phone_number = implode('-', $array_slice);
|
||||
return $value ? "+{$country_number}){$phone_number}": '';
|
||||
case 'country':
|
||||
$country_info = Rhymix\Framework\i18n::listCountries()[$value];
|
||||
$lang_type = Context::get('lang_type');
|
||||
$country_name = $lang_type === 'ko' ? $country_info->name_korean : $country_info->name_english;
|
||||
return $country_name;
|
||||
case 'textarea' :
|
||||
return nl2br($value);
|
||||
|
||||
case 'date' :
|
||||
return $value ? sprintf('%s-%s-%s', substr($value, 0, 4), substr($value, 4, 2), substr($value, 6, 2)) : '';
|
||||
|
||||
case 'language':
|
||||
return Rhymix\Framework\Lang::getSupportedList()[$value]['name'];
|
||||
|
||||
case 'timezone':
|
||||
return Rhymix\Framework\DateTime::getTimezoneList()[$value];
|
||||
case 'checkbox' :
|
||||
case 'select' :
|
||||
case 'radio' :
|
||||
if(is_array($value))
|
||||
{
|
||||
return implode(',', $value);
|
||||
}
|
||||
return $value;
|
||||
|
||||
case 'kr_zip' :
|
||||
if(is_array($value))
|
||||
{
|
||||
return implode(' ', $value);
|
||||
}
|
||||
return $value;
|
||||
|
||||
// case 'text' :
|
||||
// case 'password' :
|
||||
// case 'time' :
|
||||
default :
|
||||
return $value;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a form based on its type
|
||||
*
|
||||
* @return string Returns a form html.
|
||||
*/
|
||||
function getFormHTML()
|
||||
{
|
||||
static $id_num = 1000;
|
||||
|
||||
$type = $this->type;
|
||||
$name = $this->name;
|
||||
$value = $this->_getTypeValue($this->type, $this->value);
|
||||
$default = $this->_getTypeValue($this->type, $this->default);
|
||||
$column_name = 'extra_vars' . $this->idx;
|
||||
$tmp_id = $column_name . '-' . $id_num++;
|
||||
|
||||
$buff = array();
|
||||
switch($type)
|
||||
{
|
||||
// Homepage
|
||||
case 'homepage' :
|
||||
$buff[] = '<input type="url" name="' . $column_name . '" value="' . $value . '" class="homepage rx_ev_url" />';
|
||||
break;
|
||||
// Email Address
|
||||
case 'email_address' :
|
||||
$buff[] = '<input type="email" name="' . $column_name . '" value="' . $value . '" class="email_address rx_ev_email" />';
|
||||
break;
|
||||
// Phone Number
|
||||
case 'tel' :
|
||||
$buff[] = '<input type="tel" name="' . $column_name . '[]" value="' . ($value[0] ?? '') . '" size="4" maxlength="4" class="tel rx_ev_tel1" />';
|
||||
$buff[] = '<input type="tel" name="' . $column_name . '[]" value="' . ($value[1] ?? '') . '" size="4" maxlength="4" class="tel rx_ev_tel2" />';
|
||||
$buff[] = '<input type="tel" name="' . $column_name . '[]" value="' . ($value[2] ?? '') . '" size="4" maxlength="4" class="tel rx_ev_tel3" />';
|
||||
break;
|
||||
// Phone Number v2 (single input)
|
||||
case 'tel_v2' :
|
||||
$buff[] = '<input type="tel" name="' . $column_name . '[]" value="' . ($value[0] ?? '') . '" size="16" maxlength="16" class="rx_ev_tel_v2" />';
|
||||
break;
|
||||
// Select Country Number
|
||||
case 'tel_intl' :
|
||||
case 'tel_intl_v2' :
|
||||
$lang_type = Context::get('lang_type');
|
||||
$country_list = Rhymix\Framework\i18n::listCountries($lang_type === 'ko' ? Rhymix\Framework\i18n::SORT_NAME_KOREAN : Rhymix\Framework\i18n::SORT_NAME_ENGLISH);
|
||||
$buff[] = '<select name="' . $column_name . '" class="select rx_ev_select rx_ev_select_country">';
|
||||
$buff[] = ' <option value=""></option>';
|
||||
foreach($country_list as $country_info)
|
||||
{
|
||||
if($country_info->calling_code)
|
||||
{
|
||||
$selected = '';
|
||||
if(strval($value[0] ?? '') !== '' && $country_info->calling_code == $value[0])
|
||||
{
|
||||
$selected = ' selected="selected"';
|
||||
}
|
||||
// 3항식 사용시 따로 변수로 뽑아야 뒤의 스트링 만드는것의 중복된 코드가 줄어듬
|
||||
$country_name = $lang_type === 'ko' ? $country_info->name_korean : $country_info->name_english;
|
||||
$string = $country_name . "(+{$country_info->calling_code})";
|
||||
$buff[] = ' <option value="' . $country_info->calling_code . '" ' . $selected . '>' . $string . '</option>';
|
||||
}
|
||||
}
|
||||
$buff[] = '</select>';
|
||||
if ($type === 'tel_intl_v2')
|
||||
{
|
||||
$buff[] = '<input type="tel" name="' . $column_name . '[]" value="' . ($value[1] ?? '') . '" size="16" maxlength="16" class="rx_ev_tel_v2" />';
|
||||
}
|
||||
else
|
||||
{
|
||||
$buff[] = '<input type="tel" name="' . $column_name . '[]" value="' . ($value[1] ?? '') . '" size="4" maxlength="4" class="tel rx_ev_tel1" />';
|
||||
$buff[] = '<input type="tel" name="' . $column_name . '[]" value="' . ($value[2] ?? '') . '" size="4" maxlength="4" class="tel rx_ev_tel2" />';
|
||||
$buff[] = '<input type="tel" name="' . $column_name . '[]" value="' . ($value[3] ?? '') . '" size="4" maxlength="4" class="tel rx_ev_tel3" />';
|
||||
}
|
||||
break;
|
||||
// Select Country
|
||||
case 'country':
|
||||
$lang_type = Context::get('lang_type');
|
||||
$country_list = Rhymix\Framework\i18n::listCountries($lang_type === 'ko' ? Rhymix\Framework\i18n::SORT_NAME_KOREAN : Rhymix\Framework\i18n::SORT_NAME_ENGLISH);
|
||||
$buff[] = '<select name="' . $column_name . '" class="select rx_ev_select rx_ev_select_country">';
|
||||
foreach($country_list as $country_info)
|
||||
{
|
||||
$selected = '';
|
||||
if (strval($value[0] ?? '') !== '' && $country_info->iso_3166_1_alpha3 == $value)
|
||||
{
|
||||
$selected = ' selected="selected"';
|
||||
}
|
||||
// 3항식 사용시 따로 변수로 뽑아야 뒤의 스트링 만드는것의 중복된 코드가 줄어듬
|
||||
$country_name = $lang_type === 'ko' ? $country_info->name_korean : $country_info->name_english;
|
||||
$string = $country_name;
|
||||
$buff[] = ' <option value="' . $country_info->iso_3166_1_alpha3 . '" ' . $selected . '>' . $string . '</option>';
|
||||
}
|
||||
$buff[] = '</select>';
|
||||
break;
|
||||
// Select language
|
||||
case 'language':
|
||||
$enable_language = Rhymix\Framework\Config::get('locale.enabled_lang');
|
||||
$supported_lang = Rhymix\Framework\Lang::getSupportedList();
|
||||
$buff[] = '<select name="' . $column_name . '" class="select rx_ev_select rx_ev_select_language">';
|
||||
foreach ($enable_language as $lang_type)
|
||||
{
|
||||
$selected = '';
|
||||
if (isset($value) && strval($value) !== '' && $lang_type === $value)
|
||||
{
|
||||
$selected = ' selected="selected"';
|
||||
}
|
||||
|
||||
$buff[] = ' <option value="' . $lang_type . '" ' . $selected . '>' . $supported_lang[$lang_type]['name'] . '</option>';
|
||||
}
|
||||
$buff[] = '</select>';
|
||||
break;
|
||||
// Select timezone
|
||||
case 'timezone':
|
||||
$timezone_list = Rhymix\Framework\DateTime::getTimezoneList();
|
||||
$buff[] = '<select name="' . $column_name . '" class="select rx_ev_select rx_ev_select_timezone">';
|
||||
foreach ($timezone_list as $key => $time_name)
|
||||
{
|
||||
$selected = '';
|
||||
if (isset($value) && strval($value) !== '' && $key === $value)
|
||||
{
|
||||
$selected = ' selected="selected"';
|
||||
}
|
||||
$buff[] = ' <option value="' . $key . '" ' . $selected . '>' . $time_name . '</option>';
|
||||
}
|
||||
$buff[] = '</select>';
|
||||
break;
|
||||
// textarea
|
||||
case 'textarea' :
|
||||
$buff[] = '<textarea class="rx_ev_textarea" name="' . $column_name . '" rows="8" cols="42">' . $value . '</textarea>';
|
||||
break;
|
||||
// multiple choice
|
||||
case 'checkbox' :
|
||||
$buff[] = '<ul class="rx_ev_checkbox">';
|
||||
foreach($default as $v)
|
||||
{
|
||||
$checked = '';
|
||||
if(is_array($value) && in_array(trim($v), $value))
|
||||
{
|
||||
$checked = ' checked="checked"';
|
||||
}
|
||||
|
||||
// Temporary ID for labeling
|
||||
$tmp_id = $column_name . '-' . $id_num++;
|
||||
|
||||
$buff[] =' <li><input type="checkbox" name="' . $column_name . '[]" id="' . $tmp_id . '" value="' . escape($v, false) . '" ' . $checked . ' /><label for="' . $tmp_id . '">' . $v . '</label></li>';
|
||||
}
|
||||
$buff[] = '</ul>';
|
||||
break;
|
||||
// single choice
|
||||
case 'select' :
|
||||
$buff[] = '<select name="' . $column_name . '" class="select rx_ev_select">';
|
||||
foreach($default as $v)
|
||||
{
|
||||
$selected = '';
|
||||
if(is_array($value) && in_array(trim($v), $value))
|
||||
{
|
||||
$selected = ' selected="selected"';
|
||||
}
|
||||
$buff[] = ' <option value="' . $v . '" ' . $selected . '>' . $v . '</option>';
|
||||
}
|
||||
$buff[] = '</select>';
|
||||
break;
|
||||
// radio
|
||||
case 'radio' :
|
||||
$buff[] = '<ul class="rx_ev_radio">';
|
||||
foreach($default as $v)
|
||||
{
|
||||
$checked = '';
|
||||
if(is_array($value) && in_array(trim($v), $value))
|
||||
{
|
||||
$checked = ' checked="checked"';
|
||||
}
|
||||
|
||||
// Temporary ID for labeling
|
||||
$tmp_id = $column_name . '-' . $id_num++;
|
||||
|
||||
$buff[] = '<li><input type="radio" name="' . $column_name . '" id="' . $tmp_id . '" ' . $checked . ' value="' . $v . '" class="radio" /><label for="' . $tmp_id . '">' . $v . '</label></li>';
|
||||
}
|
||||
$buff[] = '</ul>';
|
||||
break;
|
||||
// date
|
||||
case 'date' :
|
||||
$formatted_value = $value ? sprintf('%s-%s-%s', substr($value, 0, 4), substr($value, 4, 2), substr($value, 6, 2)) : '';
|
||||
$buff[] = '<input type="hidden" class="rx_ev_date" name="' . $column_name . '" value="' . $value . '" />';
|
||||
$buff[] = '<input type="date" class="date" value="' . $formatted_value . '" ' .
|
||||
'pattern="\d{4}-\d{2}-\d{2}" placeholder="YYYY-MM-DD" ' .
|
||||
'onchange="jQuery(this).prev(\'.rx_ev_date\').val(this.value.replace(/-/g,\'\'));" /> ';
|
||||
$buff[] = '<button type="button" class="btn dateRemover" ' .
|
||||
'onclick="jQuery(this).prev(\'.date\').val(\'\').trigger(\'change\');return false;">' .
|
||||
lang('cmd_delete') . '</button>';
|
||||
break;
|
||||
// time
|
||||
case 'time' :
|
||||
$buff[] = '<input type="time" name="' . $column_name . '" class="rx_ev_time" value="' . $value . '" pattern="\d{2}:\d{2}" />';
|
||||
$buff[] = '<button type="button" class="btn timeRemover" ' .
|
||||
'onclick="jQuery(this).prev(\'.rx_ev_time\').val(\'\');return false;">' .
|
||||
lang('cmd_delete') . '</button>';
|
||||
break;
|
||||
// address
|
||||
case "kr_zip" :
|
||||
if(($oKrzipModel = getModel('krzip')) && method_exists($oKrzipModel , 'getKrzipCodeSearchHtml' ))
|
||||
{
|
||||
$buff[] = $oKrzipModel->getKrzipCodeSearchHtml($column_name, $value);
|
||||
}
|
||||
break;
|
||||
// Password
|
||||
case "password" :
|
||||
$buff[] =' <input type="password" class="password rx_ev_password" name="' . $column_name . '" value="' . (strval($value) !== '' ? $value : $default) . '" />';
|
||||
break;
|
||||
// General text
|
||||
default :
|
||||
$buff[] =' <input type="text" class="text rx_ev_text" name="' . $column_name . '" value="' . (strval($value) !== '' ? $value : $default) . '" />';
|
||||
}
|
||||
if($this->desc)
|
||||
{
|
||||
$buff[] = '<p>' . nl2br(trim(escape(Context::replaceUserLang($this->desc), false))) . '</p>';
|
||||
}
|
||||
|
||||
return join("\n", $buff);
|
||||
}
|
||||
|
||||
}
|
||||
class_alias('Rhymix\Modules\Extravar\Models\ValueCollection', 'ExtraVar');
|
||||
class_alias('Rhymix\Modules\Extravar\Models\Value', 'ExtraItem');
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue