WebformSubmissionInterface.php 9.9 KB
Newer Older
1 2 3 4
<?php

namespace Drupal\webform;

5
use Drupal\Core\Session\AccountInterface;
6 7
use Drupal\user\EntityOwnerInterface;
use Drupal\Core\Entity\ContentEntityInterface;
8
use Drupal\user\UserInterface;
9 10 11 12 13 14 15 16 17 18 19 20

/**
 * Provides an interface defining a webform submission entity.
 */
interface WebformSubmissionInterface extends ContentEntityInterface, EntityOwnerInterface {

  /**
   * Return status for new submission.
   */
  const STATE_UNSAVED = 'unsaved';

  /**
21
   * Return status for submission in draft created.
22 23 24
   */
  const STATE_DRAFT = 'draft';

25 26 27 28 29 30 31 32 33 34
  /**
   * Return status for submission in draft created.
   */
  const STATE_DRAFT_CREATED = 'draft_created';

  /**
   * Return status for submission in draft updated.
   */
  const STATE_DRAFT_UPDATED = 'draft_updated';

35 36 37 38 39
  /**
   * Return status for submission that has been completed.
   */
  const STATE_COMPLETED = 'completed';

40 41 42 43 44
  /**
   * Return status for submission that has been locked.
   */
  const STATE_LOCKED = 'locked';

45 46 47 48 49
  /**
   * Return status for submission that has been updated.
   */
  const STATE_UPDATED = 'updated';

50 51 52 53 54
  /**
   * Return status for submission that has been deleted.
   */
  const STATE_DELETED = 'deleted';

55 56 57 58 59
  /**
   * Return status for submission that has been converted from anonymous to authenticated.
   */
  const STATE_CONVERTED = 'converted';

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
  /**
   * Gets the serial number.
   *
   * @return int
   *   The serial number.
   */
  public function serial();

  /**
   * Returns the time that the submission was created.
   *
   * @return int
   *   The timestamp of when the submission was created.
   */
  public function getCreatedTime();

  /**
   * Sets the creation date of the submission.
   *
   * @param int $created
   *   The timestamp of when the submission was created.
   *
   * @return $this
   */
  public function setCreatedTime($created);

  /**
   * Gets the timestamp of the last submission change.
   *
   * @return int
   *   The timestamp of the last submission save operation.
   */
  public function getChangedTime();

  /**
   * Sets the timestamp of the last submission change.
   *
   * @param int $timestamp
   *   The timestamp of the last submission save operation.
   *
   * @return $this
   */
  public function setChangedTime($timestamp);

  /**
   * Gets the timestamp of the submission completion.
   *
   * @return int
   *   The timestamp of the submission completion.
   */
  public function getCompletedTime();

  /**
   * Sets the timestamp of the submission completion.
   *
   * @param int $timestamp
   *   The timestamp of the submission completion.
   *
   * @return $this
   */
  public function setCompletedTime($timestamp);

  /**
   * Get the submission's notes.
   *
   * @return string
   *   The submission's notes.
   */
  public function getNotes();

  /**
   * Sets the submission's notes.
   *
   * @param string $notes
   *   The submission's notes.
   *
   * @return $this
   */
  public function setNotes($notes);

  /**
   * Get the submission's sticky flag.
   *
   * @return string
   *   The submission's stick flag.
   */
  public function getSticky();

  /**
   * Sets the submission's sticky flag.
   *
   * @param bool $sticky
   *   The submission's stick flag.
   *
   * @return $this
   */
  public function setSticky($sticky);

158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175
  /**
   * Get the submission's locked status.
   *
   * @return string
   *   The submission's lock status.
   */
  public function isLocked();

  /**
   * Sets the submission's locked flag.
   *
   * @param bool $locked
   *   The submission's locked flag.
   *
   * @return $this
   */
  public function setLocked($locked);

176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227
  /**
   * Gets the remote IP address of the submission.
   *
   * @return string
   *   The remote IP address of the submission
   */
  public function getRemoteAddr();

  /**
   * Sets remote IP address of the submission.
   *
   * @param string $ip_address
   *   The remote IP address of the submission.
   *
   * @return $this
   */
  public function setRemoteAddr($ip_address);

  /**
   * Gets the submission's current page.
   *
   * @return string
   *   The submission's current page.
   */
  public function getCurrentPage();

  /**
   * Sets the submission's current page.
   *
   * @param string $current_page
   *   The submission's current page.
   *
   * @return $this
   */
  public function setCurrentPage($current_page);

  /**
   * Get the submission's current page title.
   *
   * @return string
   *   The submission's current page title.
   */
  public function getCurrentPageTitle();

  /**
   * Is the current submission in draft.
   *
   * @return bool
   *   TRUE if the current submission is a draft.
   */
  public function isDraft();

228 229 230 231 232 233 234 235 236
  /**
   * Is the current submission being converted from anonymous to authenticated.
   *
   * @return bool
   *   TRUE if the current submission being converted from anonymous to
   *   authenticated.
   */
  public function isConverting();

237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252
  /**
   * Is the current submission completed.
   *
   * @return bool
   *   TRUE if the current submission has been completed.
   */
  public function isCompleted();

