protected function Schema::createDescription in Schemata 8

Generates a description for the schema based on the types.

Parameters

string $entityType: Required entity type which the schema defines.

string $bundle: Optional value to be separated from the required prefix if present.

Return value

string The description value.

2 calls to Schema::createDescription()

NodeSchema::createDescription in src/Schema/NodeSchema.php

Generates a description for the schema based on the types.

Schema::__construct in src/Schema/Schema.php

Creates a Schema object.

1 method overrides Schema::createDescription()

NodeSchema::createDescription in src/Schema/NodeSchema.php

Generates a description for the schema based on the types.

File

src/Schema/Schema.php, line 159

Class

Schema

Schema class that describes a Drupal Entity or Entity Type.

Namespace

Drupal\schemata\Schema

Code

protected function createDescription($entityType, $bundle = '') {
  $output = "Describes the payload for '{$entityType}' entities";
  if (!empty($bundle)) {
    $output .= " of the '{$bundle}' bundle.";
  }
  else {
    $output .= '.';
  }
  return $output;
}