function hosting_node_help in Hosting 5

Same name and namespace in other branches

1. 6.2 hosting.module \hosting_node_help()
2. 7.4 hosting.module \hosting_node_help()
3. 7.3 hosting.module \hosting_node_help()

Per node type description text. To be stored in the node_type table.

Parameters

type: The node type.

Return value

Description text for the node type.

6 calls to hosting_node_help()

hosting_client_node_info in client/hosting_client.module

hosting_db_server_node_info in db_server/hosting_db_server.module

hosting_platform_node_info in platform/hosting_platform.module

@file Platform node type definition

hosting_site_node_info in site/hosting_site.module

Implementation of hook_node_info

hosting_web_server_node_info in web_server/hosting_web_server.module

... See full list

File

./hosting_help.inc, line 262

Hosting help subsystem

Code

function hosting_node_help($type) {
  switch ($type) {
    case 'site':
      return t("<strong>An instance of a hosted site.</strong>\n                It contains information relating to the site, most notably the domain name, database server \n                and platform it is being published on. A site may also have several aliases for additional\n                domains the site needs to be accessible on.");
      break;
    case 'platform':
      return t("<strong>The file system location on a specific web server on which to publish sites.</strong>\n                Multiple platforms can co-exist on the same web server, and need to do so for\n                upgrades to be managed, as this is accomplished by moving the site a platform\n                hosting an updated release.\n                Platforms are most commonly built for specific releases of Drupal.");
      break;
    case 'client':
      return t("<strong>The person or group that runs the site.</strong> \n                This information is usually required for billing and access purposes, to assure\n                that only certain people are able to view the information for sites they run. \n                If you do not intend on having more than one client access the system, \n                you will not need to create any additional clients for your purposes.");
      break;
    case 'web_server':
      return t("<strong>The physical machine where files will be stored for publication.</strong>\n                Each web server hosts one or more platforms, which act as publishing points for the hosted sites.\n                If you are not intending to use Hostmaster in a distributed fashion, you will not need to create\n                additional web servers for your purposes..");
      break;
    case 'db_server':
      return t("<strong>The database server on which sites will host their date.</strong>\n                Most web servers and database servers are on the same machine, but for performance reasons \n                external database servers might be required. It is not uncommon for one database server\n                to be shared amongst all site instances.\n                If you are not intending to use an external database server, or multiple database servers, you\n                will not need to create any additional database servers for your purposes.");
      break;
    case 'task':
      return t("<strong>The mechanism whereby Hostmaster keeps track of all changes that occurr to the system.</strong>\n                Each task acts as a command for the back end, and contains a full log of all changes that have occurred.\n                If an task should fail, the administrator will be notified with an explanation of exactly what went wrong,\n                and how to fix it.");
      break;
  }
}