  /**
   * Returns the submission sticky status.
   *
   * @return bool
   *   TRUE if the submission is sticky.
   */
  public function isSticky();

253 254 255 256 257 258 259 260 261 262 263
  /**
   * Test whether the provided account is owner of this webform submission.
   *
   * @param \Drupal\Core\Session\AccountInterface $account
   *   Account whose ownership to test.
   *
   * @return bool
   *   Whether the provided account is owner of this webform submission.
   */
  public function isOwner(AccountInterface $account);

264 265 266 267 268 269 270 271 272 273 274
  /**
   * Checks submission notes.
   *
   * @return bool
   *   TRUE if the submission has notes.
   */
  public function hasNotes();

  /**
   * Track the state of a submission.
   *
275
   * @return string
276 277 278
   *   Either STATE_UNSAVED, STATE_DRAFT_CREATED, STATE_DRAFT_UPDATED,
   *   STATE_COMPLETED, STATE_UPDATED, STATE_LOCKED, or STATE_CONVERTED
   *   depending on the last save operation performed.
279 280 281 282
   */
  public function getState();

  /**
283
   * Get a webform submission element's data.
284 285
   *
   * @param string $key
286
   *   An webform submission element's key.
287 288 289 290 291 292 293 294 295 296
   *
   * @return mixed
   *   An webform submission element's data/value.
   */
  public function getElementData($key);

  /**
   * Set a webform submission element's data.
   *
   * @param string $key
297
   *   An webform submission element's key.
298 299 300 301 302 303 304 305
   * @param mixed $value
   *   A value.
   *
   * @return $this
   */
  public function setElementData($key, $value);

  /**
306
   * Gets the webform submission's raw data.
307 308
   *
   * @return array
309 310 311 312 313 314 315 316 317
   *   The webform submission raw data.
   */
  public function getRawData();

  /**
   * Gets the webform submission's data with computed valued.
   *
   * @return array
   *   The webform submission data with computed valued.
318
   */
319
  public function getData();
320 321 322 323 324 325

  /**
   * Set the webform submission's data.
   *
   * @param array $data
   *   The webform submission data.
326 327
   *
   * @return $this
328 329 330 331
   */
  public function setData(array $data);

  /**
332
   * Gets the webform submission's original data before any changes.
333 334 335 336
   *
   * @return array
   *   The webform submission original data.
   */
337
  public function getOriginalData();
338 339 340 341 342 343 344 345 346 347 348

  /**
   * Set the webform submission's original data.
   *
   * @param array $data
   *   The webform submission data.
   *
   * @return $this
   */
  public function setOriginalData(array $data);

349
  /**
350 351 352 353 354 355 356 357 358 359
   * Get a webform submission element's original data.
   *
   * @param string $key
   *   An webform submission element's key.
   *
   * @return mixed
   *   An webform submission element's original data/value.
   */
  public function getElementOriginalData($key);

360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378
  /**
   * Gets the webform submission's token.
   *
   * @return array
   *   The webform submission data.
   */
  public function getToken();

  /**
   * Gets the webform submission's webform entity.
   *
   * @return \Drupal\webform\WebformInterface
   *   The webform entity.
   */
  public function getWebform();

  /**
   * Gets the webform submission's source entity.
   *
379
   * @param bool $translate
380
   *   (optional) If TRUE the source entity will be translated.
381
   *
382 383 384
   * @return \Drupal\Core\Entity\EntityInterface|null
   *   The entity that this webform submission was created from.
   */
385
  public function getSourceEntity($translate = FALSE);
386 387 388 389 390 391 392 393 394 395 396 397

  /**
   * Gets the webform submission's source URL.
   *
   * @return \Drupal\Core\Url|false
   *   The source URL.
   */
  public function getSourceUrl();

  /**
   * Gets the webform submission's secure tokenized URL.
   *
398 399 400
   * @param string $operation
   *   Token URL's operation. Defaults to update.
   *
401
   * @return \Drupal\Core\Url
402
   *   The webform submission's secure tokenized URL.
403
   */
404
  public function getTokenUrl($operation = 'update');
405 406 407 408 409 410

  /**
   * Invoke all webform handlers method.
   *
   * @param string $method
   *   The webform handler method to be invoked.
411 412 413
   *
   * @return \Drupal\Core\Access\AccessResult|null
   *   If 'access' method is invoked an AccessResult is returned.
414 415 416 417 418 419 420 421 422 423 424
   */
  public function invokeWebformHandlers($method);

  /**
   * Invoke a webform element elements method.
   *
   * @param string $method
   *   The webform element method to be invoked.
   */
  public function invokeWebformElements($method);

425
  /**
426
   * Convert anonymous submission to authenticated.
427 428 429 430 431 432
   *
   * @param \Drupal\user\UserInterface $account
   *   An authenticated user account.
   */
  public function convert(UserInterface $account);

433 434 435 436 437
  /**
   * Resave a webform submission without trigger any hooks or handlers.
   */
  public function resave();

438 439 440 441 442
  /**
   * Gets an array of all property values.
   *
   * @param bool $custom
   *   If TRUE, return customized array that contains simplified properties
443
   *   and webform submission (element) data.
444
   * @param bool $check_access
445 446
   *   If $custom and $check_access is TRUE, view access is checked
   *   for webform submission (element) data.
447 448 449 450
   *
   * @return mixed[]
   *   An array of property values, keyed by property name.
   */
451
  public function toArray($custom = FALSE, $check_access = FALSE);
452 453

}