Skip to content

Update EDTFYear.php to handle multi valued fields #149

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
seth-shaw-asu merged 1 commit into from
Aug 28, 2025
Merged

Update EDTFYear.php to handle multi valued fields #149

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
177 changes: 92 additions & 85 deletions src/Plugin/search_api/processor/EDTFYear.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,124 +138,131 @@ public function validateConfigurationForm(array &$form, FormStateInterface $form
*/
public function addFieldValues(ItemInterface $item) {
$entity = $item->getOriginalObject()->getValue();

foreach ($this->configuration['fields'] as $field) {
[$entityType, $bundle, $field_name] = explode('|', $field, 3);

$edtf_values = [];

if ($entityType === 'paragraph') {
$edtf = $this->getDateFromParagraphField($entity, $bundle, $field_name);
$edtf_values = $this->getDatesFromParagraphField($entity, $bundle, $field_name);
}
elseif ($entity->getEntityTypeId() == $entityType
&& $entity->bundle() == $bundle
&& $entity->hasField($field_name)
&& !$entity->get($field_name)->isEmpty()) {
$edtf = trim($entity->get($field_name)->value);
elseif (
$entity->getEntityTypeId() == $entityType &&
$entity->bundle() == $bundle &&
$entity->hasField($field_name) &&
!$entity->get($field_name)->isEmpty()
) {
foreach ($entity->get($field_name) as $item_value) {
if (!empty($item_value->value)) {
$edtf_values[] = trim($item_value->value);
}
}
}
else {
continue;

foreach ($edtf_values as $edtf) {
$this->processEdtfValue($edtf, $entity, $item);
}
}
}

/**
* Process a single EDTF value into years and add to index.
*/
private function processEdtfValue(string $edtf, EntityInterface $entity, ItemInterface $item) {
if ($edtf != "nan" && empty(EDTFUtils::validate($edtf))) {
if ($this->configuration['ignore_undated'] && $edtf == "XXXX") {
return;
}
try {
$parser = EdtfFactory::newParser();
$years = [];

if ($edtf != "nan" && empty(EDTFUtils::validate($edtf))) {
if ($this->configuration['ignore_undated'] && $edtf == "XXXX") {
continue;
if (strpos($edtf, '[') !== FALSE || strpos($edtf, '{') !== FALSE) {
$dates = $parser->parse($edtf)->getEdtfValue();
$years = array_map(function ($date) {
return $date->getYear();
}, $dates->getDates());
}
try {
$parser = EdtfFactory::newParser();
$years = [];
// Sets.
if (strpos($edtf, '[') !== FALSE || strpos($edtf, '{') !== FALSE) {
$dates = $parser->parse($edtf)->getEdtfValue();
$years = array_map(function ($date) {
return $date->getYear();
}, $dates->getDates());
else {
if (substr($edtf, 0, 3) === '../') {
$edtf = $this->configuration['ignore_open_start']
? substr($edtf, 3)
: str_replace('../', $this->configuration['open_start_year'] . '/', $edtf);
}
else {
// Open start dates with `../`.
if (substr($edtf, 0, 3) === '../') {
if ($this->configuration['ignore_open_start']) {
$edtf = substr($edtf, 3);
}
else {
$edtf = str_replace('../', $this->configuration['open_start_year'] . '/', $edtf);
}
}
// Open start dates with `/`.
if (substr($edtf, 0, 1) === '/') {
if ($this->configuration['ignore_open_start']) {
$edtf = substr($edtf, 1);
}
else {
$edtf = str_replace('/', $this->configuration['open_start_year'] . '/', $edtf);
}
}
// Open end dates with `/..`.
if (substr($edtf, -3) === '/..') {
if ($this->configuration['ignore_open_end']) {
$edtf = substr($edtf, 0, -3);
}
else {
$end_year = (empty($this->configuration['open_end_year'])) ? date('Y') : $this->configuration['open_end_year'];
$edtf = str_replace('/..', '/' . $end_year, $edtf);
}
}
// Open end dates with `/`.
if (substr($edtf, -1) === '/') {
if ($this->configuration['ignore_open_end']) {
$edtf = substr($edtf, 0, -1);
}
else {
$end_year = (empty($this->configuration['open_end_year'])) ? date('Y') : $this->configuration['open_end_year'];
$edtf = str_replace('/', '/' . $end_year, $edtf);
}
}
$parsed = $parser->parse($edtf)->getEdtfValue();
$years = range(intval(date('Y', $parsed->getMin())), intval(date('Y', $parsed->getMax())));
if (substr($edtf, 0, 1) === '/') {
$edtf = $this->configuration['ignore_open_start']
? substr($edtf, 1)
: str_replace('/', $this->configuration['open_start_year'] . '/', $edtf);
}
foreach ($years as $year) {
if (is_numeric($year)) {
$fields = $item->getFields(FALSE);
$fields = $this->getFieldsHelper()
->filterForPropertyPath($fields, NULL, 'edtf_year');
foreach ($fields as $field) {
$field->addValue($year);
}
}
if (substr($edtf, -3) === '/..') {
$end_year = (empty($this->configuration['open_end_year'])) ? date('Y') : $this->configuration['open_end_year'];
$edtf = $this->configuration['ignore_open_end']
? substr($edtf, 0, -3)
: str_replace('/..', '/' . $end_year, $edtf);
}
if (substr($edtf, -1) === '/') {
$end_year = (empty($this->configuration['open_end_year'])) ? date('Y') : $this->configuration['open_end_year'];
$edtf = $this->configuration['ignore_open_end']
? substr($edtf, 0, -1)
: str_replace('/', '/' . $end_year, $edtf);
}

$parsed = $parser->parse($edtf)->getEdtfValue();
$years = range(intval(date('Y', $parsed->getMin())), intval(date('Y', $parsed->getMax())));
}
catch (\Throwable $e) {
\Drupal::logger('controlled_access_terms')
->warning(t("Could not parse EDTF value '@edtf' for indexing @type/@id",
[
'@edtf' => $edtf,
'@type' => $entity->getEntityTypeId(),
'@id' => $entity->id(),
]));

foreach ($years as $year) {
if (is_numeric($year)) {
$fields = $item->getFields(FALSE);
$fields = $this->getFieldsHelper()->filterForPropertyPath($fields, NULL, 'edtf_year');
foreach ($fields as $field) {
$field->addValue($year);
}
}
}
}
catch (\Throwable $e) {
\Drupal::logger('controlled_access_terms')
->warning(t("Could not parse EDTF value '@edtf' for indexing @type/@id", [
'@edtf' => $edtf,
'@type' => $entity->getEntityTypeId(),
'@id' => $entity->id(),
]));
}
}
}

/**
* Gets edtf date value from a referenced paragraph.
* Gets all EDTF date values from referenced paragraphs.
*/
private function getDateFromParagraphField(EntityInterface $entity, string $bundle, string $field_name) {
private function getDatesFromParagraphField(EntityInterface $entity, string $bundle, string $field_name) {
$values = [];

$query = \Drupal::entityTypeManager()
->getStorage('field_config')
->getQuery();
$query->condition('bundle', $entity->bundle());
$query->condition("settings.handler_settings.target_bundles.{$bundle}", $bundle);
$paragraph_ids = $query->execute();

if (!empty($paragraph_ids)) {
$paragraph_field_config = reset($paragraph_ids);
$paragraph_field_config_array = explode('.', $paragraph_field_config);
$paragraph_field_name = end($paragraph_field_config_array);
$paragraph_entity = $entity->get($paragraph_field_name)
Copy link
Copy Markdown
Member

@joecorall joecorall Aug 20, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

need to keep this in case $entity references a deleted paragraph

->referencedEntities()[0] ?? NULL;

if ($paragraph_entity && $paragraph_entity->hasField($field_name)
&& !$paragraph_entity->get($field_name)->isEmpty()) {
return trim($paragraph_entity->get($field_name)->value);
foreach ($entity->get($paragraph_field_name)->referencedEntities() as $paragraph_entity) {
if ($paragraph_entity->hasField($field_name) && !$paragraph_entity->get($field_name)->isEmpty()) {
foreach ($paragraph_entity->get($field_name) as $item_value) {
if (!empty($item_value->value)) {
$values[] = trim($item_value->value);
}
}
}
}
}

return $values;
}

}
Loading