MODX क्रांति में एक नया टैग जोड़ें

यह विषय MODX क्रांति के लिए एक प्लगइन बनाने में मेरे अनुभव का वर्णन करता है, जो इस CMS में एक नया टैग जोड़ता है। मुझे आपको याद दिलाना है कि एक डेवलपर अपनी साइट की सामग्री सामग्री में या टेम्पलेट और विखंडू में टैग का उपयोग कर सकता है। उदाहरण के लिए, [[* पेजेटिटेल]] टैग MODX पार्सर द्वारा संसाधित किया जाएगा और उस पृष्ठ का शीर्षक लौटाएगा जिस पर उपयोगकर्ता स्थित है।

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

सबसे पहले आपको यह तय करना था कि आप किन घटनाओं के लिए प्लगइन को लटका देना चाहते हैं। उन लोगों के लिए जो MODX सिस्टम से परिचित नहीं हैं, मैं ध्यान देता हूं कि यहां प्लगइन ऐड-ऑन कहा जाता है जिसे कुछ पूर्वनिर्धारित ईवेंट पर कहा जाता है। डिफ़ॉल्ट रूप से प्रदान की गई सिस्टम ईवेंट की बड़ी सूची से, यह पता चला है कि केवल OnParseDocument ईवेंट उपयुक्त है, क्योंकि यह modParser क्लास (फ़ाइल कोर / मॉडल / modx / modparser.class.php) के processElementTags () विधि में MODX पार्सर में कहा जाता है। उसके बाद, कोई भी घटना हमारे टैग के साथ सामग्री प्राप्त करने में सक्षम नहीं होगी, क्योंकि वे सभी गैर-मौजूद के रूप में कट जाएंगे।
प्लगइन का प्रारंभिक संस्करण बहुत सरल था:

$content = $modx->documentOutput; $pattern = '@\[\[#(\d+)\.(.+?)\]\]@si'; if (preg_match($pattern, $content, $matches) > 0) { $tag = $matches[0]; $resource_id = $matches[1]; $resource_field = explode('.', $matches[2]); $resource = $modx->getObject('modResource', $resource_id); if (count($resource_field) == 1) { $value = $resource->get($resource_field[0]); } else { if ($resource_field[0] == 'tv' && isset($resource_field[1])) { $value = $resource->getTVValue($resource_field[1]); } elseif (in_array($resource_field[0], array('properties', 'property', 'prop'))) { $value = $resource->getProperty($resource_field[2], $resource_field[1]); } else { $value = ''; } } $modx->documentOutput = str_replace($tag, $value, $content); } 

