class WorkspacePublisher implements WorkspacePublisherInterface (View source)

internal  
 

Default implementation of the workspace publisher.

Traits

Wrapper methods for \Drupal\Core\StringTranslation\TranslationInterface.

Properties

protected TranslationInterface $stringTranslation

The string translation service.

from  StringTranslationTrait
protected WorkspaceInterface $sourceWorkspace

The source workspace entity.

protected EntityTypeManagerInterface $entityTypeManager

The entity type manager.

protected Connection $database

The database connection.

protected WorkspaceManagerInterface $workspaceManager

The workspace manager.

protected WorkspaceAssociationInterface $workspaceAssociation

The workspace association service.

Methods

t(string $string, array $args = [], array $options = [])

Translates a string to the current language or to a given language.

formatPlural($count, $singular, $plural, array $args = [], array $options = [])

Formats a string containing a count of items.

getNumberOfPlurals($langcode = NULL)

Returns the number of plurals supported by a given language.

getStringTranslation()

Gets the string translation service.

$this
setStringTranslation(TranslationInterface $translation)

Sets the string translation service to use.

__construct(EntityTypeManagerInterface $entity_type_manager, Connection $database, WorkspaceManagerInterface $workspace_manager, WorkspaceAssociationInterface $workspace_association, WorkspaceInterface $source)

Constructs a new WorkspacePublisher.

publish()

Publishes the contents of a workspace to the default (Live) workspace.

string
getSourceLabel()

Returns the human-readable label of the source.

string
getTargetLabel()

Returns the human-readable label of the target.

array
checkConflictsOnTarget()

Checks if there are any conflicts between the source and the target.

array
getDifferringRevisionIdsOnTarget()

Gets the revision identifiers for items which have changed on the target.

array
getDifferringRevisionIdsOnSource()

Gets the revision identifiers for items which have changed on the source.

int
getNumberOfChangesOnTarget()

Gets the total number of items which have changed on the target.

int
getNumberOfChangesOnSource()

Gets the total number of items which have changed on the source.

Details

protected TranslatableMarkup t(string $string, array $args = [], array $options = [])

Translates a string to the current language or to a given language.

See \Drupal\Core\StringTranslation\TranslatableMarkup::__construct() for important security information and usage guidelines.

In order for strings to be localized, make them available in one of the ways supported by the

Parameters

string $string

A string containing the English text to translate.

array $args

(optional) An associative array of replacements to make after translation. Based on the first character of the key, the value is escaped and/or themed. See \Drupal\Component\Render\FormattableMarkup::placeholderFormat() for details.

array $options

(optional) An associative array of additional options, with the following elements:

  • 'langcode' (defaults to the current language): A language code, to translate to a language other than what is used to display the page.
  • 'context' (defaults to the empty context): The context the source string belongs to. See the @link i18n Internationalization topic @endlink for more information about string contexts.

Return Value

TranslatableMarkup

An object that, when cast to a string, returns the translated string.

See also

FormattableMarkup::placeholderFormat
TranslatableMarkup::__construct

protected formatPlural($count, $singular, $plural, array $args = [], array $options = [])

Formats a string containing a count of items.

Parameters

$count
$singular
$plural
array $args
array $options

See also

TranslationInterface::formatPlural

protected getNumberOfPlurals($langcode = NULL)

Returns the number of plurals supported by a given language.

Parameters

$langcode

See also

PluralFormulaInterface::getNumberOfPlurals

protected TranslationInterface getStringTranslation()

Gets the string translation service.

Return Value

TranslationInterface

The string translation service.

$this setStringTranslation(TranslationInterface $translation)

Sets the string translation service to use.

Parameters

TranslationInterface $translation

The string translation service.

Return Value

$this

__construct(EntityTypeManagerInterface $entity_type_manager, Connection $database, WorkspaceManagerInterface $workspace_manager, WorkspaceAssociationInterface $workspace_association, WorkspaceInterface $source)

Constructs a new WorkspacePublisher.

Parameters

EntityTypeManagerInterface $entity_type_manager

The entity type manager.

Connection $database

Database connection.

WorkspaceManagerInterface $workspace_manager

The workspace manager.

WorkspaceAssociationInterface $workspace_association

The workspace association service.

WorkspaceInterface $source

The source workspace entity.

publish()

Publishes the contents of a workspace to the default (Live) workspace.

string getSourceLabel()

Returns the human-readable label of the source.

Return Value

string

The source label.

string getTargetLabel()

Returns the human-readable label of the target.

Return Value

string

The target label.

array checkConflictsOnTarget()

Checks if there are any conflicts between the source and the target.

Return Value

array

Returns an array consisting of the number of conflicts between the source and the target, keyed by the conflict type constant.

array getDifferringRevisionIdsOnTarget()

Gets the revision identifiers for items which have changed on the target.

Return Value

array

A multidimensional array of revision identifiers, keyed by entity type IDs.

array getDifferringRevisionIdsOnSource()

Gets the revision identifiers for items which have changed on the source.

Return Value

array

A multidimensional array of revision identifiers, keyed by entity type IDs.

int getNumberOfChangesOnTarget()

Gets the total number of items which have changed on the target.

This returns the aggregated changes count across all entity types. For example, if two nodes and one taxonomy term have changed on the target, the return value is 3.

Return Value

int

The number of differing revisions.

int getNumberOfChangesOnSource()

Gets the total number of items which have changed on the source.

This returns the aggregated changes count across all entity types. For example, if two nodes and one taxonomy term have changed on the source, the return value is 3.

Return Value

int

The number of differing revisions.