👩🏼‍🌾 👨🏽‍🎓 🐣 Yii के लिए सरल कॉन्फ़िगरेशन फ़ाइल संपादक ⚠️ 🍁 👩🏻‍⚖️

शुभ संध्या, हब्बर।

आज मैं एक छोटे फॉर्म घटक के बारे में बात करूंगा जो मैंने अद्भुत PHP Yii फ्रेमवर्क के लिए लिखने के लिए हुआ था। यह घटक (या बल्कि, प्रपत्र मॉडल) आपको वेब से सीधे कॉन्फ़िगर फ़ाइलों को संपादित करने की अनुमति देता है। लेख इसी तरह की कार्यक्षमता पर एक हालिया पोस्ट से प्रेरित था, लेकिन यह कार्यान्वयन डेटाबेस पर आधारित है। यह Yii कॉन्फ़िगरेशन फ़ाइलों के लिए पूरी तरह से निष्क्रिय नहीं है। इसके अलावा, आपको अनावश्यक डेटाबेस / कैश अनुरोधों के साथ इस तरह के निर्णय के लिए भुगतान करना होगा, और आपको उन्हें उच्च ट्रैफ़िक वाली परियोजनाओं में सहेजने की आवश्यकता है।

लेख में बहुत सारे कोड होंगे, लेकिन मैं इसे तार्किक टुकड़ों में विभाजित करने का प्रयास करूंगा।

विचार

वाई में कॉन्फ़िगरेशन फ़ाइल एक नियमित php स्क्रिप्ट है जो एक सरणी देता है।
उदाहरण के लिए:

return array( 'name' => 'My Awesome Web Site', 'lang' => 'ru', 'sourceLang' => 'en', );

