Download the PHP package voyage/silverstripe-nzpost-addressfinder without Composer

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

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 voyage/silverstripe-nzpost-addressfinder

Informations about the package silverstripe-nzpost-addressfinder

NZ Post Address Finder

Address finder module for NZ Post API.

This is currently using the 1.0-client version of the API. All requests require your client_id and client_secret and does not use the Oauth implementation as in 1.0.

Getting started

Sign up with NZ Post for API access. Grab your client_id and client_secret and add to your config.yml file

This module comes with both the AddressFinderField for use in your own Forms as well as the EditableAddressFinderField for use in Userforms.

Form Field

Add the AddressFinderField in your Form like below. Make sure you add setFieldMap and include the fields you want to map the returned results to. The key should always be your form field ID and the value will be the NZ Post field (these values can be found below or in the NZ Post API documentation).

Userforms Field

This module comes with a field for use in Userforms. The EditableAddressFinderField adds a mapping tab to the edit view of the field. Where you can add multiple mappings.

Each mapping requires the user forms field ID or name as well as a corresponding NZ Post value to grab.

Content Editors

When using the Userforms Field, content editors need to manually select the fields they want mapped via the CMS.

On the Field editing view, there is a tab for Mappings. From here a content editor can add a new field mapping and match another Userform Field ID/Name to an NZ Post Field ID.

The name for a userform field can be found in the Fields main tab.

Field Mappings

The following fields are available from NZ Post for mapping. The values shown are just examples based on the returned response.

Contributing

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request :D

Acknowledgements

Silverstripe Google Address Field - Inspiration for mapping field values

License

TODO

All versions of silverstripe-nzpost-addressfinder with dependencies

PHP Build Version
Package Version
Requires php Version >=5.4
composer/installers Version *
silverstripe/framework Version >=3.5.0
guzzlehttp/guzzle Version ^6.3
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 voyage/silverstripe-nzpost-addressfinder contains the following files

Loading the files please wait ....