Skip to content

Commit c94bb66

Browse files
authored
Mark new API as @internal
1 parent 963886d commit c94bb66

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

src/Codeception/Lib/Connector/Yii2.php

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ class Yii2 extends Client
8686
/**
8787
* @return \yii\web\Application
8888
*
89-
* @deprecated since 2.5, will become protected in 3.0. Use getComponent() or directly access to \Yii::$app.
89+
* @deprecated since 2.5, will become protected in 3.0. Directly access to \Yii::$app if you need to interact with it.
9090
*/
9191
public function getApplication()
9292
{
@@ -112,6 +112,7 @@ public function resetApplication()
112112

113113
/**
114114
* Finds and logs in a user
115+
* @internal
115116
* @param $user
116117
* @throws ConfigurationException
117118
* @throws \RuntimeException
@@ -138,6 +139,7 @@ public function findAndLoginUser($user)
138139

139140
/**
140141
* Masks a value
142+
* @internal
141143
* @param string $val
142144
* @return string
143145
* @see \yii\base\Security::maskToken
@@ -148,6 +150,7 @@ public function maskToken($val)
148150
}
149151

150152
/**
153+
* @internal
151154
* @param string $name The name of the cookie
152155
* @param string $value The value of the cookie
153156
* @return string The value to send to the browser
@@ -162,6 +165,7 @@ public function hashCookieData($name, $value)
162165
}
163166

164167
/**
168+
* @internal
165169
* @return array List of regex patterns for recognized domain names
166170
*/
167171
public function getInternalDomains()
@@ -181,13 +185,17 @@ public function getInternalDomains()
181185
}
182186

183187
/**
188+
* @internal
184189
* @return array List of sent emails
185190
*/
186191
public function getEmails()
187192
{
188193
return $this->emails;
189194
}
190195

196+
/**
197+
* @internal
198+
*/
191199
public function getComponent($name)
192200
{
193201
$app = $this->getApplication();
@@ -227,6 +235,7 @@ function ($matches) use (&$parameters) {
227235

228236
/**
229237
* Gets the name of the CSRF param.
238+
* @internal
230239
* @return string
231240
*/
232241
public function getCsrfParamName()
@@ -235,6 +244,7 @@ public function getCsrfParamName()
235244
}
236245

237246
/**
247+
* @internal
238248
* @param $params
239249
* @return mixed
240250
*/
@@ -439,6 +449,7 @@ public function restart()
439449

440450
/**
441451
* This functions closes the session of the application, if the application exists and has a session.
452+
* @internal
442453
*/
443454
public function closeSession()
444455
{

0 commit comments

Comments
 (0)