कॉन्फ़िगरेशन में, साइट के कुछ स्थिर पैरामीटर कभी-कभी संकेत दिए जाते हैं, जो वर्ष में एक बार बदलते हैं या बिल्कुल भी नहीं बदलते हैं। उदाहरण के लिए, व्यवस्थापक का ईमेल पता या फ़ोन नंबर लें, जिसे लोगो के बगल में प्रदर्शित किया गया है। इन मापदंडों को निश्चित रूप से साइट व्यवस्थापक द्वारा संपादित करने की अनुमति दी जानी चाहिए, लेकिन उसे कोड में क्रॉल न करने दें, है ना? (:

कार्यान्वयन

कार्यान्वयन स्वयं काफी सरल है, लेकिन एक ही समय में भ्रामक है। मैं चीजों को छांटने की कोशिश करूंगा।

आदर्श

एक मॉडल डेटा है। और config फाइल में क्या डेटा है? सही, विन्यास की एक सरणी। और उसके लिए हमें एक मॉडल बनाने की जरूरत है।

 class ConfigForm extends CFormModel { /** @var array ,      */ private $_config = array(); /** *   * @param array $config    * @param string $scenario   */ public function __construct($config = array(), $scenario = '') { parent::__construct($scenario); $this->setConfig($config); } public function setConfig($config) { $this->_config = $config; } public function getConfig() { return $this->_config; } }

अभी तक इतना सरल है, है ना?
वास्तव में, $ _config वैरिएबल की गोपनीयता की कोई आवश्यकता नहीं है, लेकिन यदि आप अचानक गेम के नियमों को बदलना चाहते हैं तो यह बहुत अधिक नहीं होगा।

अगला, हमें उन नियमों को स्थापित करने की आवश्यकता है जिनके द्वारा नाम का गठन किया जाएगा। आप हर बार मॉडल में एक नया फ़ील्ड नहीं जोड़ना चाहते (हालाँकि, फिर भी, आपको कुछ जोड़ना होगा, लेकिन बाद में और अधिक)। तो, मान लें कि हमारे पास इस तरह का कॉन्फ़िगरेशन सरणी है:

 array( 'name' => 'My Awesome Site', //   ,    -   'params' => array( 'adminEmail' => 'admin@example.com', 'phoneNumber' => '555-555-555', 'motto' => 'the best of the most awesome', ), );

इस सरणी से आपको निम्नलिखित विशेषताएं प्राप्त करने की आवश्यकता है: नाम , परमेस [adminEmail] , params [phoneNumber] , params [आदर्श वाक्य] । तदनुसार, आपको इसे पुनरावर्ती रूप से करने की आवश्यकता है, और यहां मेरा समाधान है:

मेरा फैसला

  /** *       * * @return array */ public function getAttributes() { $this->attributesRecursive($this->_config, $output); return $output; } /** *     * * @return array */ public function attributeNames() { $this->attributesRecursive($this->_config, $output); return array_keys($output); } /** *      * * @param array $config * @param array $output * @param string $name */ public function attributesRecursive($config, &$output = array(), $name = '') { foreach ($config as $key => $attribute) { if ($name == '') $paramName = $key; else $paramName = $name . "[{$key}]"; if (is_array($attribute)) $this->attributesRecursive($attribute, $output, $paramName); else $output[$paramName] = $attribute; } }

आउटपुट पर, हमें वांछित सरणी मिलती है, जो सत्यापन नियम बनाना अच्छा होगा:

  public function rules() { $rules = array(); $attributes = array_keys($this->_config); $rules[] = array(implode(', ', $attributes), 'safe'); return $rules; }

यहां सब कुछ सरल है। प्रपत्र परम की विशेषताओं के लिए [आदर्श वाक्य] को सुरक्षित माना जाता है, यह केवल मूल विशेषता को सुरक्षित बनाने के लिए पर्याप्त है।
यह समझा जाना चाहिए कि वास्तव में, आप कुछ भी लिख सकते हैं params सरणी, लेकिन कॉन्फ़िगरेशन में एक अतिरिक्त रूट विशेषता जोड़ने से काम नहीं चलेगा। यदि आप प्रश्न पूछना चाहते हैं तो मैं इस बिंदु को टिप्पणियों में समझाने की कोशिश कर सकता हूं।

अभिव्यक्ति के माध्यम से इन विशेषताओं तक सीधी पहुँच के लिए $ मॉडल -> $ विशेषता, हम __set () और __get ()) का विस्तार करते हैं:

  public function __get($name) { //      -  .   -      if (isset($this->_config[$name])) return $this->_config[$name]; else return parent::__get($name); } public function __set($name, $value) { //      -    if (isset($this->_config[$name])) $this->_config[$name] = $value; else parent::__set($name, $value); }

क्या आसान हो सकता है?

तो, मॉडल ढांचा तैयार है। अब वह जानती है कि कैसे कहना है कि उसके पास क्या विशेषताएं हैं और फॉर्म से क्या विशेषताएं हैं। इस मॉडल का परीक्षण करने के लिए, आप POST अनुरोध को संसाधित करने और फ़ॉर्म के निर्माण के लिए सामान्य क्रिया लिख सकते हैं:

  public function run() { $path = YiiBase::getPathOfAlias('application.config') . '/params.php'; $model = new ConfigForm(require($path)); if (isset($_POST['ConfigForm'])) { $model->setAttributes($_POST['ConfigForm']); if($model->save($path)) { Yii::app()->user->setFlash('success config', ' '); $this->controller->refresh(); } } $this->controller->render('config', compact('model')); }

यह क्रिया एक उदाहरण है, इसे पूरी तरह से कॉपी न करें, बस सार समझें

कुछ? क्या CFormModel के पास कोई बचत () विधि नहीं है? सच है, लेकिन हम इसे एक फाइल के परिणाम को बचाने के लिए यहां लिखेंगे। विशेषताओं के निर्माण में, यहाँ हमें पुनरावर्तन की आवश्यकता है:

फ़ाइल करने के लिए सहेजें

  public function save($path) { $config = $this->generateConfigFile(); //    ,       if(!is_writable($path)) throw new CException("Cannot write to config file!"); file_put_contents($path, $config, FILE_TEXT); return true; } public function generateConfigFile() { $this->generateConfigFileRecursive($this->_config, $output); $output = preg_replace('#,$\n#s', '', $output); //    return "<?php\nreturn " . $output . ";\n"; } public function generateConfigFileRecursive($attributes, &$output = "", $depth = 1) { $output .= "array(\n"; foreach ($attributes as $attribute => $value) { if (!is_array($value)) $output .= str_repeat("\t", $depth) . "'" . $this->escape($attribute) . "' => '" . $this->escape($value) . "',\n"; else { $output .= str_repeat("\t", $depth) . "'" . $this->escape($attribute) . "' => "; $this->generateConfigFileRecursive($value, $output, $depth + 1); } } $output .= str_repeat("\t", $depth - 1) . "),\n"; //  ,     } private function escape($value) { /** *   ,       (php-injection). *  ,   php  -  , *   ,       */ return str_replace("'", "\'", $value); }

अच्छा KeepYourMind ने टिप्पणी में सुझाव दिया कि आप php फ़ंक्शन का उपयोग कर सकते हैं var_export () उत्पन्न करने के लिए, जिसके बारे में मुझे इस बाइक ~~जनरेटर को~~ लिखने से पहले नहीं पता था

हमें एक व्यू फाइल की भी जरूरत है, जिसमें मौजूदा विशेषताओं के अनुसार ही फॉर्म जनरेट होता है।

 <?php $form = $this->beginWidget('CActiveForm', array( 'id' => 'config-form', 'enableAjaxValidation' => false, // Ajax-  Client-    , ..     'enableClientValidation' => false, )); foreach ($model->attributeNames() as $attribute) { echo CHtml::openTag('div', array('class' => 'row')); { echo $form->labelEx($model, $attribute); echo $form->textField($model, $attribute); } echo CHtml::closeTag('div'); } echo CHtml::submitButton(''); $this->endWidget();

हमारे पास विशेषताओं के लिए सुंदर कैप्शन होने के लिए, हमें उन्हें मॉडल में हार्ड-डिफाइन करना होगा।

  public function attributeLabels() { return array( 'name' => ' ', 'params[adminEmail]' => 'Email ', 'params[phoneNumber]' => ' ', 'params[motto]' => ' ', ); }

यह बदसूरत और असभ्य है, हालांकि, मुझे ऐसा करने का दूसरा सामान्य तरीका नहीं मिला। आप उन्हें एक अतिरिक्त फ़ाइल में रख सकते हैं, लेकिन यह सार को नहीं बदलेगा - वैसे भी, एक विकल्प जोड़ने के लिए आपको 2 फ़ाइलों को संपादित करना होगा।

वह मूल रूप से यह है। मैं विस्तृत टिप्पणियों के बिना पूरा मॉडल कोड देता हूं:

पूर्ण मॉडल कोड

 class ConfigForm extends CFormModel { private $_config = array(); /** *   * @param array $config    * @param string $scenario   */ public function __construct($config = array(), $scenario = '') { parent::__construct($scenario); $this->setConfig($config); } public function setConfig($config) { $this->_config = $config; } public function getConfig() { return $this->_config; } public function __get($name) { if (isset($this->_config[$name])) return $this->_config[$name]; else return parent::__get($name); } public function __set($name, $value) { if (isset($this->_config[$name])) $this->_config[$name] = $value; else parent::__set($name, $value); } public function save($path) { $config = $this->generateConfigFile(); if(!is_writable($path)) throw new CException("Cannot write to config file!"); file_put_contents($path, $config, FILE_TEXT); return true; } public function generateConfigFile() { $this->generateConfigFileRecursive($this->_config, $output); $output = preg_replace('#,$\n#s', '', $output); return "<?php\nreturn " . $output . ";\n"; } public function generateConfigFileRecursive($attributes, &$output = "", $depth = 1) { $output .= "array(\n"; foreach ($attributes as $attribute => $value) { if (!is_array($value)) $output .= str_repeat("\t", $depth) . "'" . $this->escape($attribute) . "' => '" . $this->escape($value) . "',\n"; else { $output .= str_repeat("\t", $depth) . "'" . $this->escape($attribute) . "' => "; $this->generateConfigFileRecursive($value, $output, $depth + 1); } } $output .= str_repeat("\t", $depth - 1) . "),\n"; } private function escape($value) { return str_replace("'", "\'", $value); } /** *       * * @return array */ public function getAttributes() { $this->attributesRecursive($this->_config, $output); return $output; } /** *     * * @return array */ public function attributeNames() { $this->attributesRecursive($this->_config, $output); return array_keys($output); } /** *      * * @param array $config * @param array $output * @param string $name */ public function attributesRecursive($config, &$output = array(), $name = '') { foreach ($config as $key => $attribute) { if ($name == '') $paramName = $key; else $paramName = $name . "[{$key}]"; if (is_array($attribute)) $this->attributesRecursive($attribute, $output, $paramName); else $output[$paramName] = $attribute; } } public function attributeLabels() { return array( 'name' => ' ', 'params[adminEmail]' => 'Email ', 'params[phoneNumber]' => ' ', 'params[motto]' => ' ', ); } public function rules() { $rules = array(); $attributes = array_keys($this->_config); $rules[] = array(implode(', ', $attributes), 'safe'); return $rules; } }

त्रुटियों और टाइपोस, कृपया निजी संदेशों के माध्यम से रिपोर्ट करें। मैं पहले से ही टाइपोस के लिए माफी माँगता हूँ - एक लंबे समय के लिए मैंने ऐसे संस्करणों में कोड के अलावा कुछ भी नहीं लिखा

Yii के लिए सरल कॉन्फ़िगरेशन फ़ाइल संपादक

विचार

कार्यान्वयन

आदर्श

More articles: