https://github.com/yii-extension/simple-model

Simple Model for PHP.
https://github.com/yii-extension/simple-model

formmodel model php yii2 yii3

Last synced: 25 days ago
JSON representation

Simple Model for PHP.

• Host: GitHub
• URL: https://github.com/yii-extension/simple-model
• Owner: yii-extension
• License: bsd-3-clause
• Created: 2021-05-28T14:03:57.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2023-09-05T06:38:18.000Z (over 1 year ago)
• Last Synced: 2024-06-29T03:08:29.218Z (6 months ago)
• Topics: formmodel, model, php, yii2, yii3
• Language: PHP
• Homepage:
• Size: 143 KB
• Stars: 1
• Watchers: 3
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: changelog.md
  • License: LICENSE.md
  • Code of conduct: .github/CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        


    

        

    

    
Simple Model

    


[![Total Downloads](https://poser.pugx.org/yii-extension/simple-model/downloads.png)](https://packagist.org/packages/yii-extension/simple-model)

[![Build Status](https://github.com/yii-extension/simple-model/workflows/build/badge.svg)](https://github.com/yii-extension/simple-model/actions?query=workflow%3Abuild)

[![codecov](https://codecov.io/gh/yii-extension/simple-model/branch/master/graph/badge.svg?token=WQI25yo4d3)](https://codecov.io/gh/yii-extension/simple-model)

[![Mutation testing badge](https://img.shields.io/endpoint?style=flat&url=https://badge-api.stryker-mutator.io/github.com/yii-extension/simple-model/master)](https://dashboard.stryker-mutator.io/reports/github.com/yii-extension/simple-model/master)

[![static analysis](https://github.com/yii-extension/simple-model/workflows/static%20analysis/badge.svg)](https://github.com/yii-extension/simple-model/actions?query=workflow%3A%22static+analysis%22)

[![type-coverage](https://shepherd.dev/github/yii-extension/simple-model/coverage.svg)](https://shepherd.dev/github/yii-extension/simple-model)

## Installation

```shell

composer require yii-extension/simple-model

```

## Usage

You can create two types of classes, they are `Model::class` and `FormModel::class` through inheritance.

[Model::class](/docs/Model.md) is the base class for all models.

[FormModel::class](/docs/FormModel.md) is the base class for all form models, defined methods are:

### Unit testing

The package is tested with [PHPUnit](https://phpunit.de/). To run tests:

```shell

./vendor/bin/phpunit

```

### Mutation testing

The package tests are checked with [Infection](https://infection.github.io/) mutation framework. To run it:

```shell

./vendor/bin/roave-infection-static-analysis-plugin -j2 --ignore-msi-with-no-mutations --only-covered

```

## Static analysis

The code is statically analyzed with [Psalm](https://psalm.dev/docs). To run static analysis:

```shell

./vendor/bin/psalm

```

### License

The `yii-extension/simple-model` is free software. It is released under the terms of the BSD License.

Please see [`LICENSE`](./LICENSE.md) for more information.

Maintained by [Yii Extension](https://github.com/yii-extension).

## Support the project

[![Open Collective](https://img.shields.io/badge/Open%20Collective-sponsor-7eadf1?logo=open%20collective&logoColor=7eadf1&labelColor=555555)](https://opencollective.com/yiisoft)

## Powered by Yii Framework

[![Official website](https://img.shields.io/badge/Powered_by-Yii_Framework-green.svg?style=flat)](https://www.yiiframework.com/)