कार्य प्रपत्र [[# 10.pagetitle]], [[# 10.tv.MyTV]] के टैग को संसाधित करना था। सिद्धांत रूप में, समस्या हल हो गई थी, लेकिन खेतों में I / O फ़िल्टर लागू करना असंभव था।
इसलिए, मुझे यह समझने में बेहतर था कि टैग को संसाधित करते समय पार्सर क्या करता है। और वह निम्न कार्य करता है।
फ़ंक्शन का उपयोग करके सामग्री के सभी टैग एकत्र करता है

 public function collectElementTags($origContent, array &$matches, $prefix= '[[', $suffix= ']]') 

इसके अलावा, टैग 2 तत्वों की एक सरणी के रूप में लौटाए जाते हैं - एक बाहरी टैग और एक आंतरिक। चूंकि हमारे नए टैग में एक टैग की सभी विशेषताएं हैं, इसलिए यह फ़ंक्शन इसे भी लौटा देगा। इसके बाद, $ tagMap सरणी का निर्माण किया जाता है, जिसमें फ़ॉर्म टैग => संसाधित टैग के str_replace फ़ंक्शन के प्रतिस्थापन की सूची होती है। प्रत्येक टैग को संसाधित करते समय, पार्सर फ़ंक्शन को कहा जाता है

 public function processTag($tag, $processUncacheable = true) 

जिसमें टैग की सामग्री को भागों में विभाजित किया गया है: एक टोकन (एक विशेष प्रकार के टैग को चिह्नित करने वाला एक प्रतीक, उदाहरण के लिए * संसाधन फ़ील्ड के लिए या ~ लिंक के लिए, हमारे मामले में, एक पाउंड साइन #), एक नाम (या टैग का निकाय, उदाहरण के लिए, पेजेटाइल [में] [* पेजेटीटल]]), फिल्टर (: ucase, आदि) और पैरामीटर (और स्निपेट टैग या अन्य में पैरामीटर)। टोकन निर्धारित करता है कि टैग को संसाधित करने के लिए किस विशेष टैग वर्ग को बुलाया जाएगा। ये सभी अमूर्त मोदग वर्ग के वंशज हैं। इसलिए, एक नया टैग बनाने के लिए, एक नया वर्ग modResourceFieldTag बनाएं। सभी टैग कक्षाओं ने प्रक्रिया () और getContent () विधियों को ओवरराइड किया है। उसी समय, हमारा नया टैग रिसोर्स फील्ड टैग से काफी मिलता-जुलता है, और मैंने इसकी प्रक्रिया () विधि को छोड़ने के लिए इसे modFieldTag क्लास से प्राप्त किया। यहाँ क्या हुआ:

 class modResourceFieldTag extends modFieldTag { /** * Overrides modTag::__construct to set the Field Tag token * {@inheritdoc} */ function __construct(modX & $modx) { parent :: __construct($modx); $this->setToken('#'); } /** * Get the raw source content of the field. * * {@inheritdoc} */ public function getContent(array $options = array()) { if (!$this->isCacheable() || !is_string($this->_content) || $this->_content === '') { if (isset($options['content']) && !empty($options['content'])) { $this->_content = $options['content']; } else { $tag = explode('.', $this->get('name')); $tagLength = count($tag); // for processing tags in resource_id place ([[#[[+id]].pagetitle]]) $tags = array(); if ($collected= $this->modx->parser->collectElementTags($tag[0], $tags)) { $tag[0] = $this->modx->parser->processTag($tags[0], $this->modx->parser->isProcessingUncacheable()); } if (is_numeric($tag[0])) { $resource = $this->modx->getObject('modResource', $tag[0]); if ($resource) { if ($tagLength == 2) { if ($tag[1] == 'content') { $this->_content = $resource->getContent($options); } else { $this->_content = $resource->get($tag[1]); } } else { if (($tag[1] == 'tv') && ($tagLength == 3)) { $this->_content = $resource->getTVValue($tag[2]); } elseif (in_array($tag[1], array('properties', 'property', 'prop')) && ($tagLength == 4)) { $this->_content = $resource->getProperty($tag[3], $tag[2]); } else { $this->_content = ''; } } } else { $this->_content = ''; } } } } return $this->_content; } } 

मामले को संभालने के लिए जब टैग को संसाधन पहचानकर्ता के लिए प्लेसहोल्डर के साथ बुलाया जाता है (उदाहरण के लिए, [[[[[आईडी]]। पगेटिटेल]), हम इसके अतिरिक्त टैग के इस भाग को संसाधित करते हैं:

 $tags = array(); if ($collected= $this->modx->parser->collectElementTags($tag[0], $tags)) { $tag[0] = $this->modx->parser->processTag($tags[0], $this->modx->parser->isProcessingUncacheable()); } 

फ़िल्टर जिन्हें फ़िल्टर में बुलाया जा सकता है, उन्हें इवेंट के बाद पार्सर द्वारा संसाधित किया जाएगा।

अब यह टैग डेटा के प्रसंस्करण को कॉल करने के लिए बना हुआ है, वास्तव में फास्टफिल्ड प्लगइन में:

 switch ($modx->event->name) { case 'OnParseDocument': $content = $modx->documentOutput; $tags= array (); if ($collected= $modx->parser->collectElementTags($content, $tags, '[[', ']]', array('#'))) { $tagMap= array (); foreach ($tags as $tag) { $token = substr($tag[1], 0, 1); if ($token == '#') { include_once $modx->getOption('core_path') . 'components/fastfield/model/fastfield/fastfield.php'; $tagParts= xPDO :: escSplit('?', $tag[1], '`', 2); $tagName= substr(trim($tagParts[0]), 1); $tagPropString= null; if (isset ($tagParts[1])) { $tagPropString= trim($tagParts[1]); } $element= new modResourceFieldTag($modx); $element->set('name', $tagName); $element->setTag(''); $element->setCacheable(false); $tagMap[$tag[0]] = $element->process($tagPropString); } } $modx->parser->mergeTagOutput($tagMap, $content); $modx->documentOutput = $content; } break; } 

मुझे उम्मीद है कि यह लेख पाठकों के लिए अपने स्वयं के टैग बनाने के लिए एक गाइड के रूप में कार्य करता है। कोड सही नहीं हो सकता है, लेकिन यह इस अद्भुत सीएमएस / सीएमएफ के साथ आगे के प्रयोग की तैयारी के रूप में काम कर सकता है।

प्लगइन का स्रोत कोड GitHub पर उपलब्ध है ।