MODx क्रांति के लिए ऐड-ऑन विकास। भाग 1

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

सिंहावलोकन

यह पाठ एक साधारण डूडल ऐड-ऑन विकसित करने के बारे में बात करेगा, जो एक कस्टम डेटाबेस टेबल का उपयोग करता है ताकि डूडल नामक वस्तुओं को स्टोर किया जा सके जिसमें एक नाम और विवरण हो। हम एक स्निपेट बनाएंगे, जो चंक के माध्यम से टेम्पलेट के अनुसार तैयार की गई एक सूची प्रदर्शित करेगा, एक्सटर्ज़ (भाग 2) का उपयोग करके हमारा प्रशासन पृष्ठ (घटक), और पैकेज (पैकेज) में पैकेजिंग के लिए एक स्क्रिप्ट भी बनाएगा - भाग 3। इसके अलावा, यह सभी i18n- होगा संगत यानी विभिन्न भाषाओं में अनुवाद के लिए फाइलें हैं। वैसे, इस पैकेज को डाउनलोड और अच्छी तरह से अध्ययन किया जा सकता है।

एक निर्देशिका संरचना बनाना

इसलिए, मैंने अपने स्थानीय सर्वर पर फ़ोल्डर / www / डूडल / बनाया। यह फ़ोल्डर मुझे http: // localhost / doodles / के पते पर उपलब्ध है। हमारी निर्देशिका संरचना इस तरह दिखती है:
कुछ बातों पर ध्यान दें। सबसे पहले, हमारे पास 3 मुख्य निर्देशिकाएं हैं: कोर / , संपत्ति / और _build / । आमतौर पर, MODx Revo ऐड-ऑन को दो निर्देशिकाओं में विभाजित किया जाता है: कोर / घटक / myextra / और संपत्ति / घटक / myextra / । संपत्ति / घटकों / निर्देशिका में केवल वेब-विशिष्ट फाइलें हैं - जावास्क्रिप्ट, सीएसएस, आदि। ये ऐसी फाइलें हैं जो इंटरनेट पर सार्वजनिक रूप से उपलब्ध हैं। सभी PHP फाइलें कोर / घटकों / निर्देशिका में स्थित होंगी। कोर / डायरेक्टरी को अतिरिक्त सुरक्षा के लिए साइट (वेबरोट) के रूट डायरेक्टरी से बाहर ले जाया जा सकता है। इन कैटलॉग को साइट के प्रशासनिक भाग के "पैकेज प्रबंधन" अनुभाग से त्वरित स्थापना के लिए हमारे घटक के परिवहन पैकेज में पैक किया जाएगा। _Build / निर्देशिका को परिवहन पैकेज में पैक नहीं किया जाएगा। इस पैकेज को बनाने के चरण में ही इसकी जरूरत है। पाठ के अंतिम भाग में इस पर चर्चा की जाएगी।

परिसंपत्तियों / फ़ोल्डर में हमारे पास केवल एक PHP फ़ाइल होगी - कनेक्टर । एफपी । यह फ़ाइल हमें हमारे कस्टम प्रबंधक पृष्ठ (CMP) के प्रोसेसर तक पहुँचने की अनुमति देगी। उस पर और बाद में।

निर्देशिका कोर / घटकों / डूडल / में कई निर्देशिकाएँ बनाएँ:
नियंत्रक - सीएमपी के लिए नियंत्रक;
डॉक्स - इसमें केवल चैंज, रीडमी और लाइसेंस फाइलें शामिल हैं;
तत्व - हमारे सभी स्निपेट्स, प्लगइन्स, चंक्स आदि;
लेक्सिकॉन - सभी i18n भाषा की फाइलें;
मॉडल - हमारी कक्षाएं, साथ ही हमारे कस्टम डेटाबेस तालिकाओं के लिए XML स्कीमा फ़ाइल;
प्रोसेसर - CMP के लिए हमारे सभी प्रोसेसर।

स्निपेट निर्माण

स्निपेट फ़ाइल बनाएं: /www/doodles/core/compenders/doodles/elements/snippets/snippet.doodles.php । फ़ाइल में कोड की कुछ पंक्तियाँ जोड़ें:

$doodles = $modx->getService('doodles','Doodles',$modx->getOption('doodles.core_path',null,$modx->getOption('core_path').'components/doodles/').'model/doodles/',$scriptProperties); if (!($doodles instanceof Doodles)) return ''; 

