added support for @deprecated tag to api docs

This commit is contained in:
Carsten Brandt
2015-03-19 12:30:07 +01:00
parent befd42f46a
commit 43fd21e352
4 changed files with 12 additions and 3 deletions

View File

@ -211,3 +211,8 @@ h1:hover .hashlink, h2:hover .hashlink, h3:hover .hashlink, h4:hover .hashlink,
.broken-link { .broken-link {
background: lightpink; background: lightpink;
} }
tr.deprecated td,
tr.deprecated th {
background: lightpink;
}

View File

@ -69,6 +69,9 @@ $renderer = $this->context;
<?php if (!empty($type->since)): ?> <?php if (!empty($type->since)): ?>
<tr><th>Available since version</th><td><?= $type->since ?></td></tr> <tr><th>Available since version</th><td><?= $type->since ?></td></tr>
<?php endif; ?> <?php endif; ?>
<?php if (!empty($type->deprecatedSince) || !empty($type->deprecatedReason)): ?>
<tr class="deprecated"><th>Deprecated since version</th><td><?= $type->deprecatedSince ?> <?= $type->deprecatedReason ?></td></tr>
<?php endif; ?>
<?php if (($sourceUrl = $renderer->getSourceUrl($type)) !== null): ?> <?php if (($sourceUrl = $renderer->getSourceUrl($type)) !== null): ?>
<tr> <tr>
<th>Source Code</th> <th>Source Code</th>

View File

@ -6,6 +6,7 @@ Yii Framework 2 authclient extension Change Log
- Enh #6743: Icon for Google at `yii\authclient\widgets\AuthChoice` fixed to follow the Google Brand guidelines (klimov-paul) - Enh #6743: Icon for Google at `yii\authclient\widgets\AuthChoice` fixed to follow the Google Brand guidelines (klimov-paul)
- Enh #7754: New client `yii\authclient\clients\GooglePlus` added to support Google recommended auth flow (klimov-paul) - Enh #7754: New client `yii\authclient\clients\GooglePlus` added to support Google recommended auth flow (klimov-paul)
- Chg: #7754: `yii\authclient\clients\GoogleOpenId` is now deprecated because this auth method is no longer supported by Google as of April 20, 2015 (klimov-paul)
2.0.3 March 01, 2015 2.0.3 March 01, 2015

View File

@ -10,12 +10,11 @@ namespace yii\authclient\clients;
use yii\authclient\OpenId; use yii\authclient\OpenId;
/** /**
* @deprecated * GoogleOpenId allows authentication via Google OpenId.
* *
* Warning: this class is deprecated since Google is shutting down OpenID protocol support! * **Warning: this class is deprecated since [Google is shutting down OpenID protocol support](https://developers.google.com/+/api/auth-migration#timetable)!**
* Use [[GoogleOAuth]] or [[GoogleHybrid]] instead. * Use [[GoogleOAuth]] or [[GoogleHybrid]] instead.
* *
* GoogleOpenId allows authentication via Google OpenId.
* Unlike Google OAuth you do not need to register your application anywhere in order to use Google OpenId. * Unlike Google OAuth you do not need to register your application anywhere in order to use Google OpenId.
* *
* Example application configuration: * Example application configuration:
@ -36,6 +35,7 @@ use yii\authclient\OpenId;
* *
* @author Paul Klimov <klimov.paul@gmail.com> * @author Paul Klimov <klimov.paul@gmail.com>
* @since 2.0 * @since 2.0
* @deprecated 2.0.4 because this auth method is no longer supported by Google as of April 20, 2015.
*/ */
class GoogleOpenId extends OpenId class GoogleOpenId extends OpenId
{ {