Drupal 7. भाग 1 के लिए एक मॉड्यूल बनाना

प्रस्तावना

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

मैं यह नहीं बताऊंगा कि ड्रुपल क्या है, इसकी संरचना क्या है। यह लेख उन लोगों के लिए है जो हुक के संचालन और द्रुपाल के प्रदर्शन के सिद्धांत को कम से कम जानते हैं। यह सब आधिकारिक Drupal API वेबसाइट पर पढ़ा जा सकता है।

मॉड्यूल विकास की शुरुआत

मैं दिखाऊंगा कि एक मॉड्यूल कैसे बनाया जाता है जो आपको आरएसएस फ़ीड जोड़ने और एक अलग पृष्ठ पर उनकी सामग्री प्रदर्शित करने की अनुमति देता है।

सबसे पहले आपको मॉड्यूल के "संक्षिप्त नाम" का चयन करना होगा। इसका उपयोग सभी फाइलों और मॉड्यूल के फ़ंक्शन नामों में किया जाएगा। यह केवल एक अक्षर से शुरू होना चाहिए और इसमें केवल लोअरकेस वर्ण और "_" चिह्न होना चाहिए। मैंने अपने मॉड्यूल का नाम "rss_feeds" रखा।

एक फ़ोल्डर बनाएँ: साइटें / सभी / मॉड्यूल / rss_feeds (सभी नए मॉड्यूल जो आप जोड़ना चाहते हैं, इस फ़ोल्डर में होने चाहिए)। इसमें, हम rss_feeds.info फ़ाइल बनाते हैं, जिसमें हमारे मॉड्यूल के बारे में META जानकारी होती है:

name = RSS फ़ीड्स
विवरण = RSS फ़ीड्स पर नेविगेट करने के लिए एक कॉम्पैक्ट पेज बनाता है।
पैकेज = "आरएसएस"
कोर = 7.x
संस्करण = "7.x-1.0"
config = admin / config / content / rss_feeds
फाइलें [] = rss_feeds.module

• नाम - मॉड्यूल का नाम जो व्यवस्थापक पैनल में प्रदर्शित किया जाएगा;
• विवरण - मॉड्यूल का विवरण जो व्यवस्थापक को बताता है कि यह मॉड्यूल क्या करता है;
• पैकेज - उस श्रेणी को इंगित करता है जिसमें मॉड्यूल पृष्ठ पर मॉड्यूल प्रदर्शित किया जाएगा;
• कोर - ड्रुपल का संस्करण जिसके लिए इसे विकसित किया गया था;
• संस्करण - हमारे मॉड्यूल का संस्करण;
• कॉन्फ़िगर करें - वह पथ जिसके साथ मॉड्यूल सेटिंग पृष्ठ उपलब्ध होगा;
• फाइलें [] - मॉड्यूल द्वारा जुड़ी फाइलों की एक सरणी;

कुछ और क्षेत्र हैं जिनके बारे में आप यहाँ पढ़ सकते हैं।

हमारा मॉड्यूल एक डेटाबेस का उपयोग करेगा जिसमें यह RSS (इसका नाम और URL) के बारे में डेटा संग्रहीत करेगा। Rss_feeds.install फ़ाइल बनाएँ:

<?php function rss_feeds_uninstall() { cache_clear_all('rss_feeds', 'cache', TRUE); drupal_uninstall_schema('rssfeeds'); menu_rebuild(); } function rss_feeds_schema() { $schema['rssfeeds'] = array( 'fields' => array( 'id' => array('type' => 'serial', 'size'=>'normal', 'not null' => TRUE), 'name' => array('type' => 'varchar', 'length' => 255, 'not null' => TRUE), 'url' => array('type' => 'varchar', 'length' => 255, 'not null' => TRUE), 'created_at' => array('type' => 'int', 'not null' => TRUE), 'updated_at' => array('type' => 'int', 'not null' => TRUE), ), 'primary key' => array('id') ); return $schema; } 

स्कीमा () हुक में, हम अपनी आवश्यकता की तालिका बनाते हैं। अनइंस्टॉल () हुक कैश को साफ करता है , तालिका को हटाता है, और मॉड्यूल को हटाए जाने पर मेनू को फिर से बनाता है (यह ड्रुपल में बंद होने के लिए "?>" टैग को सेट नहीं करने के लिए प्रथागत है)।

.Module फ़ाइल बनाना