आउच! यह क्या है यहीं पर जादू होता है। आइए प्रत्येक भाग का विश्लेषण करें। सबसे पहले, हमारे पास getService () विधि के लिए एक कॉल है। आसान पढ़ने के लिए हम इस लाइन को कई भागों में तोड़ेंगे:

 $defaultDoodlesCorePath = $modx->getOption('core_path').'components/doodles/'; $doodlesCorePath = $modx->getOption('doodles.core_path',null,$defaultDoodlesCorePath); $doodles = $modx->getService('doodles','Doodles',$doodlesCorePath.'model/doodles/',$scriptProperties); 

ठीक है, $ modx क्या है-> getOption () ? इस पद्धति का उपयोग करके, आप हमारी सिस्टम सेटिंग्स का पता लगा सकते हैं। $ modx-> getService () एक वर्ग को लोड करता है, अगर कोई वस्तु मौजूद है, तो वह मौजूद है, और इसे $ modx-> डूडल में सेट करता है, इस मामले में (पहला पैरामीटर विधि में पास हुआ)। अधिक जानकारी यहाँ ।

पथ सेटिंग बनाएँ

नियंत्रण प्रणाली में, "सिस्टम" -> "सिस्टम सेटिंग्स" पर जाएं। संबंधित मानों के साथ दो नए पैरामीटर बनाएँ:
doodles.core_path - {core_path} घटक / डूडल /
doodles.assets_url - {संपत्ति_पथ} घटक / डूडल /

बेस क्लास बनाना

एक क्लास फ़ाइल /www/doodles/core/compenders/doodles/model/doodles/doodles.class.php बनाएं। यह वर्ग हमारे लिए उपयोगी होगा, इसमें हम कुछ बुनियादी तरीकों को परिभाषित कर सकते हैं, साथ ही उन तरीकों को भी इस्तेमाल करेंगे जिन्हें हम अपने घटक में उपयोग करेंगे।

 <?php class Doodles { public $modx; public $config = array(); function __construct(modX &$modx,array $config = array()) { $this->modx =& $modx; $basePath = $this->modx->getOption('doodles.core_path',$config,$this->modx->getOption('core_path').'components/doodles/'); $assetsUrl = $this->modx->getOption('doodles.assets_url',$config,$this->modx->getOption('assets_url').'components/doodles/'); $this->config = array_merge(array( 'basePath' => $basePath, 'corePath' => $basePath, 'modelPath' => $basePath.'model/', 'processorsPath' => $basePath.'processors/', 'chunksPath' => $basePath.'elements/chunks/', 'jsUrl' => $assetsUrl.'js/', 'cssUrl' => $assetsUrl.'css/', 'assetsUrl' => $assetsUrl, 'connectorUrl' => $assetsUrl.'connector.php', ),$config); } } 

अब वापस हमारे स्निपेट पर जाएं। कुछ गुण जोड़ें:

 $dood = $modx->getService('doodles','Doodles',$modx->getOption('doodles.core_path',null,$modx->getOption('core_path').'components/doodles/').'model/doodles/',$scriptProperties); if (!($dood instanceof Doodles)) return ''; /* setup default properties */ $tpl = $modx->getOption('tpl',$scriptProperties,'rowTpl'); $sort = $modx->getOption('sort',$scriptProperties,'name'); $dir = $modx->getOption('dir',$scriptProperties,'ASC'); $output = ''; return $output; 

कूल। अब हम अपने रिकॉर्ड्स को कैप्चर करने के लिए डेटाबेस प्रश्नों के लिए xPDO का उपयोग करना चाहते हैं ... ओह। हमने अभी तक उनके लिए xPDO मॉडल नहीं किया है। हमें करना है।

मॉडल निर्माण

XPDO डेटाबेस को अच्छा OOP क्वेरी विधियों में अमूर्त बनाता है। वह वर्तमान में कई डेटाबेस का समर्थन करना शुरू कर रहा है। इसके अलावा, यह आपको अपने डेटाबेस स्ट्रिंग्स को अच्छी, साफ कक्षाओं में बदलने और कोड के सभी बहुत कम लाइनों को बनाने की अनुमति देता है। लेकिन पहले, हमें xPDO योजनाओं का उपयोग करके इस मॉडल का निर्माण करना चाहिए।

