🧜🏻 ♟️ 🔘 MODX स्थापित किए बिना एक परिवहन पैकेज का निर्माण 🧚🏿 🏛️ 🚣

MODX के लिए अपने पैकेज लिखना शुरुआती के लिए आसान नहीं है, और एक अनुभवी डेवलपर के पास कभी-कभी एक मीठा समय होता है। लेकिन शुरुआत करने वाला डर जाता है, और अनुभवी समझ जाता है :)।

यह पोस्ट इस बारे में बात करता है कि आप MODX के लिए एक घटक पैकेज कैसे लिख और बना सकते हैं, बिना MODX को स्थापित और कॉन्फ़िगर किए बिना। स्तर औसत से ऊपर है, इसलिए आपको कुछ मामलों में अपने दिमाग को रैक करना पड़ सकता है, लेकिन यह इसके लायक है।

मैं बिल्ली के नीचे विवरण मांगता हूं।

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

कॉपी-पेस्ट बुराई है, हालांकि हमेशा नहीं

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

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

लेकिन कार्य पैकेज की असेंबली को स्वचालित करना है, अधिमानतः सर्वर पर, हमेशा आवश्यक सॉफ़्टवेयर के न्यूनतम सेट के साथ, न्यूनतम संसाधनों के साथ और इसलिए अधिक गति के साथ। कार्य निर्धारित किया गया था और स्रोत का अध्ययन करने के बाद, चैट में जेसन ब्रेकिंग ने एक समाधान पाया।

और कौन सा?

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

public function __construct( $dsn, $username = '', $password = '', $options = [], $driverOptions= null );

जेसन से पूछताछ करने के बाद, यह स्पष्ट हो गया कि हालांकि मापदंडों को सेट करने की आवश्यकता है, डेटाबेस के लिए वास्तविक शारीरिक संबंध ठीक उसी समय होता है जब यह आवश्यक होता है। आलसी अपनी सारी महिमा में लोड। दूसरी समस्या का समाधान हो गया है।

तीसरा मुद्दा xPDO को प्रोजेक्ट से जोड़ने का मुद्दा था। संगीतकार तुरंत दिमाग में आ गया, लेकिन 2.x संस्करण जिस पर वर्तमान MODX चल रहा है, संगीतकार का समर्थन नहीं करता है, और 3.x शाखा नामस्थानों का उपयोग करती है और वर्ग नाम 2.x की तुलना में अलग-अलग लिखे जाते हैं, जिससे टकराव और त्रुटियां होती हैं। सामान्य तौर पर, असंगत। तब मुझे गिट टूल्स का इस्तेमाल करना था और एक्सपीडीओ को एक सबमॉड्यूल के रूप में जोड़ना था।

सबमॉड्यूल का उपयोग कैसे करें

सबसे पहले, उन पर प्रलेखन पढ़ें।

फिर, यदि यह एक नई परियोजना है, तो आपको एक सबमॉड्यूल जोड़ने की आवश्यकता है:
 $ git submodule add https://github.com/username/reponame 
यह कमांड क्लोन करेगा और आपके प्रोजेक्ट में सबमॉड्यूल स्थापित करेगा। फिर आपको git एड कमांड के साथ अपने रिपॉजिटरी में सबमॉड्यूल फोल्डर को जोड़ना होगा। यह पूरे फ़ोल्डर को सबमॉड्यूल के साथ नहीं जोड़ेगा, लेकिन सबमॉडल से अंतिम प्रतिबद्ध के लिए केवल एक लिंक जोड़ देगा।

ताकि एक और डेवलपर सभी आश्रितों के साथ प्रोजेक्ट को क्लोन कर सके, आपको सबमॉडल्स के लिए एक .gitmodules कॉन्फ़िगरेशन बनाने की आवश्यकता है। Slackify प्रोजेक्ट में, यह इस प्रकार है:
 [submodule "_build/xpdo"] path = _build/xpdo url = https://github.com/modxcms/xpdo.git branch = 2.x 
उसके बाद, जब क्लोनिंग, बस पुनरावर्ती ध्वज निर्दिष्ट करें और गिट सभी निर्भर रिपॉजिटरी डाउनलोड करेगा।

नतीजतन, हमारे पास एक्सपीडीओ है, एक्सपीडीओ को डेटाबेस से जुड़े बिना उपयोग किया जा सकता है, यदि यह आवश्यक नहीं है, तो एक्सपीडीओ को बाहरी निर्भरता (गिट सबमॉड्यूल) के रूप में घटक कोड से जोड़ा जा सकता है। अब बिल्ड स्क्रिप्ट का कार्यान्वयन।

आइए समझते हैं

