Skip to content

Commit

Permalink
VACMS-13613 and 8017 Add PostFacilityBase methods
Browse files Browse the repository at this point in the history 
These methods are not being used yet, but they will be used by two
different PRs for Lighthouse that we can not control when they
will land.  Adding these here now in andvance helps avoid conflct.
  • Loading branch information
@swirtSJW
swirtSJW committed May 22, 2023
1 parent 48088ea commit c03e548
Show file tree
Hide file tree
Showing 2 changed files with 237 additions and 24 deletions.
236 changes: 236 additions & 0 deletions docroot/modules/custom/va_gov_post_api/src/Service/PostFacilityBase.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
use Drupal\Core\Messenger\MessengerInterface;
use Drupal\Core\StringTranslation\StringTranslationTrait;
use Drupal\node\NodeInterface;
use Drupal\office_hours\OfficeHoursDateHelper;
use Drupal\post_api\Service\AddToQueue;
use Drupal\va_gov_lovell\LovellOps;

Expand Down Expand Up @@ -97,6 +98,29 @@ protected function shouldDedupe() : bool {
return !$this->shouldBypass();
}

/**
* Get operating status details, shortened as necessary.
*
* @return string
* Details of operating status.
*/
protected function getOperatingStatusMoreInfoShort() : ?string {
$operatingStatusMoreInfo = $this->facilityNode->get('field_operating_status_more_info')->value;
if ($operatingStatusMoreInfo) {
$operatingStatusMoreInfo = $this->facilityNode->get('field_operating_status_more_info')->value;
$operatingStatusMoreInfoJson = json_encode($this->facilityNode->get('field_operating_status_more_info')->value);
$operatingStatusMoreInfoLength = mb_strlen($operatingStatusMoreInfoJson);
// 300 is the character limit for field_operating_status_facility
// let's do our best to trim this down if we need to
if ($operatingStatusMoreInfoLength > 300) {
$operatingStatusMoreInfo = str_replace(' ', ' ', $operatingStatusMoreInfo);
$operatingStatusMoreInfo = trim($operatingStatusMoreInfo);
$operatingStatusMoreInfo = preg_replace("/(\r?\n|\r)+/", " ", $operatingStatusMoreInfo);
}
}
return $operatingStatusMoreInfo;
}

/**
* Checks if the entity is within the Lovell Tricare section.
*
Expand All @@ -116,4 +140,216 @@ protected function isLovellTricareSection(EntityInterface $entity) : bool {
return FALSE;
}

/**
* Get address from an address field.
*
* @param mixed $addresses_field
* The field value of the address field.
*
* @return array|object|null
* Array of addresses if there are multiple. Object if 1, NULL if none.
*/
protected function getAddresses($addresses_field) {
$return_addresses = NULL;
$addresses = $addresses_field->getValue();
if (!empty($addresses) && is_array($addresses)) {
$return_addresses = [];
foreach ($addresses as $address) {
if (!empty($address)) {
$return_address = new \stdClass();
$return_address->address_organization = $address['organization'] ?? '';
$return_address->address_line1 = $address['address_line1'] ?? '';
$return_address->address_line2 = $address['address_line2'] ?? '';
$return_address->city = $address['locality'] ?? '';
$return_address->state = $address['administrative_area'] ?? '';
$return_address->country_code = $address['country_code'] ?? '';
$return_address->zip_code = $address['postal_code'] ?? '';
$return_addresses[] = $return_address;
}
}
}
// If there are more than one, return them in an array.
return (count($return_addresses) > 1) ? $return_addresses : $return_addresses[0];
}

/**
* Gets the service hours with fallback to facility.
*
* @param array $office_hours
* Office hours values to extract days from.
*
* @return object
* An object of days of the week with hours strings.
*/
protected function getServiceHours(array $office_hours = []): object {
if (empty($office_hours)) {
$office_hours = $this->facility->get('field_office_hours')->getValue();
}
$hours = new \stdClass();
$hours->monday = $this->getDay(0, $office_hours);
$hours->tuesday = $this->getDay(1, $office_hours);
$hours->wednesday = $this->getDay(2, $office_hours);
$hours->thursday = $this->getDay(3, $office_hours);
$hours->friday = $this->getDay(4, $office_hours);
$hours->saturday = $this->getDay(5, $office_hours);
$hours->sunday = $this->getDay(6, $office_hours);

return $hours;
}

/**
* Gets the string for a given day.
*
* @param int $day_num
* Number 0-6 specifying which day to return.
* @param array $days
* The array of days data.
*
* @return string
* a sting made up of start and end times with comment, or just comment.
*/
protected function getDay($day_num, array $days): string {
$start = (!empty($days[$day_num]['starthours'])) ? OfficeHoursDateHelper::format($days[$day_num]['starthours'], 'h:i a') : '';
$end = (!empty($days[$day_num]['endhours'])) ? OfficeHoursDateHelper::format($days[$day_num]['endhours'], 'h:i a') : '';
// Make sure there is no end if there is no start. Data error.
$end = empty($start) ? '' : $end;
$start = $this->normalizeTime($start);
$end = $this->normalizeTime($end);
$comment = $days[$day_num]['comment'] ?? '';
$comment = $this->normalizeHoursComment($comment);
if (!empty($start) && !empty($end) && !empty($comment)) {
$day_entry = "{$start} to {$end} {$comment}";
}
elseif (!empty($start) && empty($end) && !empty($comment)) {
$day_entry = "{$start} to {$comment}";
}
elseif (!empty($start) && !empty($end) && empty($comment)) {
$day_entry = "{$start} to {$end}";
}
else {
$day_entry = $comment;
}

return trim($day_entry);
}

