README

Bitly 驱动的短链接集成到 Textpattern CMS。当文章发布时或其 URL 更新时，自动生成短链接。

安装

$ composer require rah/rah_bitly

或者下载安装包。

配置

要开始使用 rah_bitly，您首先需要配置您的 Bitly 访问令牌 和一个您想要用来存储缩短链接的字段。您可以在 Textpattern 管理员中的管理 / 偏好设置 页面找到这些选项，然后从那里进入 Bitly 集成 部分。包括的选项有

Bitly 访问令牌 是您的通用访问令牌。您可以在 Bitly 账户的 API 设置中生成自己的访问令牌。
存储在字段中 是用于存储缩短链接的字段。这支持文章自定义字段。

使用方法

生成链接

当满足以下三个条件之一时，将为文章生成 Bitly 链接

当文章发布时。
当已发布文章的 URL 标题被修改时。
当用于存储链接的自定义字段被清空时。

只有当文章处于实时或粘性状态，或者以这些状态保存时，这三种条件才适用。不会为未发布文章生成短链接。

所有生成的链接都将遵循您的 Bitly 账户的偏好设置，包括您的自定义域名或首选域名。

如果请求 Bitly 中的短链接失败，由于连接错误或 Bitly 的服务器暂时不可达，当再次保存文章时将发送新的请求。如果请求成功，您会在自定义字段中看到缩短链接，并且在编辑器中显示错误消息。

插件将缩短的链接是文章的永久链接，这是 Textpattern 响应的各个文章页面的真实位置。它与撰写管理页面上的查看链接指向的位置相同。

显示链接

由于使用自定义字段来存储缩短链接，因此将 Bitly 链接显示在您的页面模板和文章中既简单又可自定义。

<txp:if_custom_field name="short_url">
	<a href="<txp:custom_field name="short_url" />">
		<txp:custom_field name="short_url" />
	</a>
<txp:else />
	<p>No short link.</p>
</txp:if_custom_field>

上述代码片段将在放置到文章上下文中时显示缩短的 Bitly 链接。如果文章没有短链接，将显示 没有短链接。 消息。

针对开发人员

自定义永久链接

该插件提供了 rah_bitly.permlink 回调事件，可以用来自定义发送到 Bitly 的文章永久链接。注册到该事件的观察者示例可能如下所示

register_callback('abc_example', 'rah_bitly.permlink');

function abc_example($event, $step, &$data): void
{
    if ($data['articleData']['Section'] === 'example') {
        $data['permlink'] .= '#bitly';
    }
}

上述代码将向发送的 URL 添加 #bitly 锚点，如果文章发布到名为 example 的部分。

变更日志

版本 0.5.1 – 2022/04/25

增加了 rah_bitly.permlink 回调事件，可以用于自定义发送到Bitly的文章permlink。

版本 0.5.0 – 2022/04/18

Bitly API 版本 4 兼容性。
Textpattern >= 4.7.0 兼容性。
现在需要 Textpattern >= 4.7.0 和 PHP >= 7.2.0。

版本 0.4.2 – 2012/12/21

修复：文章更新期间出现未定义变量提示。
增加：在 Textpattern 4.6-dev 的偏好设置面板上显示偏好设置组。

版本 0.4.1 – 2012/09/20

改进：清理了安装程序。

版本 0.4 – 2012/08/27

增加：Textpattern 4.5.0 兼容性。感谢 Robert Wetzlmayr。
增加：芬兰语翻译。
修复：卸载程序 SQL 语句中的通配符潜在问题。
变更：Textpacks 不嵌入到代码中，而是使用安装程序。
移除：一个偏好控制中不必要的 HTML 转义。
移除：v0.2 中添加的功能，允许从 HTTP POST 数据中选择新的自定义字段。这是为了未来的兼容性。
移除：取消对 file_get_contents() 和 allow_url_fopen 的支持。现在需要 cURL 以符合未来的合规性和 oAuth 的迁移。

版本 0.3 – 2011/12/05

变更：现在使用 Textpattern 的 script_js() 输出 JavaScript 块。
改进：转义 Bitly 返回的 URL，以防止其破坏 JavaScript 字符串。这是为了防止潜在的 JavaScript 注入。

版本 0.2 – 2011/07/21

变更：偏好设置部分的标题现在使用标题大小写，选项标签使用句子大小写。
变更：现在从 POST 数据中获取新的自定义字段。
Stef，Markus，感谢建议。

版本 0.1 – 2011/07/20

初始发布。

rah / rah_bitly

维护者

详细信息