From 4c818c055d5f06799429265a12f560ab84a6dcc7 Mon Sep 17 00:00:00 2001 From: Paul Pound Date: Fri, 4 May 2018 15:07:57 -0300 Subject: [PATCH] some class refactor error checking and added pyhlum field --- ...ode.islandora_herbarium_object.default.yml | 9 ++++ ...ode.islandora_herbarium_object.default.yml | 8 ++++ ...dora_herbarium_object.field_dwc_phylum.yml | 18 ++++++++ ...ium_object.field_dwciri_scientificname.yml | 2 +- .../field.storage.node.field_dwc_phylum.yml | 19 +++++++++ islandora_herbarium_object.module | 41 ++++++++++++------- islandora_herbarium_object.services.yml | 2 +- src/DataParser/DataParser.php | 11 ++--- src/DataParser/DataParserInterface.php | 11 +++-- src/DataParser/GbifParser.php | 22 ++++++++++ src/DataParser/GeonamesParser.php | 6 ++- src/DataParser/IpniParser.php | 2 +- src/DataParser/XmlDataParser.php | 18 ++++++++ 13 files changed, 141 insertions(+), 28 deletions(-) create mode 100644 config/install/field.field.node.islandora_herbarium_object.field_dwc_phylum.yml create mode 100644 config/install/field.storage.node.field_dwc_phylum.yml create mode 100644 src/DataParser/GbifParser.php create mode 100644 src/DataParser/XmlDataParser.php diff --git a/config/install/core.entity_form_display.node.islandora_herbarium_object.default.yml b/config/install/core.entity_form_display.node.islandora_herbarium_object.default.yml index d967ebe..04f4a29 100644 --- a/config/install/core.entity_form_display.node.islandora_herbarium_object.default.yml +++ b/config/install/core.entity_form_display.node.islandora_herbarium_object.default.yml @@ -19,6 +19,7 @@ dependencies: - field.field.node.islandora_herbarium_object.field_dwc_kingdom - field.field.node.islandora_herbarium_object.field_dwc_municipality - field.field.node.islandora_herbarium_object.field_dwc_order + - field.field.node.islandora_herbarium_object.field_dwc_phylum - field.field.node.islandora_herbarium_object.field_dwc_recordedby - field.field.node.islandora_herbarium_object.field_dwc_scientificname - field.field.node.islandora_herbarium_object.field_dwc_specificepithet @@ -84,6 +85,14 @@ content: third_party_settings: { } type: datetime_default region: content + field_dwc_phylum: + weight: 27 + settings: + rows: 5 + placeholder: '' + third_party_settings: { } + type: string_textarea + region: content field_dwc_recordedby: weight: 9 settings: diff --git a/config/install/core.entity_view_display.node.islandora_herbarium_object.default.yml b/config/install/core.entity_view_display.node.islandora_herbarium_object.default.yml index 3a5d050..4bcb19c 100644 --- a/config/install/core.entity_view_display.node.islandora_herbarium_object.default.yml +++ b/config/install/core.entity_view_display.node.islandora_herbarium_object.default.yml @@ -19,6 +19,7 @@ dependencies: - field.field.node.islandora_herbarium_object.field_dwc_kingdom - field.field.node.islandora_herbarium_object.field_dwc_municipality - field.field.node.islandora_herbarium_object.field_dwc_order + - field.field.node.islandora_herbarium_object.field_dwc_phylum - field.field.node.islandora_herbarium_object.field_dwc_recordedby - field.field.node.islandora_herbarium_object.field_dwc_scientificname - field.field.node.islandora_herbarium_object.field_dwc_specificepithet @@ -162,6 +163,13 @@ content: label: inline settings: { } third_party_settings: { } + field_dwc_phylum: + weight: 28 + label: above + settings: { } + third_party_settings: { } + type: basic_string + region: content field_dwc_recordedby: weight: 7 label: inline diff --git a/config/install/field.field.node.islandora_herbarium_object.field_dwc_phylum.yml b/config/install/field.field.node.islandora_herbarium_object.field_dwc_phylum.yml new file mode 100644 index 0000000..e22ccf8 --- /dev/null +++ b/config/install/field.field.node.islandora_herbarium_object.field_dwc_phylum.yml @@ -0,0 +1,18 @@ +langcode: en +status: true +dependencies: + config: + - field.storage.node.field_dwc_phylum + - node.type.islandora_herbarium_object +id: node.islandora_herbarium_object.field_dwc_phylum +field_name: field_dwc_phylum +entity_type: node +bundle: islandora_herbarium_object +label: Phylum +description: '' +required: false +translatable: false +default_value: { } +default_value_callback: '' +settings: { } +field_type: string_long diff --git a/config/install/field.field.node.islandora_herbarium_object.field_dwciri_scientificname.yml b/config/install/field.field.node.islandora_herbarium_object.field_dwciri_scientificname.yml index ddafadc..1c8d2a2 100644 --- a/config/install/field.field.node.islandora_herbarium_object.field_dwciri_scientificname.yml +++ b/config/install/field.field.node.islandora_herbarium_object.field_dwciri_scientificname.yml @@ -8,7 +8,7 @@ id: node.islandora_herbarium_object.field_dwciri_scientificname field_name: field_dwciri_scientificname entity_type: node bundle: islandora_herbarium_object -label: dwciri_scientificName +label: scientificName description: '' required: false translatable: false diff --git a/config/install/field.storage.node.field_dwc_phylum.yml b/config/install/field.storage.node.field_dwc_phylum.yml new file mode 100644 index 0000000..bde06e0 --- /dev/null +++ b/config/install/field.storage.node.field_dwc_phylum.yml @@ -0,0 +1,19 @@ +uuid: 546f3fbb-e8d5-405d-b40e-861c2eb40079 +langcode: en +status: true +dependencies: + module: + - node +id: node.field_dwc_phylum +field_name: field_dwc_phylum +entity_type: node +type: string_long +settings: + case_sensitive: false +module: core +locked: false +cardinality: 1 +translatable: true +indexes: { } +persist_with_no_fields: false +custom_storage: false diff --git a/islandora_herbarium_object.module b/islandora_herbarium_object.module index 922ef58..263c5cb 100644 --- a/islandora_herbarium_object.module +++ b/islandora_herbarium_object.module @@ -38,16 +38,17 @@ function islandora_herbarium_object_entity_presave(Drupal\Core\Entity\EntityInte $geo->parseData(); } catch (Exception $e) { watchdog_exception('islandora_herbarium_object', $e, 'Error getting dwciri'); - //todo drupal_set_message + drupal_set_message(t('There was an error retrieving Municipality data. %msg. Verify the url is correct %ulr', + array('%msg'=> $e->getMessage(), '%url' => $dwciri[0]['value'])), 'error'); return; } - $entity->set('field_dwc_municipality', $geo->data_arr['name']); - $entity->set('field_dwc_countrycode', $geo->data_arr['countryCode']); - $entity->set('field_dwc_country', $geo->data_arr['countryName']); - $entity->set('field_dwc_continent', $geo->data_arr['countinentCode']); - $entity->set('field_dwc_decimallatitude', $geo->data_arr['lat']); - $entity->set('field_dwc_decimallongitude', $geo->data_arr['lng']); - $entity->set('field_dwc_stateprovince', $geo->data_arr['adminName1']); + $entity->set('field_dwc_municipality', $geo->getValue('name')); + $entity->set('field_dwc_countrycode', $geo->getValue('countryCode')); + $entity->set('field_dwc_country', $geo->getValue('countryName')); + $entity->set('field_dwc_continent', $geo->getValue('countinentCode')); + $entity->set('field_dwc_decimallatitude', $geo->getValue('lat')); + $entity->set('field_dwc_decimallongitude', $geo->getValue('lng')); + $entity->set('field_dwc_stateprovince', $geo->getValue('adminName1')); $point = array( 'lon' => $geo->data_arr['lng'], 'lat' => $geo->data_arr['lat'], @@ -62,17 +63,27 @@ function islandora_herbarium_object_entity_presave(Drupal\Core\Entity\EntityInte $taxon->parseData(); } catch (Exception $e) { watchdog_exception('islandora_herbarium_object', $e, 'Error getting dwciri'); - //todo drupal_set_message + drupal_set_message(t('There was an error retrieving Taxon data. %msg. Verify the url is correct %url', + array('%msg'=> $e->getMessage(), '%url' => $taxoniri[0]['value'])),'error'); return; } - $entity->set('field_dwc_scientificname', $taxon->data_arr['nameComplete']); - $entity->set('field_dwc_specificepithet', $taxon->data_arr['specificEpithet']); - $entity->set('field_dwc_genus', $taxon->data_arr['genusPart']); - // todo translate - $title = $taxon->data_arr['nameComplete'] . ' - ' . $geo->data_arr['name']; + $entity->set('field_dwc_scientificname', $taxon->getValue('canonicalName')); + $name_arr = explode(' ', $taxon->getValue('canonicalName')); + $entity->set('field_dwc_specificepithet', $name_arr[1]); + $entity->set('field_dwc_kingdom', $taxon->getValue('kingdom')); + $entity->set('field_dwc_genus', $taxon->getValue('genus')); + $entity->set('field_dwc_phylum', $taxon->getValue('phylum')); + $entity->set('field_dwc_order', $taxon->getValue('order')); + $entity->set('field_dwc_family', $taxon->getValue('family')); + $entity->set('field_dwc_vernacularname', $taxon->getValue('vernacularName')); + + $title = $taxon->getValue('canonicalName') . ' - ' . $geo->getValue('name'); if(!empty($title)) { - $entity->setTitle( $taxon->data_arr['nameComplete'] . ' - ' . $geo->data_arr['name']); + $entity->setTitle($title); } } } + + + diff --git a/islandora_herbarium_object.services.yml b/islandora_herbarium_object.services.yml index 9a55ce4..2097dce 100644 --- a/islandora_herbarium_object.services.yml +++ b/islandora_herbarium_object.services.yml @@ -1,5 +1,5 @@ services: islandora_herbarium_object.taxonparser: - class: Drupal\islandora_herbarium_object\DataParser\IpniParser + class: Drupal\islandora_herbarium_object\DataParser\GbifParser islandora_herbarium_object.geoparser: class: Drupal\islandora_herbarium_object\DataParser\GeonamesParser diff --git a/src/DataParser/DataParser.php b/src/DataParser/DataParser.php index 5d8b207..cf89bed 100644 --- a/src/DataParser/DataParser.php +++ b/src/DataParser/DataParser.php @@ -14,17 +14,18 @@ abstract class DataParser implements DataParserInterface public $data; public $data_arr = array(); - public function getXmlNodeValue($xml_doc, $element_name) - { - $this->data_arr[$element_name] = $xml_doc->getElementsByTagName($element_name)[0]->nodeValue; - } - public function getRemoteData($uri) { $client = \Drupal::httpClient(); $request = $client->get(trim($uri)); $data = $request->getBody()->getContents(); + if(empty($data)) { + throw new Exception("Empty dataset"); + } $this->data = $data; } + public function getValue($key) { + return isset($this->data_arr[$key]) ? $this->data_arr[$key] : ""; + } } diff --git a/src/DataParser/DataParserInterface.php b/src/DataParser/DataParserInterface.php index 17d4f10..f39ace0 100644 --- a/src/DataParser/DataParserInterface.php +++ b/src/DataParser/DataParserInterface.php @@ -12,10 +12,15 @@ namespace Drupal\islandora_herbarium_object\DataParser; interface DataParserInterface { - public function getXmlNodeValue($xml_doc, $element_name); - - public function getRemoteData($uri) ; + public function getRemoteData($uri); public function parseData(); + /** + * Gets the value from an array based on it's key, elimnates warnings if key does not exist. + * @param $arr + * @param $key + */ + public function getValue($key); + } diff --git a/src/DataParser/GbifParser.php b/src/DataParser/GbifParser.php new file mode 100644 index 0000000..27fcefd --- /dev/null +++ b/src/DataParser/GbifParser.php @@ -0,0 +1,22 @@ +data, TRUE); + if(empty($arr['results'])) { + throw new \Exception('Error parsing json data.'); + } + $this->data_arr = reset($arr['results']); + } + +} diff --git a/src/DataParser/GeonamesParser.php b/src/DataParser/GeonamesParser.php index 321b45b..b0594d7 100644 --- a/src/DataParser/GeonamesParser.php +++ b/src/DataParser/GeonamesParser.php @@ -9,13 +9,15 @@ namespace Drupal\islandora_herbarium_object\DataParser; -class GeonamesParser extends DataParser +class GeonamesParser extends XmlDataParser { public function parseData() { $xml_doc = new \DOMDocument(); - $xml_doc->loadXML($this->data); + if(empty($xml_doc->loadXML($this->data))) { + throw new \Exception('Failed loading data as xml'); + } $this->getXmlNodeValue($xml_doc, 'toponymName'); $this->getXmlNodeValue($xml_doc, 'name'); $this->getXmlNodeValue($xml_doc, 'lat'); diff --git a/src/DataParser/IpniParser.php b/src/DataParser/IpniParser.php index f8e9019..2044464 100644 --- a/src/DataParser/IpniParser.php +++ b/src/DataParser/IpniParser.php @@ -9,7 +9,7 @@ namespace Drupal\islandora_herbarium_object\DataParser; -class IpniParser extends DataParser +class IpniParser extends XmlDataParser { public function parseData() { $xml_doc = new \DOMDocument(); diff --git a/src/DataParser/XmlDataParser.php b/src/DataParser/XmlDataParser.php new file mode 100644 index 0000000..81054ee --- /dev/null +++ b/src/DataParser/XmlDataParser.php @@ -0,0 +1,18 @@ +data_arr[$element_name] = $xml_doc->getElementsByTagName($element_name)[0]->nodeValue; + } +}