/**
* Perform processes on a comment to make it normal.
*
* @param string $comment
* A comment to normalize.
*
* @return string
* A normalized comment.
*/
protected function normalizeHoursComment(string $comment): string {
$comment = trim($comment);
// There will be more processes coming here.
return $comment;
}

/**
* Perform alterations to a time string to make normal.
*
* @param string $time
* A formatted time string.
*
* @return string
* The normalized string.
*/
protected function normalizeTime(string $time): string {
$time = trim($time);
// Make am pm follow design.va.gov.
$replacements = [
'am' => 'a.m.',
'AM' => 'a.m.',
'A.M.' => 'a.m.',
'pm' => 'p.m.',
'PM' => 'p.m.',
'P.M.' => 'p.m.',
];
$time = str_replace(array_keys($replacements), array_values($replacements), $time);
$time = $this->midnightNoonify($time);
return $time;
}

/**
* Convert noon or midnight to those terms.
*
* @param string $time
* A time including am or pm.
*
* @return string
* The time passed in or 'noon' or 'midnight'.
*/
protected function midnightNoonify(string $time): string {
$time = trim($time);
if ($time === '12:00 am' || $time === '12:00 a.m.') {
$time = 'noon';
}
elseif ($time === '12:00 pm' || $time === '12:00 p.m.') {
$time = 'midnight';
}
return $time;
}

/**
* Converts a string to an html id the same way content-build does.
*
* @param string $string
* A string to convert to an id.
*
* @return string
* A string matching what the FE will do to make an html id.
*
* @see https://github.com/department-of-veterans-affairs/content-build/blob/main/src/site/stages/build/plugins/modify-dom/add-id-to-subheadings.js#L9-L17
*/
public function getFrontEndFragment($string = ''): string {
$string = trim($string);
$string = mb_strtolower($string);
$string = preg_replace('/[^\w\- ]+/', '', $string);
$string = preg_replace('/\s/', '-', $string);
$string = preg_replace('/-+$/', '', $string);
$string = mb_substr($string, 0, 30);
$string = (!empty($string)) ? "#{$string}" : '';

return $string;
}

/**
* Gets the facility locations page with name fragment of facility.
*
* @param Drupal\node\NodeInterface $facility
* The facility whose parent needs a link.
*
* @return string|null
* String of the url of the parent's location page or NULL if no parent.
*/
public function getParentLocationsPageUrl(NodeInterface $facility): string | null {
$url = NULL;
if ($facility->hasField('field_office')) {
$referenced_entities = $facility->get('field_office')->referencedEntities();
if (!empty($referenced_entities[0])) {
$parentFacility = $referenced_entities[0];
$parent_slug = $parentFacility->toUrl()->toString();
$name_fragment = $this->getFrontEndFragment($facility->getTitle());
$url = "https://www.va.gov{$parent_slug}/locations/{$name_fragment}";
}
}
return $url;
}

/**
* Converts any empty string to NULL.
*
* @param string|null $string
* Any possible value to evaluate.
*
* @return string|null
* String if the value is not empty, NULL otherwise.
*/
protected function stringNullify($string) {
return (empty($string)) ? NULL : $string;
}

}
25 changes: 1 addition & 24 deletions docroot/modules/custom/va_gov_post_api/src/Service/PostFacilityStatus.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ class PostFacilityStatus extends PostFacilityBase {
protected $additionalInfoToPush;

/**
* The services that should be pushed to Lighthouse.
* The facilities that have services pushed to Lighthouse.
*
* For now we are only pushing covid 19 services. The key is only for
* making sense of code, the TID is what is used for comparison.
Expand Down Expand Up @@ -222,29 +222,6 @@ protected function getFacilityUrl(): string | null {
return $facility_url;
}

/**
* Get operating status details, shortened as necessary.
*
* @return string
* Details of operating status.
*/
protected function getOperatingStatusMoreInfoShort() : ?string {
$operatingStatusMoreInfo = $this->facilityNode->get('field_operating_status_more_info')->value;
if ($operatingStatusMoreInfo) {
$operatingStatusMoreInfo = $this->facilityNode->get('field_operating_status_more_info')->value;
$operatingStatusMoreInfoJson = json_encode($this->facilityNode->get('field_operating_status_more_info')->value);
$operatingStatusMoreInfoLength = mb_strlen($operatingStatusMoreInfoJson);
// 300 is the character limit for field_operating_status_facility
// let's do our best to trim this down if we need to
if ($operatingStatusMoreInfoLength > 300) {
$operatingStatusMoreInfo = str_replace(' ', ' ', $operatingStatusMoreInfo);
$operatingStatusMoreInfo = trim($operatingStatusMoreInfo);
$operatingStatusMoreInfo = preg_replace("/(\r?\n|\r)+/", " ", $operatingStatusMoreInfo);
}
}
return $operatingStatusMoreInfo;
}

/**
* Update payload array with supplemental status.
*
Expand Down

0 comments on commit c03e548

Please sign in to comment.