entity_hierarchy-8.x-2.24/modules/entity_hierarchy_microsite/src/Entity/MicrositeInterface.php

<?php

namespace Drupal\entity_hierarchy_microsite\Entity;

use Drupal\Core\Entity\ContentEntityInterface;
use Drupal\node\Entity\Node as DrupalNode;
use PNX\NestedSet\Node;

/**
 * Defines an interface for microsites.
 */
interface MicrositeInterface extends ContentEntityInterface {

  /**
   * Gets the home page of the microsite.
   *
   * @return \Drupal\node\NodeInterface|null
   *   Home page node, or null if none exists.
   */
  public function getHome();

  /**
   * Gets the logo of the microsite.
   *
   * @return \Drupal\media\MediaInterface|null
   *   Logo media, or null if none exists.
   */
  public function getLogo();

  /**
   * Whether the microsite should generate a menu.
   *
   * @return bool
   *   True if a menu should be built, false otherwise.
   */
  public function shouldGenerateMenu();

  /**
   * Allows a microsite sub-class to modify plugin definitions.
   *
   * @param \PNX\NestedSet\Node $treeNode
   *   Tree node for this menu plugin definition.
   * @param \Drupal\node\Entity\Node $node
   *   Drupal node for the menu plugin definition.
   * @param array $definition
   *   Menu plugin definition. This should be modified and returned.
   * @param \PNX\NestedSet\Node $homeNode
   *   Tree node for the microsite home.
   *
   * @return array
   *   Modified menu plugin definition. To prevent the menu link from being
   *   created, return an empty array.
   */
  public function modifyMenuPluginDefinition(Node $treeNode, DrupalNode $node, array $definition, Node $homeNode): array;

}