survos / global-giving-bundle

2.28.7 2026-09-15 10:44 UTC

Requires

• php: ^8.5
• survos/global-giving-client: ^2.5
• survos/kit-bundle: ^2.5
• symfony/cache: ^8.1
• symfony/http-client: ^8.1
• symfony/property-info: ^8.1
• symfony/serializer: ^8.1

Requires (Dev)

• phpunit/phpunit: ^13
• symfony/framework-bundle: ^8.1

MIT

Published on Packagist.org on 2026-09-15 11:01 UTC

README

Symfony 8.1 / PHP 8.5 integration for survos/global-giving-client, using survos/kit-bundle.

# config/packages/survos_global_giving.yaml
survos_global_giving:
    api_key: '%env(GLOBAL_GIVING_API_KEY)%'
    # base_uri: 'https://api.globalgiving.org/api/public/'

Inject Survos\GlobalGiving\GlobalGivingClient for API/download calls and Survos\GlobalGiving\Xml\ExportReader for typed streaming records. Credentials remain in app environment configuration; the standalone client never reads environment variables.

$client->download(Export::ActiveProjects, $xmlPath);
foreach ($reader->read($xmlPath, Export::ActiveProjects) as $project) {
    // $project is a typed Project DTO; optional $project->organization is an Organization DTO.
}

Migration from 1.x

This is a breaking modernization: replace GlobalGivingService and its unstructured array calls with the typed client. featuredProjects() returns Project DTOs; project($id) returns one Project. Full datasets use download(Export::..., $path) and ExportReader::read(). Retired paginated all-project methods, placeholder Twig filters and hasApiKey() are removed. Check configured credentials in application configuration instead.

Signed URLs are never cached. Daily snapshot caching belongs to the importing app. The bundle supplies a dedicated unlogged HttpClient to avoid recording keys and signed URLs in profiler logs. See client docs/contract.md for supported operations and transport/format limitations.

The consuming app is https://github.com/survos-sites/global-giving . Both package directories are registered in the monorepo split workflow; publication follows the normal reviewed monorepo release process.