Skip to content
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

[SD-360] Refactor ::getHierarchy #543

Merged
merged 2 commits into from
Nov 25, 2024
Merged

[SD-360] Refactor ::getHierarchy #543

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0f81655
[SD-360] Refactor ::getHierarchy
vincent-gao Nov 21, 2024
e3da440
fixes unwanted flatten results
vincent-gao Nov 25, 2024
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
89 changes: 70 additions & 19 deletions modules/tide_publication/src/Controller/PublicationResource.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
use Drupal\jsonapi\JsonApiResource\Link;
use Drupal\jsonapi\JsonApiResource\LinkCollection;
use Drupal\jsonapi\Routing\Routes;
use Drupal\taxonomy\TermInterface;
use Symfony\Component\DependencyInjection\ContainerAwareTrait;
use Symfony\Component\HttpFoundation\JsonResponse;
use Symfony\Component\HttpFoundation\Request;
Expand Down Expand Up @@ -181,53 +182,103 @@ public function getHierarchy(EntityInterface $entity, Request $request) {
* The hierarchy.
*/
protected function buildHierarchy(ContentEntityInterface $entity, NestedSetStorage $storage, CacheableMetadata $cache, $weight, array &$flatten_hierarchy, $site = NULL) {
$resource_type = $this->resourceTypeRepository->get($entity->getEntityTypeId(), $entity->bundle());
// Try cache first.
$cid = "tide_publication:hierarchy:{$entity->uuid()}:{$weight}:" . ($site ? $site->id() : 'null');
Copy link
Contributor

Choose a reason for hiding this comment

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

Why do these get surrounded by {}?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hi @anthony-malkoun , it just clearly defines variable boundary in this string.

if ($cached = $this->cacheData->get($cid)) {
return $cached->data;
}

// Build basic node data.
$hierarchy = $this->buildNodeData($entity, $weight);
$flatten_hierarchy[] = $this->buildFlattenData($entity, $weight);

// Handle site-specific URL.
if ($site) {
$this->adjustSiteUrl($hierarchy, $entity, $site);
}

// Process children.
$children = $this->loadChildren($storage, $entity, $cache);
if (!empty($children)) {
$hierarchy['children'] = [];
foreach ($children as $child_weight => $child_entity) {
$child_hierarchy = $this->buildHierarchy(
$child_entity,
$storage,
$cache,
$child_weight,
$flatten_hierarchy,
$site
);
if ($child_hierarchy) {
$hierarchy['children'][] = $child_hierarchy;
}
}
}

$hierarchy = [
$this->cacheData->set($cid, $hierarchy, $cache->getCacheMaxAge(), $cache->getCacheTags());

return $hierarchy;
}

/**
* Build the node data.
*/
protected function buildNodeData(ContentEntityInterface $entity, $weight) {
$resource_type = $this->resourceTypeRepository->get($entity->getEntityTypeId(), $entity->bundle());
return [
'id' => $entity->uuid(),
'type' => $resource_type->getTypeName(),
'entity_id' => $entity->id(),
'title' => $entity->label(),
'url' => $entity->toUrl('canonical')->toString(),
'weight' => $weight,
];
}

$flatten_hierarchy[] = [
/**
* Build the flatten data.
*/
protected function buildFlattenData(ContentEntityInterface $entity, $weight) {
return [
'entity_id' => $entity->id(),
'revision_id' => $entity->getRevisionId(),
'bundle' => $entity->bundle(),
'uuid' => $entity->uuid(),
'weight' => $weight,
];
}

if ($site) {
/** @var \Drupal\tide_site\TideSiteHelper $site_helper */
$site_helper = $this->container->get('tide_site.helper');
if (!$site_helper->isEntityBelongToSite($entity, $site->id())) {
$hierarchy['url'] = $site_helper->getNodeUrlFromPrimarySite($entity);
}
/**
* Adjust the URL to the site-specific URL.
*/
protected function adjustSiteUrl(array &$hierarchy, ContentEntityInterface $entity, TermInterface $site) {
/** @var \Drupal\tide_site\TideSiteHelper $site_helper */
$site_helper = $this->container->get('tide_site.helper');
if (!$site_helper->isEntityBelongToSite($entity, $site->id())) {
$hierarchy['url'] = $site_helper->getNodeUrlFromPrimarySite($entity);
}
}

/** @var \PNX\NestedSet\NestedSetInterface $storage */
/** @var \PNX\NestedSet\Node[] $children */
/**
* Load children of a node.
*/
protected function loadChildren(NestedSetStorage $storage, ContentEntityInterface $entity, CacheableMetadata $cache) {
$children = $storage->findChildren($this->nestedSetNodeKeyFactory->fromEntity($entity));
$child_entities = $this->entityTreeNodeMapper->loadAndAccessCheckEntitysForTreeNodes('node', $children, $cache);

$valid_children = [];
foreach ($children as $child_weight => $nested_node) {
if (!$child_entities->contains($nested_node)) {
// Doesn't exist or is access hidden.
continue;
}
/** @var \Drupal\Core\Entity\ContentEntityInterface $child_entity */
$child_entity = $child_entities->offsetGet($nested_node);
if (!$child_entity->isDefaultRevision()) {
continue;
if ($child_entity->isDefaultRevision()) {
$valid_children[$child_weight] = $child_entity;
}

$cache->addCacheableDependency($child_entity);
$hierarchy['children'][] = $this->buildHierarchy($child_entity, $storage, $cache, $child_weight, $flatten_hierarchy, $site);
}

return $hierarchy;
return $valid_children;
}

}
Loading