मैं हाल ही में मेरे द्वारा पोस्ट किए गए Slackify ऐड- ऑन की बिल्ड स्क्रिप्ट का वर्णन करूंगा । यह घटक GitHub पर मुफ्त और सार्वजनिक रूप से उपलब्ध है, जो स्व-अध्ययन की सुविधा प्रदान करेगा।

XPDO कनेक्ट करें

हम पैकेज नाम और अन्य आवश्यक कॉल के साथ स्थिरांक के कार्य को छोड़ देते हैं और xPDO कनेक्ट करते हैं।

 require_once 'xpdo/xpdo/xpdo.class.php'; require_once 'xpdo/xpdo/transport/xpdotransport.class.php'; $xpdo = xPDO::getInstance('db', [ xPDO::OPT_CACHE_PATH => __DIR__ . '/../cache/', xPDO::OPT_HYDRATE_FIELDS => true, xPDO::OPT_HYDRATE_RELATED_OBJECTS => true, xPDO::OPT_HYDRATE_ADHOC_FIELDS => true, xPDO::OPT_CONNECTIONS => [ [ 'dsn' => 'mysql:host=localhost;dbname=xpdotest;charset=utf8', 'username' => 'test', 'password' => 'test', 'options' => [xPDO::OPT_CONN_MUTABLE => true], 'driverOptions' => [], ] ] ]);

मैंने xPDO सबमॉड्यूल को _build फ़ोल्डर में जोड़ा, जिसे हमें केवल पैकेज के विकास और संयोजन के चरण में चाहिए और जो घटक के मुख्य संग्रह में नहीं आएगा। लाइव MODX के साथ साइट पर xPDO की दूसरी प्रति जिसकी हमें आवश्यकता नहीं है।

XPDO कनेक्शन सेटिंग्स में, मैं डेटाबेस का नाम dsn में सेट करता हूं, लेकिन यह कोई भूमिका नहीं निभाता है। यह महत्वपूर्ण है कि xPDO के अंदर कैश फोल्डर लिखने योग्य हो। यह है कि, xPDO आरंभिक है।

कक्षाओं के साथ एक मुश्किल हैक करना

पैकेज बनाते समय स्थापित MODX का उपयोग करते समय, सब कुछ सरल है, हम उस वर्ग का एक ऑब्जेक्ट लेते हैं और बनाते हैं जिसकी हमें आवश्यकता होती है। MODX वास्तव में आवश्यक वर्ग को ढूँढता है, इस वर्ग के लिए आवश्यक कार्यान्वयन (_mysql पोस्टफ़िक्स के साथ वर्ग) को ढूँढता है, जो डेटाबेस पर निर्भर करता है और फिर वांछित वस्तु बनाता है (इस विशेषता के कारण, आपको क्लास बनाते समय त्रुटियाँ मिल सकती हैं कि कक्षा _mysql नहीं मिला, यह डरावना नहीं है)। हालाँकि, हमारे पास न तो आधार है और न ही कार्यान्वयन। हमें किसी तरह वांछित वर्ग को बदलने की आवश्यकता है, जो हम कर रहे हैं।

 class modNamespace extends xPDOObject {} class modSystemSetting extends xPDOObject {}

हम एक डमी क्लास (स्टब) बनाते हैं, जिसे वांछित ऑब्जेक्ट बनाने के लिए आवश्यक है। यह नहीं करना होगा यदि xPDO ने विशेष रूप से यह नहीं जांचा कि वस्तु किस वर्ग की है। लेकिन वह जाँच करता है।

लेकिन ऐसे विशेष मामले हैं जब आपको केवल एक वर्ग को परिभाषित करने की तुलना में थोड़ा अधिक करने की आवश्यकता होती है। ये वर्गों के बीच निर्भरता के मामले हैं। उदाहरण के लिए, हमें श्रेणी में एक प्लगइन जोड़ने की आवश्यकता है। कोड में, बस $category->addOne($plugin); लेकिन हमारे मामले में यह काम नहीं करेगा।

यदि आपने कभी MODX डेटाबेस स्कीमा में देखा, तो आपने संभवतः एग्रीगेट और कम्पोजिट जैसे तत्वों को देखा था। यह उनके बारे में दस्तावेज में लिखा गया है , लेकिन अगर एक सरल तरीके से, वे कक्षाओं के बीच संबंध का वर्णन करते हैं।

हमारे मामले में, एक श्रेणी में कई प्लगइन्स हो सकते हैं, जिसके लिए कुल तत्व modCategory वर्ग के लिए जिम्मेदार है। इसलिए, चूंकि हमारे पास एक ठोस कार्यान्वयन के बिना एक वर्ग है, इसलिए हमें हाथ से इस कनेक्शन को इंगित करने की आवश्यकता है। getFKDefinition विधि को ओवरराइड करके ऐसा करना आसान है:

 class modCategory extends xPDOObject { public function getFKDefinition($alias) { $aggregates = [ 'Plugins' => [ 'class' => 'modPlugin', 'local' => 'id', 'foreign' => 'category', 'cardinality' => 'many', 'owner' => 'local', ] ]; return isset($aggregates[$alias]) ? $aggregates[$alias] : []; } }

