PHPackages                             ridwanpr/string-masker - 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. [Security](/categories/security)
4. /
5. ridwanpr/string-masker

ActiveLibrary[Security](/categories/security)

ridwanpr/string-masker
======================

A php library for masking sensitive data (e.g., credit card numbers, emails, etc.) based on specific patterns.

1.0.0(1y ago)15MITPHPPHP >=7.4

Since Oct 24Pushed 1y ago1 watchersCompare

[ Source](https://github.com/ridwanpr/string-masker)[ Packagist](https://packagist.org/packages/ridwanpr/string-masker)[ RSS](/packages/ridwanpr-string-masker/feed)WikiDiscussions main Synced 1mo ago

READMEChangelogDependenciesVersions (2)Used By (0)

String Masker
=============

[](#string-masker)

A php library for masking sensitive data (e.g., credit card numbers, emails, etc.) based on specific patterns.

Features
--------

[](#features)

- **Customizable Masking Patterns**: Easily configure how text should be masked (e.g., showing last 4 digits of a credit card, obfuscating email domains).
- **Support for Various Data**: Works with different types of text, such as emails, passwords, phone numbers, and more.
- **Locale-aware Formatting**: Supports formatting for phone numbers based on locale.
- **Mask Specific Words or Phrases**: Mask out specific words or phrases in a text.

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

[](#installation)

You can install this package via Composer. Run the following command in your terminal:

```
composer require ridwanpr/string-masker
```

Usage
-----

[](#usage)

### Email Masker

[](#email-masker)

The `EmailMasker` class allows you to mask parts of an email address.

```
use Ridwan\StringMasker\EmailMasker;

$email = "user@example.com";
$maskedEmail = EmailMasker::maskEmail($email, [
    'local' => ['mask' => '*', 'start' => 0, 'length' => 3],
    'domain' => ['mask' => '*', 'start' => 0, 'length' => 3],
    'maskAll' => null // Options: 'local', 'domain', 'both'
]);
echo $maskedEmail; // Outputs: "***r@***ple.com"
```

**Options**:

- `local`: An associative array to specify how to mask the local part of the email.
    - `mask`: Character to use for masking (default: '\*').
    - `start`: Starting position to begin masking (default: 0).
    - `length`: Number of characters to mask (default: 1).
- `domain`: An associative array to specify how to mask the domain part of the email.
    - `mask`: Character to use for masking (default: '\*').
    - `start`: Starting position to begin masking (default: 0).
    - `length`: Number of characters to mask (default: 1).
- `maskAll`: Can be set to 'local', 'domain', or 'both' to mask the entire local or domain part.

### Credit Card Masker

[](#credit-card-masker)

The `CreditCardMasker` class is used to mask credit card numbers.

```
use Ridwan\StringMasker\CreditCardMasker;

$cardNumber = "1234-5678-9012-3456";
$maskedCardNumber = CreditCardMasker::maskCardNumber($cardNumber, [
    'maskAll' => false,
    'mask' => '*',
    'positions' => [1, 2, 5],
    'showDashes' => true
]);
echo $maskedCardNumber;
```

**Options**:

- `mask`: Character to use for masking (default: '\*').
- `maskAll`: Set to true to mask the entire credit card number.
- `positions`: Array of positions to mask.
- `showDashes`: Set to true to display dashes for readability.

### Phone Masker

[](#phone-masker)

The `PhoneMasker` class can mask phone numbers based on specified rules.

```
use Ridwan\StringMasker\PhoneMasker;

$phone = "+621234567890";
$maskedPhone = PhoneMasker::maskPhone($phone, [
    'maskAll' => false,
    'mask' => '*',
    'positions' => [3, 4, 5]
]);
echo $maskedPhone;
```

**Options**:

- `mask`: Character to use for masking (default: '\*').
- `maskAll`: Set to true to mask the entire phone number.
- `positions`: Array of positions to mask.

### Text Masker

[](#text-masker)

The `TextMasker` class masks specified positions in a given text based on specified rules.

```
use Ridwan\StringMasker\TextMasker;

$text = "Hello, World!";
$maskedText = TextMasker::maskText($text, [
    'maskAll' => false,
    'mask' => '*',
    'positions' => [0, 7],
    'separators' => [' ', ',', '!']
]);
echo $maskedText;
```

**Options**:

- `mask`: Character to use for masking (default: '\*').
- `maskAll`: Set to true to mask the entire text.
- `positions`: Array of positions to mask.
- `separators`: Array of characters to maintain as separators (e.g., spaces, commas).

### Content Masker

[](#content-masker)

The `ContentMasker` class masks specific words or phrases in a text.

```
use Ridwan\StringMasker\ContentMasker;

$message = "My bank account number is 12345678 and my password is secret.";
$maskedMessage = ContentMasker::maskContent($message, [
    'mask' => '*',
    'words' => ['bank account', 'password'],
]);
echo $maskedMessage;
```

**Options**:

- `mask`: Character to use for masking (default: '\*').
- `words`: Array of words or phrases to mask in the text.

License
-------

[](#license)

This library is open-source software licensed under the MIT License.

###  Health Score

24

—

LowBetter than 32% of packages

Maintenance37

Infrequent updates — may be unmaintained

Popularity5

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity39

Early-stage or recently created project

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

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

Unknown

Total

1

Last Release

572d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/030d74e6d38c3028b4a0bbd3ba6655a18cf2de199c393b3672442bad22be2f5f?d=identicon)[ridwan](/maintainers/ridwan)

---

Top Contributors

[![ridwanpr](https://avatars.githubusercontent.com/u/184870801?v=4)](https://github.com/ridwanpr "ridwanpr (5 commits)")

### Embed Badge

![Health badge](/badges/ridwanpr-string-masker/health.svg)

```
[![Health](https://phpackages.com/badges/ridwanpr-string-masker/health.svg)](https://phpackages.com/packages/ridwanpr-string-masker)
```

###  Alternatives

[defuse/php-encryption

Secure PHP Encryption Library

3.9k162.4M214](/packages/defuse-php-encryption)[mews/purifier

Laravel 5/6/7/8/9/10 HtmlPurifier Package

2.0k16.7M113](/packages/mews-purifier)[robrichards/xmlseclibs

A PHP library for XML Security

41478.1M118](/packages/robrichards-xmlseclibs)[bjeavons/zxcvbn-php

Realistic password strength estimation PHP library based on Zxcvbn JS

87117.5M63](/packages/bjeavons-zxcvbn-php)[illuminate/encryption

The Illuminate Encryption package.

9229.7M280](/packages/illuminate-encryption)[paragonie/hidden-string

Encapsulate strings in an object to hide them from stack traces

7410.6M39](/packages/paragonie-hidden-string)

PHPackages © 2026

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