एक XML फ़ाइल /www/doodles/core/compenders/doodles/model/schema/doodles.mysql.schema.xml बनाएँ। इसे इसमें डालें:

 <?xml version="1.0" encoding="UTF-8"?> <model package="doodles" baseClass="xPDOObject" platform="mysql" defaultEngine="MyISAM"> <object class="Doodle" table="doodles" extends="xPDOSimpleObject"> <field key="name" dbtype="varchar" precision="255" phptype="string" null="false" default=""/> <field key="description" dbtype="text" phptype="string" null="false" default=""/> <field key="createdon" dbtype="datetime" phptype="datetime" null="true"/> <field key="createdby" dbtype="int" precision="10" attributes="unsigned" phptype="integer" null="false" default="0" /> <field key="editedon" dbtype="datetime" phptype="datetime" null="true"/> <field key="editedby" dbtype="int" precision="10" attributes="unsigned" phptype="integer" null="false" default="0" /> <aggregate alias="CreatedBy" class="modUser" local="createdby" foreign="id" cardinality="one" owner="foreign"/> <aggregate alias="EditedBy" class="modUser" local="editedby" foreign="id" cardinality="one" owner="foreign"/> </object> </model> 

आइए जानें कि यह सब क्या है। पहली पंक्ति:

 <model package="doodles" baseClass="xPDOObject" platform="mysql" defaultEngine="MyISAM"> 

हमारे पैकेज का नाम है - "डूडल"। वह यह भी कहती है कि हमारा आधार वर्ग "xPDOObject" होगा, और यह सर्किट MySQL के लिए बनाया गया है। वह यह भी कहती है कि MyISAM हमारा डिफ़ॉल्ट MySQL स्टोरेज सिस्टम होगा। इसके बाद, डेटाबेस तालिका के गुण सेट करें। एक पहचानकर्ता के साथ एक क्षेत्र बनाने की आवश्यकता नहीं है, जैसा कि xPDOSimpleObject हमेशा इसे बनाता है और ऑटो-इंक्रीमेंट सेट करता है।

 <aggregate alias="CreatedBy" class="modUser" local="createdby" foreign="id" cardinality="one" owner="foreign"/> <aggregate alias="EditedBy" class="modUser" local="editedby" foreign="id" cardinality="one" owner="foreign"/> 

यह अन्य xPDO ऑब्जेक्ट्स (इस मामले में, उपयोगकर्ता ऑब्जेक्ट) के लिए एक कनेक्शन बनाता है।

स्कीमा पार्सिंग स्क्रिप्ट

अब हमारे _build / निर्देशिका पर ध्यान देने का समय है। निम्नलिखित सामग्री के साथ फ़ाइल /www/doodles/_build/build.config.php बनाएँ:

 <?php define('MODX_BASE_PATH', '../'); define('MODX_CORE_PATH', MODX_BASE_PATH . 'core/'); define('MODX_MANAGER_PATH', MODX_BASE_PATH . 'manager/'); define('MODX_CONNECTORS_PATH', MODX_BASE_PATH . 'connectors/'); define('MODX_ASSETS_PATH', MODX_BASE_PATH . 'assets/'); define('MODX_BASE_URL','/modx/'); define('MODX_CORE_URL', MODX_BASE_URL . 'core/'); define('MODX_MANAGER_URL', MODX_BASE_URL . 'manager/'); define('MODX_CONNECTORS_URL', MODX_BASE_URL . 'connectors/'); define('MODX_ASSETS_URL', MODX_BASE_URL . 'assets/'); 

जांचें कि आपके मामले के लिए सभी रास्ते सही हैं। अब हम स्वयं स्क्रिप्ट बनाएंगे, जो हमारी XML- स्कीम का विश्लेषण करेगी और इसका PHP-प्रतिनिधित्व करेगी। फ़ाइल बनाएँ / / http : //doodles/_build/build.schema.php :

 <?php require_once dirname(__FILE__).'/build.config.php'; include_once MODX_CORE_PATH . 'model/modx/modx.class.php'; $modx= new modX(); $modx->initialize('mgr'); $modx->loadClass('transport.modPackageBuilder','',false, true); echo '<pre>'; /* used for nice formatting of log messages */ $modx->setLogLevel(modX::LOG_LEVEL_INFO); $modx->setLogTarget('ECHO'); $root = dirname(dirname(__FILE__)).'/'; $sources = array( 'model' => $root.'core/components/doodles/model/', 'schema_file' => $root.'core/components/doodles/model/schema/doodles.mysql.schema.xml', ); $manager= $modx->getManager(); $generator= $manager->getGenerator(); if (!is_dir($sources['model'])) { $modx->log(modX::LOG_LEVEL_ERROR,'Model directory not found!'); die(); } if (!file_exists($sources['schema_file'])) { $modx->log(modX::LOG_LEVEL_ERROR,'Schema file not found!'); die(); } $generator->parseSchema($sources['schema_file'],$sources['model']); echo '.'; exit(); 

