WorkspaceInterface.php

Same filename in other branches
  1. 9 core/modules/workspaces/src/WorkspaceInterface.php
  2. 8.9.x core/modules/workspaces/src/WorkspaceInterface.php
  3. 10 core/modules/workspaces/src/WorkspaceInterface.php

Namespace

Drupal\workspaces

File

core/modules/workspaces/src/WorkspaceInterface.php

View source
<?php

namespace Drupal\workspaces;

use Drupal\Core\Entity\ContentEntityInterface;
use Drupal\Core\Entity\EntityChangedInterface;
use Drupal\user\EntityOwnerInterface;

/**
 * Defines an interface for the workspace entity type.
 */
interface WorkspaceInterface extends ContentEntityInterface, EntityChangedInterface, EntityOwnerInterface {
    
    /**
     * Publishes the contents of this workspace to the default (Live) workspace.
     */
    public function publish();
    
    /**
     * Gets the workspace creation timestamp.
     *
     * @return int
     *   Creation timestamp of the workspace.
     */
    public function getCreatedTime();
    
    /**
     * Sets the workspace creation timestamp.
     *
     * @param int $timestamp
     *   The workspace creation timestamp.
     *
     * @return $this
     */
    public function setCreatedTime($timestamp);
    
    /**
     * Determines whether the workspace has a parent.
     *
     * @return bool
     *   TRUE if the workspace has a parent, FALSE otherwise.
     */
    public function hasParent();

}

Interfaces

Title Deprecated Summary
WorkspaceInterface Defines an interface for the workspace entity type.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.