README

[!注意] 此项目已存档！

此系统的较新版本是 基于 Filament 的包

Laravel ODK Link

此包使您能够将您的 Laravel 应用程序连接到 ODK Central 服务器，并通过使用 Laravel Backpack 构建的 CRUD 面板来管理 ODK 表单的部署。

此包的好处是您可以创建一组 "xlsform 模板"，然后将其部署到不同的 "所有者"。所有者可以是单个用户，也可以是团队。这样，多个组可以独立工作并保持其数据分离，同时仍然使用相同的 "xlsform 模板"，并允许中央团队审查来自所有团队的数据。

注意：这仍在开发中。目前它需要 Laravel Backpack Pro，这是一款付费产品。我们希望将来能够重构此功能，使其不需要 Backpack Pro 许可证。

安装

此包假定您已通过遵循他们的安装指南设置了项目以使用 Laravel Backpack。如果您还没有这样做，请按照以下步骤操作： https://backpackforlaravel.com/docs/5.x/installation。

您可以通过 composer 安装此包

composer require stats4sd/laravel-odk-link

您可以使用以下命令发布和运行迁移

php artisan vendor:publish --tag="odk-link-migrations"
php artisan migrate

您可以使用以下命令发布配置文件

php artisan vendor:publish --tag="odk-link-config"

此包附带一组 CRUD 面板，旨在帮助您管理 ODK 表单和提交。要将这些链接添加到您的 Backpack Admin 侧边栏，请运行以下命令

php artisan odk:crud

此包使用 Spatie 的 Laravel Media Library。要设置它，请运行以下命令（有关更多信息以及自定义设置，请参阅他们的 安装说明）

php artisan vendor:publish --provider="Spatie\MediaLibrary\MediaLibraryServiceProvider" --tag="migrations"
php artisan migrate
php artisan vendor:publish --provider="Spatie\MediaLibrary\MediaLibraryServiceProvider" --tag="config"

您还需要向项目中添加一些环境变量。在您的 .env 文件中，添加以下内容

### REQUIRED
# url of your ODK Central server
ODK_URL="https://example-odk-central-server.com"

# username and password of an administrator account for your ODK Central server
ODK_USERNAME="an-admin-user-account"
ODK_PASSWORD="your-password"

### OPTIONAL
# the FQDN of the PHP class in your application that is used to process an ODK submission 
SUBMISSION_PROCESS_CLASS="\\App\\Http\\Controllers\\SubmissionController"

# the method within the class. This method should:
# - be a public static function
# - accept an OdkLink\Models\Submission object as the only required variable
SUBMISSION_PROCESS_METHOD="process"

## Use
TODO: write up full documentation.



## Credits

- [David Mills](https://github.com/dave-mills)
- [All Contributors](../../contributors)

## License
The MIT Licence (MIT). Please see [Licence File](LICENSE.md) for more information.