अब आप _build / build.schema.php फ़ाइल चला सकते हैं। मैं एक वेब ब्राउज़र में डाउनलोड करके ऐसा करता हूं: http: //localhost/doodles/_build/build.schema.php । उसके बाद, क्लास फाइल्स और मैप्स जेनरेट किए जाएंगे।


अब अपने बेस डूडल क्लास (/www/doodles/core/compenders/doodles/model/doodles/doodles.class.php) पर एक छोटा सा समायोजन करें। Array_merge के तुरंत बाद निम्न लाइन को क्लास कंस्ट्रक्टर में जोड़ें:

 $this->modx->addPackage('doodles',$this->config['modelPath']); 

यह xPDO को बताता है कि हम "डूडल" xPDO पैकेज जोड़ना चाहते हैं, जो हमें हमारे उपयोगकर्ता तालिका को क्वेरी करने की अनुमति देगा।

स्निपेट शामिल करें

पहले हमने एक स्निपेट बनाया। इसका उपयोग करने के लिए, अब आप नियंत्रण प्रणाली में एक स्निपेट बना सकते हैं और कोड को डूडल / एलिमेंट्स / स्निपेट / स्निपेट.डूडल्स . php फ़ाइल से चिपका सकते हैं। लेकिन ऐसे स्निपेट के कोड को संपादित करना सुविधाजनक नहीं हो सकता है। इसे ठीक करने के लिए, आप एक साधारण सार्वभौमिक बना सकते हैं जिसमें स्निपेट शामिल है। चलो नियंत्रण प्रणाली "तत्व" -> "स्निपेट्स" -> "न्यू स्निपेट" पर जाएं।

स्निपेट नाम:
शामिल

स्निपेट कोड (php):

 <?php return include $file; 

अब किसी भी पेज पर या किसी भी टेम्पलेट में आप इस तरह से एक स्निपेट कॉल कर सकते हैं:

 [[!include? &file=`[[++doodles.core_path]]elements/snippets/snippet.doodles.php`]] 

डेटाबेस क्वेरी बनाना

सबसे पहले, हमें एक तालिका बनाने की आवश्यकता है। ऐसा करने के लिए, मान वापस करने से पहले हमारे स्निपेट में ऐसी लाइनें जोड़ें (वापसी):

 $m = $modx->getManager(); $created = $m->createObjectContainer('Doodle'); return $created ? ' .' : '  .'; 

अब, यदि आप हमारा स्निपेट चलाते हैं, तो डेटाबेस में डूडल घटक तालिका अपने आप बन जाएगी। उसके बाद, आप इस कोड को हटा सकते हैं, या यों कहें कि:

 $tablexists = $modx->query("SELECT COUNT(*) FROM information_schema.tables WHERE table_schema = '".$modx->getOption('dbname')."' AND table_name = '".$modx->getOption('table_prefix')."doodles'"); if(!$tablexists->fetch(PDO::FETCH_COLUMN)){ $m = $modx->getManager(); $created = $m->createObjectContainer('Doodle'); } 

अब स्निपेट में निम्नलिखित पंक्तियाँ जोड़ें:

 $doodles = $modx->getCollection('Doodle'); $output = count($doodles); 

आउटपुट पर आपको "0" देखना चाहिए, क्योंकि तालिका अभी भी खाली है।

तालिका में कुछ पंक्तियों को बनाएं (उदाहरण के लिए phpMyAdmin का उपयोग करके) और आप देखेंगे कि कैसे स्निपेट उनकी संख्या प्रदर्शित करता है। आप इस तरह से एक तालिका में पंक्तियाँ भी बना सकते हैं:

 $doodle = $modx->newObject('Doodle'); $doodle->fromArray(array( 'name' => 'TestDoodle', 'description' => 'A test doodle' )); $doodle->save(); 

इस कोड को हटाना याद रखें।

बहुत बढ़िया! कस्टम डेटाबेस क्वेरी काम करता है! इसे और जटिल बनाते हैं। हम कुछ बहुत ही जटिल प्रश्नों को बनाने के लिए xPDOQuery xPDO का उपयोग कर सकते हैं। अब केवल क्रमबद्ध कमांड जोड़ते हैं:

 $c = $modx->newQuery('Doodle'); $c->sortby($sort,$dir); $doodles = $modx->getCollection('Doodle',$c); 

