# matusstafura/magento2-phone-validation

> Phone validation for Magento 2

`composer require matusstafura/magento2-phone-validation`

Canonical URL: https://packagento.com/matusstafura/magento2-phone-validation

## At a glance

- **Vendor**: matusstafura (https://packagento.com/matusstafura.md)
- **Latest version**: v0.2.0 — released 2025-08-03
- **Pricing**: Free
- **Package type**: Magento 2 module
- **Status**: active, accepting new buyers

## Installation

Packagento is licence-gated, so even free packages need a licence on a project before Composer can resolve them.

1. **Sign in or create an account** at https://packagento.com/customer/account/.

2. **Add the package to your account.** Open https://packagento.com/matusstafura/magento2-phone-validation and complete the free checkout. A licence is minted automatically.

3. **Create or pick a project, then activate the licence on it.**
   - Projects represent the Magento installs you deploy to. Manage them at https://packagento.com/projects/.
   - Activate the new licence on the project you'll deploy this package to. Activation is what generates the Composer credentials scoped to that project.

4. **Add the project credentials to your Magento codebase.**

   Grab the project's public + private key from https://packagento.com/projects/ (open the project, then its Credentials tab), and add them to `auth.json`:

   ```json
   {
     "http-basic": {
       "packagento.com": {
         "username": "ppk_live_...",
         "password": "psk_live_..."
       }
     }
   }
   ```

   Add the Packagento Composer repository to `composer.json`:

   ```json
   {
     "repositories": [
       { "type": "composer", "url": "https://packagento.com" }
     ]
   }
   ```

5. **Install and apply.**

   ```bash
   composer require matusstafura/magento2-phone-validation:*
   bin/magento setup:upgrade
   bin/magento setup:di:compile
   bin/magento cache:flush
   ```

## What it does

Phone validation for Magento 2

## README

Problem: Magento 2 allows invalid characters in the phone number field:

<table>
  <tr>
    <td><strong>Fresh Magento 2 installation:</strong><br><img src="./docs/before.jpg" alt="before validation" width="400"/></td>
    <td><strong>Validation with Module:</strong><br><img src="./docs/after.jpg" alt="after validation" width="400"/></td>
  </tr>
</table>

This module adds phone number validation to key Magento 2 forms such as:

- 🛒 Checkout (shipping & billing address)
- 🧑 during Customer registration (todo)

---

### 📦 Installation (via Composer Path Repository)

1. Install via composer(recommended)

```bash
composer require matusstafura/magento2-phone-validation  
````

or clone this module to `app/code/MatusStafura/PhoneValidation`:

```bash
git clone git@github.com:matusstafura/magento2-phone-validation.git 
````

2. Enable and compile module:

```bash
bin/magento module:enable MatusStafura_PhoneValidation
bin/magento setup:upgrade
bin/magento setup:di:compile
bin/magento cache:flush
```

3. Enable / disable in Admin:

Stores > Configuration > Customers > Customer Configuration > Phone Validation

---

### 🤝 Contributing

Contributions are very welcome! If you'd like to improve the module, add features, fix bugs, or improve documentation:

1. Fork the repository
2. Create a new branch:
```bash
  git checkout -b feature/your-feature-name
```
3. Make your changes and commit with clear messages
4. Push to your fork:
```bash
  git push origin feature/your-feature-name
```
5. Open a pull request on GitHub

---

### 📃 License

MIT

---

### Support

[!["Buy Me A Coffee"](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://www.buymeacoffee.com/matusstafura)

## Changelog

All notable changes to this project will be documented in this file.

---

### [v0.2.0] – 2025-08-03
#### Added
- ✅ Admin configuration option to enable/disable validation per store view.

---

### [v0.1.0] – 2025-07-31
#### Added
- 📱 Initial release of the Magento 2 Phone Validation module.
- 🧪 Regex validation for phone numbers (digits only).
- 🛒 Validation support in checkout forms.
- 🌐 Translations: `en_US`, `sk_SK`, `de_DE`, `hu_HU`, `cs_CZ`, `nl_NL`.
- 📸 Before/after validation UI screenshots.
- 📦 Composer support with proper namespace and autoloading.

---

## Recent Versions

| Version | Released |
|---|---|
| v0.2.0 | 2025-08-03 |
| v0.1.0 | 2025-07-30 |

## Dependencies

### Require

| Package | Constraint |
|---|---|
| magento/framework | ^103.0.1 |
| php | >=8.1 |

## Quality

Latest release (v0.2.0) passes the Packagento QA pipeline. Verdicts below are per-cell (Magento line × PHP version) for the matrixed tools, and run-once for the static / security tiers.


### Compatibility

Each Magento line is installed on its supported PHP versions, then the module is built (DI compile + static-content deploy). Cells show passed / failed / untested; staircase gaps render as `–`.

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | Pass | Pass | – | – |
| 2.4.8 | – | Pass | Pass | – |
| 2.4.9 | – | – | Pass | Pass |


### Code Quality

Advisory checks against the module's source. Never affect the Compatibility verdict — a phpcs finding can't make a module incompatible.

#### Static Analysis

Coding standards (phpcs), mess detection (phpmd), copy-pasted code (cpd), PHP cross-version compatibility, composer.json validity. Each runs once for the whole module.

| Tool | Status | Findings | Summary |
|---|---|---|---|
| PHPCS | Warning | 2 | 2 warnings (ruleset: Magento2) |
| PHPMD | Pass | 0 |  |
| Cpd | Pass | 0 |  |
| Composer validate | Pass | 0 |  |

#### PHPStan

Type-checks the module against a real Magento install. Re-runs per Magento + PHP version because resolvable symbols differ between releases.

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | Pass | Pass | – | – |
| 2.4.8 | – | Pass | Pass | – |
| 2.4.9 | – | – | Pass | Pass |


### Tests

Unit and integration suites run per Magento + PHP cell. Test failures speak to the module's behaviour, not its compatibility with a line, so they're reported here separately.

#### Unit Tests

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | N/A | N/A | – | – |
| 2.4.8 | – | N/A | N/A | – |
| 2.4.9 | – | – | N/A | N/A |

#### Integration Tests

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | N/A | N/A | – | – |
| 2.4.8 | – | N/A | N/A | – |
| 2.4.9 | – | – | N/A | N/A |


### Security

Dependency-advisory audit (composer audit) plus a source malware scan. A malware detection fails the version outright.

| Tool | Status | Findings | Summary |
|---|---|---|---|
| Composer audit | Pass | 0 |  |
| Malware scan | Pass | 0 |  |

## Licence and pricing

Free. A licence is still minted on checkout and bound to your project for Composer access — no payment step.

Refundable within 14 days of first purchase via https://packagento.com/account/refunds/.

## Install via Claude Code or any MCP client

The Packagento MCP server can run the licence + project + Composer steps above in one tool call:

```
purchase_and_install_packages(
  composer_names=["matusstafura/magento2-phone-validation"],
  project_id="proj_xxx"
)
```

This handles cart, checkout, licence minting, project activation, and writes auth.json credentials. Connect a client with `claude mcp add packagento https://mcp.packagento.com`. Full setup at https://packagento.com/docs/mcp-setup.

## Vendor

matusstafura is a Magento 2 vendor on Packagento. See https://packagento.com/matusstafura.md for their full catalogue.