हमारे घटक में, केवल प्लगइन्स का उपयोग किया जाता है, इसलिए हम केवल उनके लिए लिंक जोड़ते हैं। उसके बाद, modCategory वर्ग की addMany विधि आसानी से श्रेणी में आवश्यक प्लगइन्स जोड़ सकती है, और फिर पैकेज में।

एक पैकेज बनाएं

 $package = new xPDOTransport($xpdo, $signature, $directory);

जैसा कि आप देख सकते हैं, सब कुछ बहुत सरल है। यहां हमें पैरामीटर $xpdo पास करने की आवश्यकता थी, जिसे हमने शुरुआत में ही शुरू कर दिया था। यदि इस क्षण के लिए नहीं, तो कोई समस्या नहीं होगी 2। $signature - पैकेज का नाम, संस्करण सहित, $directory - वह स्थान जहाँ पैकेज सावधानीपूर्वक रखा जाएगा। ये चर कहाँ से आते हैं, स्रोत में अपने लिए देखें।

एक नाम स्थान बनाएँ और इसे पैकेज में जोड़ें

हमें लेक्सिकॉन और सिस्टम सेटिंग्स को बांधने के लिए एक नामस्थान की आवश्यकता है। हमारे मामले में, बस इसके लिए, दूसरों को अभी तक नहीं माना जाता है।

 $namespace = new modNamespace($xpdo); $namespace->fromArray([ 'id' => PKG_NAME_LOWER, 'name' => PKG_NAME_LOWER, 'path' => '{core_path}components/' . PKG_NAME_LOWER . '/', ]); $package->put($namespace, [ xPDOTransport::UNIQUE_KEY => 'name', xPDOTransport::PRESERVE_KEYS => true, xPDOTransport::UPDATE_OBJECT => true, xPDOTransport::RESOLVE_FILES => true, xPDOTransport::RESOLVE_PHP => true, xPDOTransport::NATIVE_KEY => PKG_NAME_LOWER, 'namespace' => PKG_NAME_LOWER, 'package' => 'modx', 'resolve' => null, 'validate' => null ]);

पहला भाग किसी के लिए भी स्पष्ट है जिसने कभी भी MODX के लिए कोड लिखा है। पैकेज के अतिरिक्त के साथ दूसरा, थोड़ा अधिक जटिल है। put विधि में 2 पैरामीटर होते हैं: ऑब्जेक्ट स्वयं और मापदंडों का एक सरणी जो पैकेज को स्थापित करने के समय इस ऑब्जेक्ट और इसके संभावित व्यवहार का वर्णन करता है। उदाहरण के लिए, xPDOTransport::UNIQUE_KEY => 'name' अर्थ है कि नाम स्थान के लिए, name के name साथ ही नाम फ़ील्ड के रूप में मान को डेटाबेस में एक अद्वितीय कुंजी के रूप में उपयोग किया जाएगा। आप xPDO प्रलेखन में मापदंडों के बारे में अधिक पढ़ सकते हैं, और स्रोत कोड का अध्ययन करके बेहतर कर सकते हैं।

उसी तरह, आप अन्य ऑब्जेक्ट्स को जोड़ सकते हैं, जैसे सिस्टम सेटिंग्स।

 $package->put($setting, [ xPDOTransport::UNIQUE_KEY => 'key', xPDOTransport::PRESERVE_KEYS => true, xPDOTransport::UPDATE_OBJECT => true, 'class' => 'modSystemSetting', 'resolve' => null, 'validate' => null, 'package' => 'modx', ]);

एक श्रेणी बनाएँ

एक श्रेणी को जोड़ने के साथ, मेरे पास सबसे बड़ा गग था जब मैंने यह सब पता लगाया। तत्वों को एक्सपीडीओ मॉडल में एक श्रेणी में रखा गया है, दोनों को इस श्रेणी से संबंधित होना चाहिए, अर्थात इसमें नेस्टेड होना चाहिए, और उसके बाद ही श्रेणी को पैकेज में नेस्टेड किया जाना चाहिए। और उसी समय, आपको कक्षाओं के बीच संबंधों को ध्यान में रखने की आवश्यकता है, जो मैंने पहले ही ऊपर वर्णित किया है। इसे समझने, महसूस करने और इसे सही ढंग से लागू करने में काफी लंबा समय लगा।

 $package->put($category, [ xPDOTransport::UNIQUE_KEY => 'category', xPDOTransport::PRESERVE_KEYS => false, xPDOTransport::UPDATE_OBJECT => true, xPDOTransport::ABORT_INSTALL_ON_VEHICLE_FAIL => true, xPDOTransport::RELATED_OBJECTS => true, xPDOTransport::RELATED_OBJECT_ATTRIBUTES => [ 'Plugins' => [ xPDOTransport::UNIQUE_KEY => 'name', xPDOTransport::PRESERVE_KEYS => false, xPDOTransport::UPDATE_OBJECT => false, xPDOTransport::RELATED_OBJECTS => true ], 'PluginEvents' => [ xPDOTransport::UNIQUE_KEY => ['pluginid', 'event'], xPDOTransport::PRESERVE_KEYS => true, xPDOTransport::UPDATE_OBJECT => false, xPDOTransport::RELATED_OBJECTS => true ] ], xPDOTransport::NATIVE_KEY => true, 'package' => 'modx', 'validate' => $validators, 'resolve' => $resolvers ]);

