Code Coverage for /Users/ericduran/Sites/drupal/drupal/core/modules/content_translation/src/ContentTranslationMetadataWrapperInterface.php

	Code Coverage
	Classes and Traits		Functions and Methods				Lines
Total	100.00% covered (success)	0 / 0	100.00% covered (success)	100.00%	0 / 0	CRAP	100.00% covered (success)	100.00%	0 / 0

1	<?php
2
3	/**
4	* @file
5	* Contains \Drupal\content_translation\ContentTranslationMetadataWrapperInterface.
6	*/
7
8	namespace Drupal\content_translation;
9
10	use Drupal\user\UserInterface;
11
12	/**
13	* Common interface for content translation metadata wrappers.
14	*
15	* This acts as a wrapper for an entity translation object, encapsulating the
16	* logic needed to retrieve translation metadata.
17	*/
18	interface ContentTranslationMetadataWrapperInterface {
19
20	/**
21	* Retrieves the source language for this translation.
22	*
23	* @return string
24	* The source language code.
25	*/
26	public function getSource();
27
28	/**
29	* Sets the source language for this translation.
30	*
31	* @param string $source
32	* The source language code.
33	*
34	* @return $this
35	*/
36	public function setSource($source);
37
38	/**
39	* Returns the translation outdated status.
40	*
41	* @return bool
42	* TRUE if the translation is outdated, FALSE otherwise.
43	*/
44	public function isOutdated();
45
46	/**
47	* Sets the translation outdated status.
48	*
49	* @param bool $outdated
50	* TRUE if the translation is outdated, FALSE otherwise.
51	*
52	* @return $this
53	*/
54	public function setOutdated($outdated);
55
56	/**
57	* Returns the translation author.
58	*
59	* @return \Drupal\user\UserInterface
60	* The user entity for the translation author.
61	*/
62	public function getAuthor();
63
64	/**
65	* Sets the translation author.
66	*
67	* The metadata field will be updated, only if it's translatable.
68	*
69	* @param \Drupal\user\UserInterface $account
70	* The translation author user entity.
71	*
72	* @return $this
73	*/
74	public function setAuthor(UserInterface $account);
75
76	/**
77	* Returns the translation published status.
78	*
79	* @return bool
80	* TRUE if the translation is published, FALSE otherwise.
81	*/
82	public function isPublished();
83
84	/**
85	* Sets the translation published status.
86	*
87	* The metadata field will be updated, only if it's translatable.
88	*
89	* @param bool $published
90	* TRUE if the translation is published, FALSE otherwise.
91	*
92	* @return $this
93	*/
94	public function setPublished($published);
95
96	/**
97	* Returns the translation creation timestamp.
98	*
99	* @return int
100	* The UNIX timestamp of when the translation was created.
101	*/
102	public function getCreatedTime();
103
104	/**
105	* Sets the translation creation timestamp.
106	*
107	* The metadata field will be updated, only if it's translatable.
108	*
109	* @param int $timestamp
110	* The UNIX timestamp of when the translation was created.
111	*
112	* @return $this
113	*/
114	public function setCreatedTime($timestamp);
115
116	/**
117	* Returns the timestamp of the last entity change from current translation.
118	*
119	* @return int
120	* The timestamp of the last entity save operation.
121	*/
122	public function getChangedTime();
123
124	/**
125	* Sets the translation modification timestamp.
126	*
127	* The metadata field will be updated, only if it's translatable.
128	*
129	* @param int $timestamp
130	* The UNIX timestamp of when the translation was last modified.
131	*
132	* @return $this
133	*/
134	public function setChangedTime($timestamp);
135
136	}