README

将您的Soundcloud曲目数据同步到Craft条目

需求

此插件需要Craft CMS 4.0.0或更高版本。

安装

要安装插件，请按照以下说明操作。

1. 打开您的终端并转到您的Craft项目

   cd /path/to/project
   

2. 然后告诉Composer加载插件

   composer require boxhead/soundcloud-sync
   

3. 在控制面板中，转到设置→插件，然后单击“安装”按钮安装Soundcloud Sync。

Soundcloud Sync概览

使用Soundcloud Sync消除将Soundcloud数据同步到您网站的烦恼。目前同步只发生单向，Soundcloud » Craft。

此插件使用“client_credentials”授权类型通过Soundcloud API进行授权，因此只能访问公开内容和Soundcloud应用所有者的内容。

配置Soundcloud Sync

1. 打开Soundcloud Sync设置并指定您的Soundcloud应用详情，包括客户端ID、客户端密钥和Soundcloud用户ID。

2. 指定要将数据同步到相应ID的Craft部分和条目类型。

3. 您还可以选择指定用逗号分隔的Craft类别组列表，通过其handle进行指定。如果这些存在，则插件将搜索与这些handle前缀的Soundcloud标签相关的标签，允许它自动创建并附加这些类别到结果Craft条目。例如，您可以设置'speaker'为类别组handle。如果一个曲目包含'speaker:Joe Bloggs'的标签，则'Joe Bloggs'将被创建为Craft类别并添加到该曲目的Craft条目中。

字段

SoundCloud Sync通过将API数据保存到Craft字段来工作。它通过handle查找的字段包括

• soundcloudArtwork500
• soundcloudArtwork300
• soundcloudBpm
• soundcloudCommentCount
• soundcloudDescription
• soundcloudDownloadCount
• soundcloudDownloadUrl
• soundcloudDuration
• soundcloudDurationHuman
• soundcloudFavoritingsCount
• soundcloudFileId
• soundcloudPermalinkUrl
• soundcloudPlaybackCount
• soundcloudPurchaseUrl
• soundcloudRelease
• soundcloudStreamUrl
• soundcloudStreamable
• soundcloudUserPermalink
• soundcloudWaveformUrl

您可以在Craft安装中设置一个、多个或所有这些字段。

类别

如上所述，如果格式符合预期，则插件可以自动将流派和标签数据保存到Craft类别。

1. 设置Craft类别组，例如'主题'、'流派'、'艺术家'、'演讲者'

2. 设置可以映射到这些组的使用以下格式的类别字段soundcloudCategories{{ category group handle}}，例如，在'艺术家'类别组的情况下，您将有一个名为soundcloudCategoriesArtist的字段。

使用Soundcloud Sync

Soundcloud Sync可以通过指向{{ your site url }}/actions/soundcloud-sync/sync的Cron任务定期运行。这将搜索并创建任何尚未存在的Soundcloud曲目的新Craft条目，并将播放次数、收藏和评论的更新值应用于任何现有条目。

Soundcloud Sync路线图

由Boxhead提供