$ Dir के क्रम में $ सॉर्ट फ़ील्ड पर सॉर्टिंग होती है। इन चरों का मान ऊपर दिया गया है। स्निपेट कॉल में, यह इस तरह दिखेगा:

 [[!include? &file=`[[++doodles.core_path]]elements/snippets/snippet.doodles.php`&sort=`name`&dir=`DESC`]] 

डूडल वर्ग की GetChunk विधि

आधार वर्ग में सहायक विधियों के एक जोड़े को जोड़ें:

 public function getChunk($name,$properties = array()) { $chunk = null; if (!isset($this->chunks[$name])) { $chunk = $this->_getTplChunk($name); if (empty($chunk)) { $chunk = $this->modx->getObject('modChunk',array('name' => $name)); if ($chunk == false) return false; } $this->chunks[$name] = $chunk->getContent(); } else { $o = $this->chunks[$name]; $chunk = $this->modx->newObject('modChunk'); $chunk->setContent($o); } $chunk->setCacheable(false); return $chunk->process($properties); } private function _getTplChunk($name,$postfix = '.chunk.tpl') { $chunk = false; $f = $this->config['chunksPath'].strtolower($name).$postfix; if (file_exists($f)) { $o = file_get_contents($f); $chunk = $this->modx->newObject('modChunk'); $chunk->set('name',$name); $chunk->setContent($o); } return $chunk; } 

अभी के लिए, आपको बस यह जानने की जरूरत है कि ये विधियां आपकी निर्देशिका / www / डूडल / कोर / घटकों / डूडल / तत्वों / विखंडू / में विखंडन के लिए दिखेंगी ।

लगभग निम्नलिखित सामग्री के साथ एक chunk फ़ाइल /www/doodles/core/compenders/doodles/elements/chunks/rowtpl.chunk.tpl बनाएँ:

 <li><strong>[[+name]]</strong> - [[+description]]</li> 

निम्नलिखित रेखाओं को हमारे स्निपेट में जोड़ें:

 foreach ($doodles as $doodle) { $doodleArray = $doodle->toArray(); $output .= $dood->getChunk($tpl,$doodleArray); } 

पूर्ण स्निपेट कोड निम्नानुसार है:

 <?php $dood = $modx->getService('doodles','Doodles',$modx->getOption('doodles.core_path',null,$modx->getOption('core_path').'components/doodles/').'model/doodles/',$scriptProperties); if (!($dood instanceof Doodles)) return ''; /* setup default properties */ $tpl = $modx->getOption('tpl',$scriptProperties,'rowTpl'); $sort = $modx->getOption('sort',$scriptProperties,'name'); $dir = $modx->getOption('dir',$scriptProperties,'ASC'); $output = ''; $tablexists = $modx->query("SELECT COUNT(*) FROM information_schema.tables WHERE table_schema = '".$modx->getOption('dbname')."' AND table_name = '".$modx->getOption('table_prefix')."doodles'"); if(!$tablexists->fetch(PDO::FETCH_COLUMN)){ $m = $modx->getManager(); $created = $m->createObjectContainer('Doodle'); } $c = $modx->newQuery('Doodle'); $c->sortby($sort,$dir); $doodles = $modx->getCollection('Doodle',$c); foreach ($doodles as $doodle) { $doodleArray = $doodle->toArray(); $output .= $dood->getChunk($tpl,$doodleArray); } return $output; 

आउटपुट पर, हम टेबल से अपने परीक्षण डेटा की एक सूची देखेंगे:


इसलिए, हमने सिस्टम सेटिंग्स में बनाए गए रास्तों के साथ बेस क्लास को लोड किया, उपयोगकर्ता डेटाबेस तालिका से xPDO पैकेज प्राप्त किया और इसे चंक का उपयोग करके टेम्पलेट का उपयोग करके प्रदर्शित किया।

इस ट्यूटोरियल का अगला भाग एक प्रशासनिक पृष्ठ (घटक) बनाने की बात करता है। इसके बारे में हाल ही में एक bebrumkin काफी अच्छी तरह से बताया है । तीसरे भाग में , मेरी राय में किसी ने अभी तक नहीं लिखा है, शायद मैं जल्द ही अनुवाद करूंगा। यह एक पैकेज में पूरे घटक की पैकेजिंग के बारे में बताता है, जिसे प्रबंधन प्रणाली में "पैकेज प्रबंधन" अनुभाग के माध्यम से आसानी से स्थापित किया जा सकता है।