PHPackages                             addressfinder/module-magento1 - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility &amp; Helpers](/categories/utility)
4. /
5. addressfinder/module-magento1

ActiveMagento-module[Utility &amp; Helpers](/categories/utility)

addressfinder/module-magento1
=============================

Address Autocomplete for your Magento 1 store by AddressFinder

1.0.3(6y ago)0171[1 PRs](https://github.com/abletech/addressfinder-magento-1/pulls)OSL-3.0JavaScriptPHP ~5.5.22|~5.6.0|~7.0.0|~7.1.0|~7.2.0

Since Nov 14Pushed 5y ago8 watchersCompare

[ Source](https://github.com/abletech/addressfinder-magento-1)[ Packagist](https://packagist.org/packages/addressfinder/module-magento1)[ RSS](/packages/addressfinder-module-magento1/feed)WikiDiscussions master Synced 2d ago

READMEChangelogDependenciesVersions (7)Used By (0)

AddressFinder for Magento 1
===========================

[](#addressfinder-for-magento-1)

Installation
------------

[](#installation)

There are two supported ways to install the module, either via [Composer](https://getcomposer.org) or manually.

### Installation Using Composer

[](#installation-using-composer)

To install the AddresssFinder module for Magento 1, run:

```
composer require addressfinder/module-magento1
composer config extra.magento-root-dir "MAGENTO INSTALLATION DIRECTORY"
composer require magento-hackathon/magento-composer-installer:*
composer run-script post-install-cmd -vvv -- --redeploy

```

The magento-hackathon/magento-composer-installer creates symlinks between the vendor files created by composer, and your magento install. For this to work, you must tell composer where you have installed Magento.

> **Tip**: Don't forget to [enable symlinks](https://magento.stackexchange.com/a/184185) in your Magento installation to enable Composer installation to work. This isn't specific to AddressFinder, but a common "gotcha". [Read more](https://github.com/magento-hackathon/magento-composer-installer/issues/51).

### Manual Installation

[](#manual-installation)

Firstly, [download](https://github.com/AbleTech/addressfinder-magento-1/archive/master.zip) the latest ZIP, then merge the following files/directories into your existing project:

```
app/code/community/AddressFinder
app/design/frontend/base/default/layout/addressfinder.xml
app/design/frontend/base/default/template/addressfinder
app/etc/modules/AddressFinder_AddressFinder.xml
js/addressfinder

```

Clear Cache
-----------

[](#clear-cache)

After installation, it's important to clear any [caches](https://docs.magento.com/m1/ce/user_guide/system-operations/cache-clear.html).

Setup &amp; Usage
-----------------

[](#setup--usage)

Follow the user guide on the AddressFinder website:

- [Australian website](#)
- [New Zealand website](#)

Tmeplates &amp; Events
----------------------

[](#tmeplates--events)

The following templates are exposed:

1. `app/design/frontend/base/default/template/addressfinder/checkout/onepage/billing.phtml` - sets up AddressFinder on the billing step of the checkout.
2. `app/design/frontend/base/default/template/addressfinder/checkout/onepage/shipping.phtml` - sets up AddressFinder on the shpping step of hte checkout.
3. `app/design/frontend/base/default/template/addressfinder/customer/address/form.phtml` - sets up AddressFinder on the customer address management page.

Further, a number of JavaScript events are fired. We've identified the important events:

- `addressfinder:magento:loaded` - when AddressFinder has loaded, used by frontend templates to initialise
- `addressfinder:magento:initialising`
- `addressfinder:magento:initialised`
- `addressfinder:magento:enabling` - when AddressFinder is being enabled as the country is changed (one widget per country)
- `addressfinder:magento:enabled`
- `addressfinder:magento:disabling` - when AddressFinder is being disabled as the country is changed (one widget per country)
- `addressfinder:magento:disabled`
- `addressfinder:magento:refreshing`
- `addressfinder:magento:refreshed`
- `addressfinder:magento:provider:registering` - when a provider is being registered (AU or NZ)
- `addressfinder:magento:widget:registering` - when a widget is being registered for a provider (AU or NZ)
- `addressfinder:magento:result:select` - **when a result is selected**
- `addressfinder:magento:value` - when a value is being set on for the given metadata key, e.g. `city` to `Sydney`.
- `addressfinder:magento:transform`

To attach functionality to these, simply add observers as per the [Prototype 1.7 documentatio](http://api.prototypejs.org/dom/Element/fire/):

```
document.observe('addressfinder:magento:result:select', function (event) {
    // The payload of the event is located in event.memo

    // console.log(event.memo.fullAddress);
    // console.log(event.memo.metaData);
});
```

Testing
-------

[](#testing)

To test this plugin, clone the docker-magento1 repo: . Follow the steps in this project to create your Magento store and test your changes to the AddressFinder plugin.

Module Development
------------------

[](#module-development)

### Installation

[](#installation-1)

To begin development, you will need a copy of Magento installed using Composer. Create the following `composer.json` file in a working directory:

```
{
    "repositories": {
        "firegento": {
            "type": "composer",
            "url": "https://packages.firegento.com"
        }
    },
    "require": {
        "magento-hackathon/magento-composer-installer": "^3.1",
        "aydin-hassan/magento-core-composer-installer": "^1.5",
        "firegento/magento": "v1.9.3.10"
    },
    "minimum-stability": "dev",
    "prefer-stable": true,
    "extra": {
        "magento-root-dir": "./public"
    }
}
```

After you have created this file, simply run `composer install` to setup your Magento 1.9 environment. Of course, you can substitute any version of Magento into the file you've created, we're just using the latest.

From here, clone the repository to a location (such as inside your newly created Magento project):

```
git clone https://github.com/AbleTech/addressfinder-magento-1.git
```

You may now use a [feature of Composer](https://getcomposer.org/doc/05-repositories.md#path) to pull in the locally cloned repository as a Composer dependency. Simply update your `composer.json` file

```
{
    "repositories": {
        "firegento": {
            "type": "composer",
            "url": "https://packages.firegento.com"
        },
        "addressfinder": {
            "type": "path",
            "url": "./module-magento1"
        }
    },
    "require": {
        "magento-hackathon/magento-composer-installer": "^3.1",
        "aydin-hassan/magento-core-composer-installer": "^1.5",
        "firegento/magento": "v1.9.3.10",
        "addressfinder/module-magento1": "*"
    },
    "minimum-stability": "dev",
    "prefer-stable": true,
    "extra": {
        "magento-root-dir": "./public"
    }
}
```

You can now make changes in the module and they will reflect in your Magento store.

### Compilng assets

[](#compilng-assets)

In order to compile assets, simply run (from within the repository):

```
npm install
npm run dev
```

There's also the following tasks which may be of use:

```
# Minitfy assets
npm run production

# Watch and automatically recompile
```

###  Health Score

27

—

LowBetter than 49% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity7

Limited adoption so far

Community14

Small or concentrated contributor base

Maturity60

Established project with proven stability

 Bus Factor2

2 contributors hold 50%+ of commits

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~146 days

Total

4

Last Release

2298d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/25a3496664d9daec343fa8dbae93fce3388e0f7fc6a8d6a8e02656f5b7bc9fa6?d=identicon)[addressfinder](/maintainers/addressfinder)

---

Top Contributors

[![bencorlett](https://avatars.githubusercontent.com/u/181919?v=4)](https://github.com/bencorlett "bencorlett (4 commits)")[![nigelramsay](https://avatars.githubusercontent.com/u/6838?v=4)](https://github.com/nigelramsay "nigelramsay (4 commits)")[![marcusbaguley](https://avatars.githubusercontent.com/u/80579?v=4)](https://github.com/marcusbaguley "marcusbaguley (1 commits)")

### Embed Badge

![Health badge](/badges/addressfinder-module-magento1/health.svg)

```
[![Health](https://phpackages.com/badges/addressfinder-module-magento1/health.svg)](https://phpackages.com/packages/addressfinder-module-magento1)
```

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
