next-drupal/modules/next/src/Entity/NextSiteInterface.php at caf8ffe6c45d6d2e2c26cfb62ddcac07a3059384 · chapter-three/next-drupal · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
<?php

namespace Drupal\next\Entity;

use Drupal\Core\Config\Entity\ConfigEntityInterface;
use Drupal\Core\Entity\EntityInterface;
use Drupal\Core\Url;

/**
 * Provides an interface for NextSite entity definitions.
 */
interface NextSiteInterface extends ConfigEntityInterface {

  /**
   * Returns the base_url for the next_site.
   *
   * @return string
   *   The base_url for the next_site.
   */
  public function getBaseUrl(): ?string;

  /**
   * Sets the base_url for the next_site.
   *
   * @param string $base_url
   *   The base_url.
   *
   * @return \Drupal\next\Entity\NextSiteInterface
   *   The next_site entity.
   */
  public function setBaseUrl(string $base_url): self;

  /**
   * Returns the preview_url for the next_site.
   *
   * @return string
   *   The preview_url for the next_site.
   */
  public function getPreviewUrl(): ?string;

  /**
   * Sets the preview_url for the next_site.
   *
   * @param string $preview_url
   *   The preview_url.
   *
   * @return \Drupal\next\Entity\NextSiteInterface
   *   The next_site entity.
   */
  public function setPreviewUrl(string $preview_url): self;

  /**
   * Returns the preview_secret for the next_site.
   *
   * @return string
   *   The preview_secret for the next_site.
   */
  public function getPreviewSecret(): ?string;

  /**
   * Sets the preview_secret for the next_site.
   *
   * @param string $preview_secret
   *   The preview_secret.
   *
   * @return \Drupal\next\Entity\NextSiteInterface
   *   The next_site entity.
   */
  public function setPreviewSecret(string $preview_secret): self;

  /**
   * Returns the preview url for the given entity.
   *
   * @param \Drupal\Core\Entity\EntityInterface $entity
   *   The entity.
   *
   * @return \Drupal\Core\Url
   *   The generated preview url.
   */
  public function getPreviewUrlForEntity(EntityInterface $entity): Url;

  /**
   * Returns the live url for the given entity.
   *
   * @param \Drupal\Core\Entity\EntityInterface $entity
   *   The entity.
   *
   * @return \Drupal\Core\Url|null
   *   The generated live url.
   */
  public function getLiveUrlForEntity(EntityInterface $entity): ?Url;

  /**
   * Returns the revalidate_url for the next_site.
   *
   * @return string
   *   The revalidate_url for the next_site.
   */
  public function getRevalidateUrl(): ?string;

  /**
   * Sets the revalidate_url for the next_site.
   *
   * @param string $revalidate_url
   *   The revalidate_url.
   *
   * @return \Drupal\next\Entity\NextSiteInterface
   *   The next_site entity.
   */
  public function setRevalidateUrl(string $revalidate_url): self;

  /**
   * Returns the revalidate_secret for the next_site.
   *
   * @return string
   *   The revalidate_secret for the next_site.
   */
  public function getRevalidateSecret(): ?string;

  /**
   * Sets the revalidate_secret for the next_site.
   *
   * @param string $revalidate_secret
   *   The revalidate_secret.
   *
   * @return \Drupal\next\Entity\NextSiteInterface
   *   The next_site entity.
   */
  public function setRevalidateSecret(string $revalidate_secret): self;

  /**
   * Returns the site_previewer for the next_site.
   *
   * @return string|null
   *   The site_previewer for the next_site.
   */
  public function getSitePreviewer(): ?string;

  /**
   * Sets the site_previewer for the next_site.
   *
   * @param string $site_previewer
   *   The site_previewer.
   *
   * @return \Drupal\next\Entity\NextSiteInterface
   *   The next_site entity.
   */
  public function setSitePreviewer(string $site_previewer): self;

  /**
   * Returns the site_previewer_configuration for the next_site.
   *
   * @return array
   *   The site_previewer_configuration for the next_site.
   */
  public function getSitePreviewerConfiguration(): array;

  /**
   * Sets the site_previewer_configuration for the next_site.
   *
   * @param array $site_previewer_configuration
   *   The site_previewer_configuration.
   *
   * @return \Drupal\next\Entity\NextSiteInterface
   *   The next_site entity.
   */
  public function setSitePreviewerConfiguration(array $site_previewer_configuration): self;

  /**
   * Returns the revalidate url for given path.
   *
   * @param array $query
   *   The revalidate URL query parameters.
   *
   * @return \Drupal\Core\Url|null
   *   The revalidate url.
   */
  public function buildRevalidateUrl(array $query = []): ?Url;

}