Download the PHP package nks-hub/nette-ruian without Composer
On this page you can find all versions of the php package nks-hub/nette-ruian. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download nks-hub/nette-ruian
More information about nks-hub/nette-ruian
Files in nks-hub/nette-ruian
Package nette-ruian
Short Description Nette extension for RUIAN (Czech Address Registry) API client with caching support
License MIT
Homepage https://github.com/nks-hub/nette-ruian
Informations about the package nette-ruian
Nette RUIAN
Nette extension for RUIAN API - Czech Address Registry (Registr územní identifikace, adres a nemovitostí).
Requirements
- PHP 8.2+
- Nette 3.1+
Installation
Configuration
Register extension in your config.neon:
Getting API Key
Request your free API key at ruian.fnx.io. Free tier allows 1000 requests per hour.
Usage
Inject RuianClient
Validate Address
Address Builder (Progressive Selection)
Build address step by step using cascading selectors:
Municipality Autocomplete (Typeahead)
Search municipalities by name for autocomplete/typeahead functionality:
Combined Queries
Convenience methods for common use cases:
Response DTOs
ValidateResult
ValidatedPlace
Validation Parameters
| Parameter | Description |
|---|---|
municipalityName |
Municipality name |
municipalityId |
RUIAN municipality ID |
municipalityPartName |
Municipality part name |
municipalityPartId |
RUIAN municipality part ID |
zip |
Postal code |
street |
Street or municipality part name |
cp |
Descriptive number (cislo popisne) |
co |
Orientation number (cislo orientacni) |
ce |
Evidence number (cislo evidencni) |
ruianId |
Direct RUIAN address ID lookup |
Caching
Caching is enabled by default to reduce API calls. Cache is stored using Nette's caching system.
To disable caching:
Exception Handling
API Rate Limits
- Free tier: 1000 requests/hour
- No SLA guarantees
Contributing
Contributions are welcome! For major changes, please open an issue first.
- Fork the repository
- Create your feature branch (
git checkout -b feature/amazing-feature) - Commit your changes (
git commit -m 'feat: description') - Push to the branch (
git push origin feature/amazing-feature) - Open a Pull Request
Support
- 📧 Email: [email protected]
- 🐛 Bug reports: GitHub Issues
- 📖 RUIAN API: ruian.fnx.io
License
MIT License — see LICENSE for details.
Made with ❤️ by NKS Hub
All versions of nette-ruian with dependencies
nette/di Version ^3.1
nette/caching Version ^3.2
nette/utils Version ^3.2 || ^4.0
nette/http Version ^3.2