PHP download

Download the PHP package nyoncode/laravel-ares without Composer

On this page you can find all versions of the php package nyoncode/laravel-ares. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

Table of contents
Download nyoncode/laravel-ares
More information about nyoncode/laravel-ares
Files in nyoncode/laravel-ares

Vendor nyoncode
Package laravel-ares
Short Description Laravel package for the Czech ARES business register API with caching, events, validation and artisan tooling.
License MIT

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:

If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.

Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
To use Composer is sometimes complicated. Especially for beginners.
Composer needs much resources. Sometimes they are not available on a simple webspace.
If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.

Please rate this library. Is it a good library?

Example code of nyoncode/laravel-ares

Informations about the package laravel-ares

laravel-ares

laravel-ares is a Laravel package for the Czech ARES business register API. It provides a typed client, a facade, configurable caching, lookup events, ICO validation, static analysis support, and an artisan command for diagnostics.

Features

Typed public API through AresClientInterface
Ares facade with convenience methods for common workflows
Structured domain objects instead of one large flat payload object
Configurable caching and HTTP timeouts
Events for successful and failed lookups
ICO normalization and checksum validation
Explicit exceptions for invalid ICO and missing companies
Subject indexing with database-backed autocomplete search
Pest test suite, PHPStan configuration, and GitHub Actions CI

Requirements

PHP 8.2+
Laravel 11, 12, or 13

Installation

Install the package with Composer:

Publish the configuration file if you want local overrides:

Configuration

Key	Default	Description
`api_url`	`https://ares.gov.cz/ekonomicke-subjekty-v-be/rest`	Base URL for the ARES REST API
`cache.enabled`	`true`	Enable response caching; set to `false` to disable caching entirely
`cache.ttl`	`86400`	Cache lifetime for successful lookups in seconds
`cache.store`	`null`	Cache store to use (`null` = default store)
`cache.prefix`	`ares:v1:company:`	Prefix for ARES cache keys
`log_channel`	`stack`	Laravel log channel used for client errors
`http_options.timeout`	`5.0`	Request timeout in seconds
`http_options.connect_timeout`	`3.0`	Connection timeout in seconds
`indexing.enabled`	`true`	Enable subject indexing and search
`indexing.auto_index`	`true`	Automatically index subjects on successful lookup
`indexing.stale_days`	`30`	Number of days before a record is considered stale

Environment overrides:

ARES_API_URL
ARES_CACHE_ENABLED
ARES_CACHE_TTL
ARES_CACHE_STORE
ARES_CACHE_PREFIX
ARES_LOG_CHANNEL
ARES_HTTP_TIMEOUT
ARES_HTTP_CONNECT_TIMEOUT
ARES_INDEXING_ENABLED
ARES_AUTO_INDEX
ARES_STALE_DAYS

Usage

Use dependency injection when you want explicit contracts:

Use the facade for concise application code:

Public API:

findCompany(string $ic): ?CompanyData
findCompanyRaw(string $ic): ?array
findCompanyOrFail(string $ic): CompanyData
forgetCompany(string $ic): bool
isValidIc(string $ic): bool
normalizeIc(string $ic): string
search(string $query, int $limit = 10): Collection<SubjectData>

Domain Model

Successful lookups return NyonCode\Ares\Data\CompanyData:

Related DTOs:

AddressData models the registered office
DeliveryAddressData models the mailing address
RegistrationData groups legal form, dates, source, file mark, NACE codes, and source statuses
RegistrationStatusData represents one registry source status
RegistrationSourceState is a typed enum for known ARES status values
SubjectData is a lightweight DTO for autocomplete search results (ic, name, city)

rawData remains available as an escape hatch for fields the package does not map yet.

Exceptions

The fail-fast API throws explicit domain exceptions:

NyonCode\Ares\Exceptions\InvalidIcException
NyonCode\Ares\Exceptions\CompanyNotFoundException

Malformed payloads are treated as failed lookups internally and surface through the failure event path.

Events

The package dispatches:

NyonCode\Ares\Events\CompanyLookupSucceeded
NyonCode\Ares\Events\CompanyLookupFailed

Subject Indexing and Autocomplete

The package can index looked-up subjects into a local database table for fast autocomplete search.

Run the migration after installing:

Search indexed subjects by name or IC:

Each result is a SubjectData with ic, name, and city properties.

Auto-indexing

When indexing.auto_index is enabled (default), every successful findCompany() call dispatches a queued job that indexes the subject automatically. No extra code needed.

Manual Indexing

Schedule the refresh in your application's scheduler for automatic maintenance:

Artisan Commands

The package includes artisan commands for diagnostics and indexing:

ares:test renders a compact company summary including DIC, source, dates, registered office, delivery address, and register metadata.

Quality Gates

Run the automated tests:

Run static analysis:

Run the formatter:

The repository includes a GitHub Actions workflow for:

PHP/Laravel compatibility matrix tests
PHPStan on the quality lane
Pint on the quality lane

Development Notes

Successful lookups are cached under the ares:v1:company:{ic} key format.
Invalid ICO values are rejected before any HTTP request is sent.
forgetCompany() invalidates cache entries using normalized ICO values.
Failed HTTP responses, malformed payloads, and transport exceptions all dispatch CompanyLookupFailed.
Auto-indexed subjects are stored in the ares_subjects table with a minimal footprint (ic, name, city, indexed_at).
Search uses LIKE queries with database indexes for fast prefix/substring matching.

License

The package is open-sourced under the MIT license.

All versions of laravel-ares with dependencies

PHP Build Version

Package Version

Version 1.1.0 Release 30. Jun 2026
create-project require 0 people chose require and
0 people chose create-project.

Download

Download latest version of laravel-ares from vendor nyoncode

Requires php Version ^8.2
illuminate/contracts Version ^11.0|^12.0|^13.0
illuminate/http Version ^11.0|^12.0|^13.0
illuminate/support Version ^11.0|^12.0|^13.0
guzzlehttp/guzzle Version ^7.0
nyoncode/laravel-package-toolkit Version ^2.0

Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package nyoncode/laravel-ares contains the following files

Loading the files please wait ...