Drupal: फीड के लिए अपना पार्सर लिखना

Drupal Developers के बीच Feeds मॉड्यूल बहुत लोकप्रिय है। लेकिन सवाल यह उठता है कि अगर अपनी कार्यक्षमता को थोड़ा विस्तार करना आवश्यक हो तो क्या करें। फीड्स मॉड्यूल का प्लगइन्स सिस्टम हमें इसमें मदद करेगा।
3 प्रकार के प्लगइन्स हैं, जिनसे आपको नए की आवश्यकता होती है:

• FeedsFetcher - एक कलेक्टर प्लगइन। मानक: HTTP और फ़ाइल अपलोड। इस प्रकार के प्लगइन का उपयोग करके, आप एक नया डेटा स्रोत जोड़ सकते हैं।
• FeedsProcessor - एंटिटी प्रोसेसिंग प्लगइन। मानक: नोड प्रोसेसर, टैक्सोनॉमी टर्म प्रोसेसर, उपयोगकर्ता प्रोसेसर। नए प्लगइन का उपयोग करके, आप एक नया हैंडलर जोड़ सकते हैं जो विशेष इकाइयां बनाएगा जो मानक सेट में फिट नहीं होते हैं।
• FeedsParser - एक पार्सर प्लगइन। फ़ीड में मानक पार्सर XML, CSV और कई अन्य हैं।

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

मॉड्यूल निर्माण

हमेशा की तरह, एक मॉड्यूल बनाने के लिए, हमें एक जानकारी फ़ाइल और एक मॉड्यूल फ़ाइल बनाने की आवश्यकता है:

json_example_parser.info

name = Json example parser description = Simple json parser package = Feeds core = 7.x dependencies[] = feeds 

