claudye / socialsharer
PHP 包用于生成社交媒体分享链接。
Requires
- php: >=7.3 || 8.2
Requires (Dev)
- phpunit/phpunit: ^9.5
This package is auto-updated.
Last update: 2024-09-12 22:44:03 UTC
README
简介
PHP 包,可以简单快速地在社交媒体上分享链接。
特性
- 在所有社交网络上分享(短信、复制粘贴、Gmail 等)
- 特别在WhatsApp、Facebook等特定网络上分享
- 支持JavaScript分享API
- 可以按需样式化按钮。
安装
- 首先您需要安装 composer
- 进入您项目的根目录
- 打开终端并输入
composer require claudye/socialsharer:dev-master
安装分享器。如果没有错误出现,则表示您已成功安装了 Socialsharer
使用
在您想使用 socialsharer 的位置包含 composer 类自动加载文件,或任何 composer 可以加载我们的类的位置。
例如:(根据您的案例进行适配)require DIR.'/vendor/autoload.php';
创建元标签
开始使用 Socialsharer
use Claudye\Socialsharer\Sharer;
$metabuilder = Sharer::url($url); // $url the url you want share
此 url 方法返回一个 \Claudye\Socialsharer\MetaBuilder;
实例,您可以根据需要附加其他方法
$metabuilder->title($title); //$title the title you want share
$metabuilder->description($description) // $description that you want share
$metabuilder->meta($porperty, $content)
\Claudye\Socialsharer\MetaBuilder
类允许您使用 meta($porperty, $content)
方法动态构建您的元标签
第一个参数 $porperty
是元标签的名称,第二个参数 $content
是元标签的内容
示例
$metabuilder = new MetaBuilder();
$metabuilder->meta('og:image','image.png') // let you to create a html tag like this :
<meta name="og:image" content="image.png">
您可以根据需要调用此元标签创建多个标签
创建社交媒体分享链接
一旦创建了元标签,您可以自由地创建社交媒体分享链接(短信、Facebook、WhatsApp 等)
最重要的按钮是全球分享按钮。通过它,您的用户可以轻松地将链接分享到所有原生支持的平台上
创建全局按钮
$all = Sharer::all();
这样,您就实例化了按钮创建
这个方法返回一个 Claudye\Socialsharer\All
实例,允许您按需构建按钮。您可以修改其内容或添加 hhtml 属性以自定义其外观
$all->addContent('Share on social media');
$add->addAttribute('class','btn my-btn-class');
$add->addAttribute('id','my-btn-id');
这就完成了,现在您可以按以下方式显示您的分享按钮
echo $all->display();
echo $all ;
您可以在创建按钮的同时添加 html 属性,如下所示
Sharer::all('content', ['class'=>'your-class', 'id'=>'btn-id'])
,无需调用 addContent()
和 addAttribute()
方法
支持的网络
目前虽然所有方法都可以通过 SMS、复制粘贴、Facebook、Twitter 等、LinkedIn 等分享,但我们还有其他特定方法,如 facebook()
、whatsapp()
,可以轻松地在这些网络上分享。这些方法接受与 Sharer::all()
方法相同的参数。
Sharer::facebook('Facebook 图标')
允许您生成 Facebook 上的分享链接
Sharer::whatsapp('图标, WhatsApp')
允许您与多个人分享 WhatsApp
启用分享
在创建链接后,还需要进行两个步骤,或者一个步骤是必需的。
为了使链接分享功能正常工作,我们必须导入我们的脚本并将其放置在要分享的页面的 body 标签结束之前。
$scriptsOfSharer = Sharer::scripts();
echo $scriptsOfSharer or echo Sharer::scripts();
为了使社交媒体和机器人能够直接在其网络上显示页面的标题、描述和图片,您必须在页面的标题中显示您刚刚创建的元标签。
$metaTags = Sharer::createMeta();
echo $metaTags ou echo Sharer::createMeta();
示例
<?php
use Claudye\Socialsharer\Sharer;
require __DIR__.'/vendor/autoload.php';
$title = 'Social Sharer';
$description = 'PHP package for generating social share links';
$image = 'screenshot.png';
$metabuilder = Sharer::url('hello-world.php');
// Create <meta name="og:title" content="The title content">
$metabuilder->title($title);
// Create <meta name="og:description" content="The description content">
$metabuilder->description($description);
// Create <meta name="og:image" content="the-image-scr.extension">
$metabuilder->image($image);
$metabuilder->meta('og:type', "Website"); // Create <meta name="og:type" content="Website">
//Create meta tags and return them for display in the site header
//(optional) but very recommended if the og tags were not already in the header of the site
$headerMeta = Sharer::createMeta();
//Import our scripts
$sharerScripts = Sharer::scripts();
//Create a share button for sms, facebook etc sharing channels natively
$all = Sharer::all('<i fa fa-share></i> Share');
//Add classes to customize the button via css or js
$all->addAttribute('class','btn btn-primary');
echo $all ;
注意
Attention, for the share button on all channels to work, you must at least add the description via the
Sharer::description($description)
,或者通过$all->description($description)
,或者通过HTML描述标签。您还可以检查浏览器控制台以查看是否有错误