Download the PHP package daveismyname/laravel-companies-house without Composer
On this page you can find all versions of the php package daveismyname/laravel-companies-house. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download daveismyname/laravel-companies-house
More information about daveismyname/laravel-companies-house
Files in daveismyname/laravel-companies-house
Package laravel-companies-house
Short Description A Laravel Companies House package
License MIT
Homepage https://github.com/dcblogdev/laravel-companies-house
Informations about the package laravel-companies-house
Community
There is a Discord community. https://discord.gg/VYau8hgwrm For quick help, ask questions in the appropriate channel.
A Laravel package for reading Companies House.
Documentation and install instructions
Companies House API documentation can be found at: https://developer.company-information.service.gov.uk/api/docs/
Application Register
To use Companies House an application needs creating at https://developer.companieshouse.gov.uk/developer/applications
Install
Take a note of the API key and add it to your .env file
Via Composer
You can publish the config file with:
When published, the config/companieshouse.php config file contains:
Usage
In a controller import the class:
In a view or closure call the facade:
You call CompaniesHouse followed by get:: this will run a GET request followed by the endpoint you want to call, for instance, to call company profile (https://developer.companieshouse.gov.uk/api/docs/company/company_number/company_number.html)
To make things a little easier there is also trait classes provided:
Each Trait class provides convenient methods that call the endpoints, processes the data, and returns JSON of the results.
Search
Search across all indexed information.
Searches companies
Search Officer
Search Officer Disqualified
Companies
Get Company
Get Company Address
Get Company Officer
Get Company Filing
Get Company Filing Item
Get Company Insolvency
Get Company Charge
Get Company Charge Item
Get Company Establishment
Get Company Register
Get Company Exemption
Officer
Get Officer Appointment
Get Officer Disqualification
Get Officer Disqualification Corp
Change log
Please see the changelog for more information on what has changed recently.
Contributing
Contributions are welcome and will be fully credited.
Contributions are accepted via Pull Requests on Github.
Pull Requests
-
Document any change in behaviour - Make sure the
readme.md
and any other relevant documentation are kept up-to-date. -
Consider our release cycle - We try to follow SemVer v2.0.0. Randomly breaking public APIs is not an option.
- One pull request per feature - If you want to do more than one thing, send multiple pull requests.
Security
If you discover any security related issues, please email [email protected] email instead of using the issue tracker.
License
license. Please see the license file for more information.