json_example_parser.module

 <?php /** * @file * Json example parser - simple parser plugin */ /** * Implementation of hook_feeds_plugins(). *    . */ function json_example_parser_feeds_plugins() { $info = array(); $info['JsonExampleParser'] = array( 'name' => 'JSON parser', 'description' => 'Parses custom JSON.', 'handler' => array( 'parent' => 'FeedsParser', //      ,   Feeds - FeedsFetcher, FeedsParser  FeedsProcessor 'class' => 'JsonExampleParser', //  ,       'file' => 'JsonExampleParser.inc', //    'path' => drupal_get_path('module', 'json_example_parser'), //     ), ); return $info; } //    Feeds    function json_example_parser_enable() { //clear the cache to display in Feeds as available plugin. cache_clear_all('plugins:feeds:plugins', 'cache'); } ?> 

टिप्पणियों में हुक के मुख्य आकर्षण का वर्णन है।

स्रोत डेटा

उदाहरण के लिए, आयातित सामग्री के लिए, निम्नलिखित क्षेत्रों के साथ "कंप्यूटर गेम" नोड लें:

जो डेटा पार्स किया जाएगा, वह JSON फॉर्मेट में आएगा। इससे कोई फर्क नहीं पड़ता कि यह डाउनलोड करने योग्य फ़ाइल है या HTTP संग्राहक, Fetcher इसके लिए ज़िम्मेदार है और डेटा प्राप्त करने के तरीके कलेक्टर के लिए प्लग इन के सेट पर निर्भर हैं।

इनपुट JSON:

 [ { "name":"Team Fortress 2", "year":2007, "price":0 }, { "name":"Warcraft III: The Frozen Throne", "year":2003, "price":13.9 }, { "name":"Diablo III", "year":2012, "price":33 } ] 

पार्सर क्लास बनाना

एक पार्सर वर्ग बनाने के लिए, आपको इसे मानक अमूर्त वर्ग फीडर्सपैर से विरासत में प्राप्त करना होगा और पार्स और गेटमैप्सॉर्स विधियों को ओवरराइड करना होगा। बाकी तरीकों को ओवरराइड करना वैकल्पिक है।

JsonExampleParser.inc

 <?php /** * A JSON example parser */ class JsonExampleParser extends FeedsParser { /** * Implements FeedsParser::parse(). */ public function parse(FeedsSource $source, FeedsFetcherResult $fetcher_result) { $result = new FeedsParserResult(); //    $source_config = $source->getConfigFor($this); //  JSON  $fetch_items = json_decode($fetcher_result->getRaw()); foreach ($fetch_items as $value) { $item = array('name' => $value->name); if ($value->year) { $item['year'] = intval($value->year); } if ($value->price) { $item['price'] = floatval($value->price); } //     if ( $source_config['type'] == 'all' || ($source_config['type'] == 'free' && $item['price'] == 0) || ($source_config['type'] == 'paid' && $item['price'] > 0)) { //     $result->items[] = $item; } } return $result; } /** * Implements FeedsParser::getMappingSources(). */ public function getMappingSources() { return array( 'name' => array( 'name' => t('Game name'), 'description' => t('The name of the computer game.'), ), 'year' => array( 'name' => t('Release year'), 'description' => t('Release year of the computer game.'), ), 'price' => array( 'name' => t('Game price'), 'description' => t('The cost of the computer game.'), ), ) + parent::getMappingSources(); } /** * Configuration form. *  ,       . */ public function configForm(&$form_state) { $form = array(); $form['type'] = array( '#type' => 'select', '#title' => t('Game type'), '#description' => t('Game filter by type.'), '#options' => array( 'all' => t('All game'), 'paid' => t('Paid'), 'free' => t('Free'), ), '#default_value' => $this->config['type'], ); return $form; } /** * Define default configuration values. *    ,       . */ public function configDefaults() { return array( 'type' => 'all', ); } /** * Define defaults. *     . */ public function sourceDefaults() { return array( 'type' => $this->config['type'], ); } /** * Show configuration form for users. *         . */ public function sourceForm($source_config) { $form = array(); $form['#weight'] = -10; $form['help']['#markup'] = '<div class="help"><p>' . t('Select the type of game you want to import') . ':</p></div>'; $form['type'] = array( '#type' => 'select', '#title' => t('Game type'), '#description' => t('Game filter by type.'), '#options' => array( 'all' => t('All game'), 'paid' => t('Paid'), 'free' => t('Free'), ), '#default_value' => isset($source_config['type']) ? $source_config['type'] : 'all', ); return $form; } } 

तरीकों के बारे में थोड़ा।

पार्स - एक पार्सिंग विधि; स्रोत वर्ग की वस्तु प्राप्त करती है फीडस्सोर्स और क्लास फीड का ऑब्जेक्ट फीडसेटर.काउंटर जिससे रीड डेटा निकाला जाता है। यह विधि एक तैयार की गई वस्तु बनाती है FeedsParserResult को बचाने के लिए संस्थाओं के एक सेट के साथ।

getMappingSources - एक विधि जो फ़ील्ड का निर्धारण करती है जो स्रोत से लिखित वस्तु के क्षेत्रों के लिए लेखन के लिए उपलब्ध होगी। उदाहरण के लिए, इस मामले में, मैपिंग फ़ील्ड का नाम नोड हेडर आदि को लिखा जाएगा।

configForm - यह विधि एक कॉन्फ़िगरेशन फ़ॉर्म प्रदान करती है जो आयातक की सेटिंग में व्यवस्थापक पृष्ठ पर प्रदर्शित किया जाएगा। डेटा स्वचालित रूप से सहेजा जाता है।

configDefaults - मानक सेटिंग्स यदि उपयोगकर्ता ने पार्सर को कॉन्फ़िगर करने के लिए फॉर्म का उपयोग नहीं किया है।

sourceDefaults कॉन्फ़िगरेशन फ़ॉर्म से संग्रहीत मापदंडों तक पहुंचने के लिए एक ओवरराइड विधि है।

sourceForm - एक ऐसा फॉर्म जो आयात करने पर उपयोगकर्ताओं को उपलब्ध होगा, वह फ़ॉचर फॉर्म का पूरक होगा।

निष्कर्ष

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