
| Current Path : /var/www/html_old/abk/web/modules/contrib/content_sync/src/ |
Linux ift1.ift-informatik.de 5.4.0-216-generic #236-Ubuntu SMP Fri Apr 11 19:53:21 UTC 2025 x86_64 |
| Current File : /var/www/html_old/abk/web/modules/contrib/content_sync/src/ContentSyncHelpManagerInterface.php |
<?php
namespace Drupal\content_sync;
use Drupal\Core\Routing\RouteMatchInterface;
/**
* Defines an interface for help classes.
*/
interface ContentSyncHelpManagerInterface {
/**
* Get help.
*
* @param string|null $id
* (optional) Help id.
*
* @return array|mixed
* A single help item or all help.
*/
public function getHelp($id = NULL);
/**
* Build help for specific route.
*
* @param string $route_name
* The route for which to find help.
* @param \Drupal\Core\Routing\RouteMatchInterface $route_match
* The route match object from which to find help.
*
* @return array
* An render array containing help for specific route.
*/
public function buildHelp($route_name, RouteMatchInterface $route_match);
/**
* Build help (aka 'How can we help you?') menu (dropbutton) element.
*
* @return array
* An render array containing about (aka 'How can we help you?') operations
* (dropbutton) element.
*/
public function buildHelpMenu();
/**
* Build the main help page for the Content Sync module.
*
* @return array
* An render array containing help for the Content Sync module.
*/
public function buildIndex();
/**
* Build the about section.
*
* @return array
* An render array containing the about section.
*/
public function buildAbout();
/**
* Build the uses section.
*
* @param bool $docs
* Set to TRUE to build exportable HTML documentation.
*
* @return array
* An render array containing the uses section.
*/
public function buildUses($docs = FALSE);
}