Download the PHP package hireatlas/super-funds without Composer
On this page you can find all versions of the php package hireatlas/super-funds. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download hireatlas/super-funds
More information about hireatlas/super-funds
Files in hireatlas/super-funds
Package super-funds
Short Description Pull the latest list of superannuation funds directly from the Australian Government, right into your Laravel application.
License MIT
Informations about the package super-funds
Fetch the list of Australian superannuation funds straight from the government
This package is a fairly lightweight Laravel wrapper around the service provided by the Australian government that lists all superannuation funds and products by their identifier (USI).
You can find the download here, and structural information about the download here.
We download the text file from this URL, then parse it into some DTOs which you can then save in your database, or use however you wish.
Installation
This package supports Laravel 10+, and PHP 8.1+.
Usage
Fetching the list of super funds as DTOs
To fetch the list of current super funds, you can call the fetch()
method on the SuperFunds
class. This will return a Collection of SuperFundDTO
objects.
Persisting the list of super funds as Eloquent models to your database
The package publishes a migration to store the super funds as Eloquent models in your database, so be sure to run php artisan migrate
first before running the below.
To fetch and persist the list of current super funds to the database, you can call the persist()
method on the SuperFunds
class.
Using a custom Eloquent model
You can use a custom Eloquent model by calling the useModel()
method on the SuperFunds
class. You should call this from the boot()
method in your App\Providers\AppServiceProvider
.
Disabling migrations
If you don't wish to use the default migration, or don't wish to persist models at all, then you can call the ignoreMigrations()
method on the SuperFunds
class. You should call this from the boot()
method in your App\Providers\AppServiceProvider
.
Regularly fetching the current list via task scheduling
The package includes both a command and a job for you to invoke from your App\Console\Kernel
. They're equivalent, so use whichever method your prefer.
To avoid overloading the upstream service, please pick a random time of the day to fetch the list.
Testing
Changelog
Please see CHANGELOG for more information on what has changed recently.
Security Vulnerabilities
Please review our security policy on how to report security vulnerabilities.
Credits
- Mitchell Davis
- All Contributors
License
The MIT License (MIT). Please see License File for more information.
All versions of super-funds with dependencies
illuminate/database Version ^10.0
illuminate/http Version ^10.0
illuminate/support Version ^10.0