class Book in Schema.org Metatag 8.2
Provides a plugin for the 'Book' Schema.org property type.
Plugin annotation
@SchemaPropertyType(
id = "book",
label = @Translation("Book"),
tree_parent = {
"Book",
},
tree_depth = 0,
property_type = "Book",
sub_properties = {
"@type" = {
"id" = "type",
"label" = @Translation("@type"),
"description" = "",
},
"isbn" = {
"id" = "text",
"label" = @Translation("isbn"),
"description" = @Translation(""),
},
"bookEdition" = {
"id" = "text",
"label" = @Translation("bookEdition"),
"description" = @Translation("The edition of the book."),
},
"bookFormat" = {
"id" = "text",
"label" = @Translation("bookFormat"),
"description" = @Translation("The format of the book (comma-separated), i.e. https://schema.org/Hardcover,https://schema.org/Paperback,https://schema.org/EBook"),
},
"author" = {
"id" = "person",
"label" = @Translation("author"),
"description" = @Translation("The author of the work."),
"tree_parent" = {
"Person",
},
"tree_depth" = 0,
},
"potentialAction" = {
"id" = "action",
"label" = @Translation("potentialAction"),
"description" = @Translation("Potential action for the work, like a ReadAction."),
"tree_parent" = {
"ReadAction",
},
"tree_depth" = 0,
},
"name" = {
"id" = "text",
"label" = @Translation("name"),
"description" = @Translation("The name of the work."),
},
"url" = {
"id" = "url",
"label" = @Translation("url"),
"description" = @Translation("Absolute URL of the canonical Web page for the work."),
},
"sameAs" = {
"id" = "url",
"label" = @Translation("sameAs"),
"description" = @Translation("Urls and social media links, comma-separated list of absolute URLs."),
},
"datePublished" = {
"id" = "date",
"label" = @Translation("datePublished"),
"description" = @Translation("Publication date."),
},
},
)
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\schema_metatag\Plugin\schema_metatag\PropertyTypeBase implements ContainerFactoryPluginInterface, PropertyTypeInterface, SchemaMetatagTestTagInterface uses StringTranslationTrait
- class \Drupal\schema_metatag\Plugin\schema_metatag\PropertyType\Book
- class \Drupal\schema_metatag\Plugin\schema_metatag\PropertyTypeBase implements ContainerFactoryPluginInterface, PropertyTypeInterface, SchemaMetatagTestTagInterface uses StringTranslationTrait
Expanded class hierarchy of Book
1 string reference to 'Book'
- SchemaMetatagManagerTest::arrayData in tests/
src/ Unit/ SchemaMetatagManagerTest.php - Provides array data.
File
- src/
Plugin/ schema_metatag/ PropertyType/ Book.php, line 80
Namespace
Drupal\schema_metatag\Plugin\schema_metatag\PropertyTypeView source
class Book extends PropertyTypeBase {
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
protected | property | The plugin implementation definition. | 1 |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function |
Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
3 |
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
PluginBase:: |
public | function | Constructs a \Drupal\Component\Plugin\PluginBase object. | 92 |
PropertyTypeBase:: |
protected | property | The propertyTypeManager service. | |
PropertyTypeBase:: |
protected | property | The SchemaMetatagClient service. | |
PropertyTypeBase:: |
protected | property | The schemaMetatagManager service. | |
PropertyTypeBase:: |
public static | function |
Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface:: |
|
PropertyTypeBase:: |
public | function |
Create a complete form element for this property type. Overrides PropertyTypeInterface:: |
1 |
PropertyTypeBase:: |
public | function |
A property form element. Overrides PropertyTypeInterface:: |
5 |
PropertyTypeBase:: |
public | function |
Get an instance of a child property type. Overrides PropertyTypeInterface:: |
|
PropertyTypeBase:: |
public | function |
Create an option list for a given tree section. Overrides PropertyTypeInterface:: |
|
PropertyTypeBase:: |
public | function |
The property type. Overrides PropertyTypeInterface:: |
|
PropertyTypeBase:: |
public | function |
The sub-properties. Overrides PropertyTypeInterface:: |
|
PropertyTypeBase:: |
public | function |
Get some or all of the object tree as options for @type. Overrides PropertyTypeInterface:: |
|
PropertyTypeBase:: |
public | function |
The depth of the class tree to use for @type options. Overrides PropertyTypeInterface:: |
|
PropertyTypeBase:: |
public | function |
The classes to use for the @type options of this property. Overrides PropertyTypeInterface:: |
|
PropertyTypeBase:: |
public | function |
Construct the visibility selector for a set of values. Overrides PropertyTypeInterface:: |
|
PropertyTypeBase:: |
public | function |
Transform input value to its display output. Overrides PropertyTypeInterface:: |
2 |
PropertyTypeBase:: |
public | function |
Pivot form element. Overrides PropertyTypeInterface:: |
|
PropertyTypeBase:: |
public | function |
Provide a test output value for the input value. Overrides SchemaMetatagTestTagInterface:: |
|
PropertyTypeBase:: |
public | function |
Explode a test value. Overrides SchemaMetatagTestTagInterface:: |
|
PropertyTypeBase:: |
public | function |
Get all the properties of a property type. Overrides PropertyTypeInterface:: |
|
PropertyTypeBase:: |
public | function |
The Schema Metatag Client service. Overrides PropertyTypeInterface:: |
|
PropertyTypeBase:: |
public | function |
The Schema Metatag Manager service. Overrides PropertyTypeInterface:: |
|
PropertyTypeBase:: |
public | function | Sets PropertyTypeManager service. | |
PropertyTypeBase:: |
public | function | Sets SchemaMetatagClient service. | |
PropertyTypeBase:: |
public | function | Sets schemaMetatagManager service. | |
PropertyTypeBase:: |
public | function |
Provide a random test value. Overrides SchemaMetatagTestTagInterface:: |
|
PropertyTypeBase:: |
public | function |
Provide a test input value for the property that will validate. Overrides SchemaMetatagTestTagInterface:: |
3 |
PropertyTypeBase:: |
public static | function |
Validates the property form when submitted. Overrides PropertyTypeInterface:: |
|
StringTranslationTrait:: |
protected | property | The string translation service. | 1 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. |