README

WoodWing Assets 是一个DAM（数字资产管理）系统。此PHP客户端库使用其 REST API。

这不是WoodWing供应商提供的官方库。它是在2019-2020年德国 SPIEGEL Gruppe WoodWing Assets实施期间开发的。

功能

• API登录
• 搜索: SearchRequest
• 浏览: BrowseRequest
• 创建: CreateRequest
• 更新: UpdateRequest
• 批量更新: UpdateBulkRequest
• 复制资产: CopyAssetRequest
• 移动/重命名: MoveRequest
• 删除: RemoveRequest
• 创建关系: CreateRelationRequest
• 创建文件夹： CreateFolderRequest
• 获取文件夹元数据： GetFolderRequest
• 更新文件夹元数据： UpdateFolderRequest

安装

使用 Composer 将此库添加到项目的 composer.json 文件中

$ composer require der-spiegel/ww-assets-client

快速测试

以下是如何进行快速测试的说明，从全新的项目开始（需要Docker）

使用Composer安装依赖项

$ mkdir MyExample && cd MyExample
$ docker run --rm --interactive --tty \
  --volume $PWD:/app \
  --volume ${COMPOSER_HOME:-$HOME/.composer}:/tmp \
  composer/composer require der-spiegel/ww-assets-client monolog/monolog

复制并编辑示例脚本

$ cp vendor/der-spiegel/ww-assets-client/UsageExample.php MyExample.php

编辑您的副本，在此部分设置正确的Assets URL、用户名（API用户优先）和密码

$assetsConfig = AssetsConfig::create(
    'https://assets.example.com/', // Assets URL (without app/ or services/ postfix)
    'username',                    // Assets user name (API user preferred)
    'password'                     // That user's password
);

示例脚本在所有资产（对该用户可见）中执行简单的搜索，并返回前50个资产ID - 您可以保留它以进行初次测试

$assetsClient = new AssetsClient($assetsConfig, $logger); // Create client

$request = new SearchRequest($assetsClient,               // Create search request
        q: '',                                            // Assets query
        metadataToReturn: ['']                            // Metadata fields to return
);

$response = $request();                                   // Perform search

foreach ($response->hits as $assetResponse) {             // Loop through results
    echo $assetResponse->id . "\n";                       // Access asset metadata
}

然后运行您的副本

$ docker run -it --rm --name assets-client-example \
  --volume "$PWD":/usr/src/myapp --workdir /usr/src/myapp \
  php:cli php MyExample.php

开发

有关运行单元和集成测试的说明，请参阅 运行测试。

要从源文件重新生成docs/_build/html中的文档，请运行Sphinx

$ docker run --rm --volume "$PWD":/usr/src/myapp --workdir /usr/src/myapp/docs sphinxdoc/sphinx:5.3.0 make html

作者

• Tim Strehle - https://twitter.com/tistre
• Luís Ferreira

许可证

本库采用MIT许可证 - 详细内容请参阅LICENSE文件。