PHPackages                             ancor/yii2-bitmask - 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. [Validation & Sanitization](/categories/validation)
4. /
5. ancor/yii2-bitmask

ActiveYii2-extension[Validation & Sanitization](/categories/validation)

ancor/yii2-bitmask
==================

Bit mask behavior and validators for models

610.1k↑16.7%PHP

Since Mar 17Pushed 10y ago1 watchersCompare

[ Source](https://github.com/ancor-dev/yii2-bitmask)[ Packagist](https://packagist.org/packages/ancor/yii2-bitmask)[ RSS](/packages/ancor-yii2-bitmask/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependenciesVersions (1)Used By (0)

Bitmask Behavior and Validators for Yii 2
=========================================

[](#bitmask-behavior-and-validators-for-yii-2)

Описание
--------

[](#описание)

Расширение предназначено для работы с битовыми масками.

На пример, вы хотите хранить значения нескольких переключателей в поле типа int.

Возникает ряд вопросов:

- Как в соответствии со сценариями разрешить присваивать\\снимать только некоторые биты, а остальные запретить
- Как привязать input\[type=checkbox\] теги к соответствующим битам
- Где хранить подписи для полей ввода
- Как выводить отмеченные биты
- Как удобно проверить наличие бита в поле у модели
- Ну и наконец как удобно ставить\\снимать бит

**yii2-bitmask** дает решает все эти вопросы

Feel free to let me know what else you want added via:

- [Issues](https://github.com/ancor-dev/yii2-bitmask/issues)

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

[](#installation)

The preferred way to install this extension is through [composer](http://getcomposer.org/download/).

Either run

```
$ php composer.phar require ancor/yii2-bitmask
```

or add

```
"ancor/yii2-bitmask": "dev-master"

```

to the `require` section of your `composer.json` file.

### Расширение содержит три класса

[](#расширение-содержит-три-класса)

- [BitmaskBehavior](#bitmaskbehavior) - создание полей модели на основе битовой маски
- [BitmaskValidator](#bitmaskvalidator) - валидация основанная на битах
- [BitmaskFieldsValidator](#bitmaskfieldsvalidator) - валидация основанная на названиях полей

BitmaskBehavior
---------------

[](#bitmaskbehavior)

### Настройка модели

[](#настройка-модели)

```
use ancor\bitmask\BitmaskBehavior;

/**
 * @property integer $options
 * ...
 * @property string $spamOption
 * @property string $deletedOption
 * ...
 */
class User extends \yii\db\ActiveRecord
{
    const OPT_SPAM    = 1 [
                    'spamOption'    => static::OPT_SPAM,
                    'deletedOption' => static::OPT_DELETED,
                ],
                // 'bitmaskAttribute' => 'options', // an attribute which is the mask itself
            ],
        ];
    }

    public function rules()
    {
        return [
            [['spamOption', 'deletedOption'], 'safe'],
        ];
    }

    public function attributeLabels()
    {
        return [
            ...
            'spamOption'       => 'This user is spammer',
            'emailNotVerified' => 'User is deleted',
            ...
        ];
    }
}
```

### Пример использования

[](#пример-использования)

```
$model = new User();

echo $model->options; // 0

// Назначить бит
$model->spamOption = true; // $model->options == User::OPT_SPAM == 1options | User::OPT_SPAM;
// Внимание! При присваивании значения - любое значение принудительно преобразуется в boolean

// Снять бит
$model->spamOption = false; // $model->options == 0
// Это эквивалентно следующей строке
$model->options = $model->options & ~User::OPT_SPAM;

// Проверить наличие бита
if ($model->spamOption) ...
// Это эквивалентно следующей строке
if ($model->options & User::OPT_SPAM) ...
```

### Групповое присвоение

[](#групповое-присвоение)

```
// Предположим пришла форма
$post = [
    'User' => [
        ...
        'spamOption'    => false,
        'deletedOption' => true,
        ...
    ],
];

/**
 * Загрузка одной коммандой
 */
echo $model->options; // 0
$model->load($post);

echo $model->options; // $model->options == 1deletedOption); // true

/**
 * Пример БЕЗ BitmaskBehavior, при отправке той же самой формы
 * Предположим что в модели объявлены 2 свойства
 *   public $spamOption;
 *   public $deletedOption;
 */

echo $model->options; // 0
$model->load($post);

// Свойство options, конечно же осталось без изменений
echo $model->options; // 0

if ($post['User']['spamOption']) {
	$model->options |= User::OPT_SPAM;
} else {
	$model->options &= ~User::OPT_SPAM;
}
if ($post['User']['deletedOption']) {
	$model->options |= User::OPT_DELETED;
} else {
	$model->options &= ~User::OPT_DELETED;
}
```

### Пример шаблона с использованием ActiveForm

[](#пример-шаблона-с-использованием-activeform)

```
$form->field($model, 'spamOption')->checkbox();
$form->field($model, 'deletedOption')->checkbox();
```

**Примечание:** Если вы хотите запретить менять некоторые биты - то просто не нужно перечислять их в валидаторе `safe`

### Новые методы и свойства модели

[](#новые-методы-и-свойства-модели)

`php public integer[] getBitmaskFields(void) `

Метод возвращает массив с наименованиями полей и соответствующими им битами. *Без значений по умолчанию*

Пример ответа(в нашем случае):

```
[
    'spamOption'    => 1, // 1 2, // 1 false,
    'deletedOption' => true,
]
```

`php public boolean getOldBit(string $field) `Возвращает значение "старого" атрибута. (Работает через вызов `->getOldAttribute()`)

### Собственные статические методы поведения

[](#собственные-статические-методы-поведения)

#### Добавить бит в маску\\Убрать биз из маски

[](#добавить-бит-в-маскуубрать-биз-из-маски)

```
public static integer modifyBitmask(int $mask, int $bit, boolean $exists)
```

```
$mask = 0b00100001;
$bit  = 0b00000100;

// Добавить бит
$options = BitmaskBehavior::modifyBitmask($mask, $bit, true); // 0b00100101
// Убрать бит
$options = BitmaskBehavior::modifyBitmask($mask, $bit, false); // 0b00100001
```

#### Получить массив битов на основе битовой маски

[](#получить-массив-битов-на-основе-битовой-маски)

```
public static boolean[] parseBitmask(int $mask, int[] $fields)
```

```
$mask = 0b00100000;
$fields = [
    'firstOption'  => 0b00000001,
    'secondOption' => 0b00100000,
];

$values = BitmaskBehavior::parseBitmask($mask, $fields);
print_r($values); // ['firstOption' => false, 'secondOption' => true]
```

#### Создать битовую маску на основе массива битов

[](#создать-битовую-маску-на-основе-массива-битов)

`php public static int makeBitmask(boolean[] $values, int[] $fields) `

```
$fields = [
    'firstOption'  => 0b00000001,
    'secondOption' => 0b00100000,
];
$values = [
    'firstOption'  => false,
    'secondOption' => true
];

$mask = BitmaskBehavior::makeBitmask($values, $fields);
echo $mask; // 0b00100000
```

BitmaskValidator
----------------

[](#bitmaskvalidator)

**Описание:** Позволяет указать какие биты можно менять в маске, а какие нельзя.

**Примечание:** Этот валидатор можно использовать без BitmaskBehavior.

```
public function rules()
{
    return [
        ['options', BitmaskValidator::className(), 'mask' => 1 static::OPT_SPAM],
    ];
}
```

BitmaskFieldsValidator
----------------------

[](#bitmaskfieldsvalidator)

**Описание:**

- Этот валидатор поход на `BitmaskValidator`.
- Предназначен для использования в паре с `BitmaskBehavior`.
- Используется вместо `safe` валидатора. Но это не все.
- Валидатор точно так же как `BitmaskValidator` блокирует изменение всех битов к кроме тех к которым валидатор применен.

**Пример использования**

```
return [
    [
        ['spamOption', 'deletedOption'],
        BitmaskFieldsValidator::className(),
        // 'maskAttribute' => 'options', // По умолчанию
    ],
];
```

###  Health Score

27

—

LowBetter than 49% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity28

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity41

Maturing project, gaining track record

 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.

### Community

Maintainers

![](https://www.gravatar.com/avatar/11b715dbbb813e6d3cd3c1bba6a6f7b8af7ffb0aa9d1b1a46a11910a2c41cb45?d=identicon)[ancor.dev](/maintainers/ancor.dev)

---

Top Contributors

[![Ancor-dev](https://avatars.githubusercontent.com/u/180199345?v=4)](https://github.com/Ancor-dev "Ancor-dev (6 commits)")

### Embed Badge

![Health badge](/badges/ancor-yii2-bitmask/health.svg)

```
[![Health](https://phpackages.com/badges/ancor-yii2-bitmask/health.svg)](https://phpackages.com/packages/ancor-yii2-bitmask)
```

###  Alternatives

[webmozart/assert

Assertions to validate method input/output with nice error messages.

7.6k894.0M1.2k](/packages/webmozart-assert)[bensampo/laravel-enum

Simple, extensible and powerful enumeration implementation for Laravel.

2.0k15.9M104](/packages/bensampo-laravel-enum)[swaggest/json-schema

High definition PHP structures with JSON-schema based validation

48612.5M73](/packages/swaggest-json-schema)[stevebauman/purify

An HTML Purifier / Sanitizer for Laravel

5325.6M19](/packages/stevebauman-purify)[ashallendesign/laravel-config-validator

A package for validating your Laravel app's config.

217905.3k5](/packages/ashallendesign-laravel-config-validator)[crazybooot/base64-validation

Laravel validators for base64 encoded files

1341.9M8](/packages/crazybooot-base64-validation)

PHPackages © 2026

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