अगला, हम सीधे मॉड्यूल फ़ाइल बनाते हैं - rss_feeds.module :

 <?php function rss_feeds_block_info() { $blocks['rss_feeds'] = array( 'info' => t('RSS Feeds'), 'cache' => DRUPAL_CACHE_PER_ROLE, //   ); return $blocks; } 

इस हुक में, हम प्रयुक्त ब्लॉकों का वर्णन करते हैं। हमारे साथ, यह केवल एक ही होगा और इसे 'rss_feeds' कहा जाएगा। 'info' ब्लॉक के बारे में संक्षिप्त जानकारी है, और 'cache' कैश नियम है। अधिक जानकारी के लिए hook_block_info () देखें।

आगे हम हुक_मेनू () का वर्णन करते हैं :

 function rss_feeds_menu() { $items = array(); $items['admin/config/content/rss_feeds'] = array( 'title' => 'RSS Feeds', 'description' => 'Configure the RSS feeds list.', 'page callback' => 'rss_list', 'access arguments' => array('administer site configuration'), ); $items['admin/config/content/rss_feeds/list'] = array( 'title' => 'RSS feeds list', 'type' => MENU_DEFAULT_LOCAL_TASK, 'weight' => 1, ); // rss add form $items['admin/config/content/rss_feeds/add'] = array( 'title' => 'Add rss', 'page callback' => 'drupal_get_form', 'page arguments' => array('rss_feeds_form'), 'access arguments' => array('administer site configuration'), 'type' => MENU_LOCAL_TASK, 'weight' => 2, ); // rss edit form $items['admin/config/content/rss_feeds/%rss/edit'] = array( 'title' => 'Edit RSS', 'page callback' => 'drupal_get_form', 'page arguments' => array('rss_feeds_form', 4), 'access arguments' => array('administer site configuration'), 'type' => MENU_CALLBACK, ); // rss delete $items['admin/config/content/rss_feeds/%rss/delete'] = array( 'title' => 'Delete RSS', 'page callback' => 'rss_feeds_delete', 'page arguments' => array(4), 'access arguments' => array('administer site configuration'), 'type' => MENU_CALLBACK, ); $items['rss_feeds'] = array( 'title' => 'RSS feeds', 'page callback' => '_rss_feeds_page', 'access arguments' => array('access content'), ); $items['rss_feeds/%rss/items'] = array( 'title' => 'RSS feed content', 'page callback' => 'rss_content', 'page arguments' => array(1), 'access callback' => TRUE, 'access arguments' => array('access content'), 'type' => MENU_CALLBACK, ); return $items; } 

आइटम में, हम URL, इसका शीर्षक (शीर्षक), विवरण (विवरण), प्रोसेसिंग फंक्शन (पेज कॉलबैक), पारित तर्क (पृष्ठ तर्क), एक्सेस पैरामीटर (एक्सेस तर्क), प्रकार (प्रकार) और "वजन" (वजन) निर्दिष्ट करते हैं। मैं पृष्ठ कॉलबैक - drupal_get_from को हाइलाइट करना चाहूंगा। यह फ़ंक्शन एक पैरामीटर के रूप में एक फॉर्म लेता है और इसे प्रदर्शित करता है। "पृष्ठ तर्क => सरणी (1)" में , एक तर्क के रूप में हम URL के 1 तत्व को पास करते हैं (गणना 0 से जाती है)।

हुक_मेनू पर अधिक () ।

अगला, हम उस फॉर्म का वर्णन करते हैं जिसके माध्यम से हम अपने आरएसएस फ़ीड को जोड़ेंगे और संपादित करेंगे:

 function rss_feeds_form($form, &$form_state, $rss = null) { $form['name'] = array( '#title' => t('RSS feed name.'), '#description' => t('Insert RSS shortcut name'), '#type' => 'textfield', '#default_value' => $rss ? $rss['name'] : '', '#required' => true, ); $form['url'] = array( '#title' => t('RSS feed url.'), '#description' => t('Insert RSS url'), '#type' => 'textfield', '#default_value' => $rss ? $rss['url'] : '', '#required' => true, ); $form['submit'] = array( '#type' => 'submit', '#value' => $rss ? t('Save') : t('Add'), ); if ($rss) { $form['id'] = array( '#type' => 'value', '#value' => $rss['id'], ); } return $form; } 

जैसा कि आप देख सकते हैं, अगर हम फॉर्म में $ rss पैरामीटर को पास करते हैं, तो फॉर्म समझ जाएगा कि हम एक नया फीड जोड़ रहे हैं, या किसी मौजूदा को एडिट कर रहे हैं। टी () (अनुवाद) फ़ंक्शन आपको मॉड्यूल को स्थानीय बनाने की अनुमति देता है (मैं इस बारे में थोड़ी देर बाद बात करूंगा)। हुक_फॉर्म पर अधिक () ।

अगला, आपको हुक_फॉर्म_वेलिडेट () का वर्णन करने की आवश्यकता है, जो डेटा को फॉर्म में दर्ज करेगा:

 function rss_feeds_form_validate($form, &$form_state) { $url = $form_state['values']['url']; if (fopen($url, "r")) { libxml_use_internal_errors(true); $rss_feed = simplexml_load_file($url); if (empty($rss_feed)) { form_set_error('url', t('URL is invalid!')); } } else { form_set_error('url', t('URL is invalid!')); } } 

पहले हमें $ form_state से डेटा मिलता है, और फिर हम इसे प्रोसेस करते हैं। यदि कुछ गलत है, तो मानक form_set_error () फेंक दिया जाता है, जिसमें हम प्रपत्र फ़ील्ड नाम और संदेश निर्दिष्ट करते हैं।

जब फॉर्म सत्यापन पास करता है, तो हुक_फॉर्म_सुमिट () कहा जाता है :

 function rss_feeds_form_submit($form, &$form_state) { $rss = array( 'name' => $form_state['values']['name'], 'url' => $form_state['values']['url'], 'created_at' => time(), 'updated_at' => time(), ); // save edit data if (isset($form_state['values']['id'])) { $rss['id'] = $form_state['values']['id']; drupal_write_record('rssfeeds', $rss, 'id'); drupal_set_message(t('RSS Feed saved!')); } // add new data else { drupal_write_record('rssfeeds', $rss); drupal_set_message(t('RSS Feed added!')); } drupal_goto('admin/config/content/rss_feeds'); } 

मुझे लगता है कि यहां सब कुछ स्पष्ट है। drupal_write_record () डेटाबेस को लिखता है, drupal_set_message () सिस्टम संदेश, drupal_goto () दिए गए URL पर फेंकता है।

केवल टेप आईडी ( $ rss ) को स्वीकार करने के लिए फॉर्म के लिए, लेकिन इसके डेटा के लिए, आपको hool_load को परिभाषित करने की आवश्यकता है:

 function rss_load($id) { $rss = db_select('rssfeeds', 'n') ->fields('n', array('id', 'name', 'url', 'created_at', 'updated_at')) ->condition('n.id', $id) ->execute()->fetchAssoc(); return $rss; } 

अब, $ rss के रूप में , संख्या को फ़ॉर्म में स्थानांतरित नहीं किया जाएगा, लेकिन डेटा के साथ एक ऑब्जेक्ट।

अगला, हमें पृष्ठ आउटपुट फ़ंक्शन को लागू करने की आवश्यकता है, जिस पर हम अपनी आरएसएस फ़ीड की तालिका को संपादित कर सकते हैं - rss_list () :

 function rss_list() { $header = array( array('data' => t('Name')), array('data' => t('URL')), array('data' => t('Actions')) ); $rss = db_select('rssfeeds', 'n') ->fields('n', array('id', 'name', 'url')) ->execute()->fetchAll(); $row = array(); if ($rss) { foreach ($rss as $rss_feed) { $actions = array( l(t('edit'), 'admin/config/content/rss_feeds/' . $rss_feed->id . '/edit'), l(t('delete'), 'admin/config/content/rss_feeds/' . $rss_feed->id . '/delete'), ); $row [] = array( array('data' => $rss_feed->name), array('data' => $rss_feed->url), array('data' => implode(' | ', $actions)), ); } } return theme('table', array( 'header' => $header, 'rows' => $row, )); } 

फंक्शन l () (लिंक) - एक लिंक बनाता है। लेकिन मुख्य कार्य थीम () है । आप उससे अलग से मिलेंगे, क्योंकि यह बहुत व्यापक है और इसमें कई उपयोगी पैरामीटर हैं।

नीचे हम रिकॉर्ड rss_feeds_delete () को हटाने के लिए फ़ंक्शन बनाते हैं:

 function rss_feeds_delete($rss) { $rss_deleted = db_delete('rssfeeds') ->condition('id', $rss['id']) ->execute(); drupal_set_message(t('RSS Feed deleted!')); drupal_goto('admin/config/content/rss_feeds'); } 

कोई टिप्पणी नहीं।

सुविधा के लिए, भविष्य में मैंने एक फ़ंक्शन जोड़ा जो पैरामीटर (ब्लॉक या पृष्ठ) के आधार पर, डेटा लौटाएगा। यहाँ इसकी सामग्री हैं:

 function rss_contents($display) { $query = db_select('rssfeeds', 'n') ->fields('n', array('id', 'name', 'url')) ->orderBy('name', 'DESC'); if ($display == 'block') { $query->range(0, 5); } return $query->execute(); } 

यदि हम पैरामीटर के रूप में 'ब्लॉक' निर्दिष्ट करते हैं, तो हमें केवल 5 रिकॉर्ड मिलेंगे।

अगला, हम ब्लॉक आउटपुट के हुक को लागू करते हैं - हुक_ब्लॉक_व्यू () :

 function rss_feeds_block_view($delta = '') { $blocks = array(); switch ($delta) { case 'rss_feeds': $select = db_select('rssfeeds', 'tc'); $select->addField('tc', 'name'); $select->addField('tc', 'url'); $entries = $select->execute()->fetchAll(); $blocks['subject'] = t('List of URLs'); $blocks['content'] = theme('rssfeeds_block', array('urls' => $entries)); } return $blocks; } 

यह ब्लॉक प्रशासन पैनल में उपलब्ध होगा।

अब हम उस पृष्ठ को प्रदर्शित करने के लिए एक फ़ंक्शन लिखेंगे, जिस पर फ़ीड की एक सूची होगी, जब क्लिक किया जाता है, तो सामग्री प्रदर्शित की जाएगी (एक नए टैब में):

 function _rss_feeds_page() { drupal_set_title(t('RSS Feeds')); $result = rss_contents('page')->fetchAll(); if (!$result) { $page_array['rss_feeds_arguments'] = array( '#title' => t('RSS Feeds page'), '#markup' => t('No RSS feeds available'), ); return $page_array; } else { $page_array = theme('rssfeeds_page', array('urls' => $result)); return $page_array; } } 

... और सामग्री प्रदर्शन पृष्ठ:

 function rss_content($rss) { $url = $rss['url']; libxml_use_internal_errors(true); $rss_feed = simplexml_load_file($url); if (!empty($rss_feed)) { drupal_set_title($rss_feed->channel->title); $page_array = theme('rssfeeds_content', array('items' => $rss_feed)); return $page_array; } else { $page_array['rss_feeds_arguments'] = array( '#title' => t('All posts from the last week'), '#markup' => t('No posts available.'), ); return $page_array; } } 

आपने देखा होगा, लेकिन पृष्ठ प्रदर्शित नहीं होंगे। मैंने थीम () फ़ंक्शन में 'rssfeeds_block' और 'rssfeeds_content' पैरामीटर निर्दिष्ट किए। ये मेरे द्वारा बनाए गए टेम्प्लेट हैं। आइए उन्हें आरंभ करने के लिए hook_theme () बनाएं:

 function rss_feeds_theme() { return array( 'rssfeeds_block' => array( 'variables' => array( 'urls' => NULL ), 'template' => 'rssfeeds-block', ), 'rssfeeds_page' => array( 'variables' => array( 'urls' => NULL ), 'template' => 'rssfeeds-page', ), 'rssfeeds_content' => array( 'variables' => array( 'items' => NULL ), 'template' => 'rssfeeds-content', ) ); } 

फ़ील्ड में 'टेम्प्लेट' टेम्पलेट के नाम से संकेत मिलता है।

अब स्वयं टेम्पलेट फ़ाइलें बनाएँ। अर्थात्: rssfeeds-block.tpl.php , rssfeeds-page.tpl.php और rssfeeds-content.tpl.php ।

पहली फ़ाइल की सामग्री:

 <div id="rssfeeds-pager"> <?php foreach ($urls as $url): ?> <span> <a target="_blank" href="http://<?php echo $url->url; ?>"><?php echo $url->url; ?></a><br> </span> <?php endforeach; ?> </div> 

... दूसरा:

 <div id="rssfeeds-pager"> <?php foreach ($urls as $url): ?> <span> <a target="_blank" href="rss_feeds/<?php echo $url->id; ?>/items"><?php echo $url->name; ?></a><br> </span> <?php endforeach; ?> </div> 

... और तीसरा, क्रमशः:

 <?php foreach ($items->channel->item as $item): ?> <span class="title"><a href="<?php echo $item->link; ?>"><?php echo $item->title; ?></a></span><br><br> <?php echo $item->description; ?><br><br><?php echo $item->pubDate; ?> <hr><br><br> <?php endforeach; ?> 

अब हमारा मॉड्यूल कार्य करेगा। हालांकि, आपने शायद ध्यान दिया - कक्षाओं को तत्वों के लिए परिभाषित किया गया है। अब CSS स्टाइल फाइल को हमारे मॉड्यूल में अटैच करें। ऐसा करने के लिए, .info फ़ाइल में यह पंक्ति जोड़ें:

स्टाइलशीट [सभी] [] = main.css

और main.css फ़ाइल बनाएँ:

 .title { font-size: 16px; text-shadow: 0px 0px 1px black; font-weight: bold; } .title a { text-decoration: none; color: #B81007; } .title a:hover { text-decoration: underline; } 

निष्कर्ष

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

आपका ध्यान के लिए धन्यवाद!

पुनश्च

दूसरा भाग लिखा।