यह राक्षसी दिखता है, लेकिन ऐसा नहीं देखा गया। एक महत्वपूर्ण पैरामीटर xPDOTransport::RELATED_OBJECTS => true , जो इंगित करता है कि श्रेणी में नेस्टेड तत्व हैं जिन्हें पैक करने और फिर स्थापित करने की आवश्यकता है।

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

Validators स्थापना से पहले किया जाता है, रिज़ॉल्वर - बाद

मैं लगभग भूल गया, श्रेणी को पैक करने से पहले, हमें अपने तत्वों को इसमें जोड़ना होगा। इस तरह:

 $plugins = include $sources['data'] . 'transport.plugins.php'; if (is_array($plugins)) { $category->addMany($plugins, 'Plugins'); }

पैकेज में अन्य डेटा जोड़ें।

पैकेज में आपको लाइसेंस के साथ एक और फ़ाइल, एक परिवर्तन लॉग के साथ एक फ़ाइल और घटक के विवरण के साथ एक फ़ाइल जोड़ने की आवश्यकता है। यदि आवश्यक हो, तो आप setup-options विशेषता के माध्यम से एक और विशेष स्क्रिप्ट जोड़ सकते हैं, जो पैकेज स्थापित करने से पहले विंडो दिखाएगा। यह तब है जब बटन "इंस्टॉलेशन विकल्प" को "इंस्टॉल करें" के बजाय। और MODX 2.4 के संस्करण से यह requires विशेषता का उपयोग करके संकुल के बीच निर्भरता निर्दिष्ट करना संभव हो गया, और इसमें आप PHP और MODX के संस्करण को भी निर्दिष्ट कर सकते हैं।

 $package->setAttribute('changelog', file_get_contents($sources['docs'] . 'changelog.txt')); $package->setAttribute('license', file_get_contents($sources['docs'] . 'license.txt')); $package->setAttribute('readme', file_get_contents($sources['docs'] . 'readme.txt')); $package->setAttribute('requires', ['php' => '>=5.4']); $package->setAttribute('setup-options', ['source' => $sources['build'] . 'setup.options.php']);

हम पैक करते हैं

 if ($package->pack()) { $xpdo->log(xPDO::LOG_LEVEL_INFO, "Package built"); }

यही है, तैयार पैकेज को _packages , अच्छी तरह से, या जहाँ से आपने असेंबली को कॉन्फ़िगर किया है, _packages ।

परिणाम क्या है?

इस दृष्टिकोण के बाद से परिणाम मेरी उम्मीदों से अधिक हो गया, हालांकि यह कुछ सीमाएं लगाता है और कुछ स्थानों पर कुछ असुविधा को जोड़ता है, लेकिन आवेदन संभावनाओं के संदर्भ में जीतता है।

पैकेज बनाने के लिए, बस 2 कमांड निष्पादित करें:

 git clone --recursive git@github.com:Alroniks/modx-slackify.git cd modx-slackify/_build && php build.transport.php

पहला रिपॉजिटरी और उसके सबमॉड्यूल्स का क्लोनिंग है। एक महत्वपूर्ण पैरामीटर है - --recursive , इसके लिए धन्यवाद घटक कोड के अलावा, डाउनलोड और इंस्टॉल होगा, सभी निर्भरताएं जो सबमोड्यूल्स के रूप में वर्णित हैं।

दूसरा सीधे पैकेज का निर्माण कर रहा है। उसके बाद, आप तैयार package-1.0.0-pl.transport.zip _packages को _packages फ़ोल्डर से उठा सकते हैं और इसे लोड कर सकते हैं, उदाहरण के लिए, रिपॉजिटरी में।

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

प्रश्न पूछें, उत्तर देने का प्रयास करें।

PS पास से मत गुजरो , GitHub पर एक Slackify स्टार रखो , कृपया।

MODX स्थापित किए बिना एक परिवहन पैकेज का निर्माण