sikessem/values

This package is abandoned and no longer maintained. No replacement package was suggested.

Objects with strict types to manage PHP variables and values.

0.x-dev 2024-09-27 16:57 UTC

Requires

• php: ^8.2||^8.3

Requires (Dev)

• sikessem/devtools: ^0.8.0

MIT

• SIGUI Kessé Emmanuel

• php
• values
• sikessem

README

PHP Value Objects

Objects with strict types to manage PHP variables and values.

Warning

This package is no longer maintained. Please use sikessem/core instead.

🔖 Contents

• PHP Value Objects
  • 🔖 Contents
  • 📋 Requirements
  • 🎉 Getting Started
    • ⚡️ Installation
    • 🧑‍💻 Usage
    • 🧪 Testing and debugging
  • 📖 Documentation
  • 👏 Contribution
    • 👷 Code of Conduct
    • 👥 Contributing Guide
    • 🔒️ Good First Issues
    • 💬 Discussions
  • 🔐 Security Reports
  • 📄 License

📋 Requirements

• Requires PHP >=8.0 (at least 8.0.30 recommended to avoid potential bugs).
• Requires Composer v2+ to manage PHP dependencies.

🎉 Getting Started

⚡️ Installation

Use Composer to install sikessem/values:

composer require sikessem/values

🧑‍💻 Usage

<?php

use Sikessem\Values\Value;

$two = Value::from(2); // 2
$two->update(fn($val) => $val * $val); // 4
$two->set(5); // 5

🧪 Testing and debugging

🧹 Keep a modern codebase with Pint:

composer lint

⚗️ Run static analysis:

• Using PHPStan:

composer analyse

• Using Psalm:

composer inspect

✅ Run unit tests using PEST

composer test

🐛 Check all code bugs:

composer debug

🚀 Fix the entire code:

composer fix

📖 Documentation

The full documentation for the Sikessem Values can be found on this address.

👏 Contribution

The main purpose of this repository is to continue evolving Sikessem. We want to make contributing to this project as easy and transparent as possible, and we are grateful to the community for contributing bug fixes and improvements. Read below to learn how you can take part in improving Sikessem.

👷 Code of Conduct

Sikessem has adopted a Code of Conduct that we expect project participants to adhere to. Please read the full text so that you can understand what actions will and will not be tolerated.

👥 Contributing Guide

Read our Contributing Guide to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to Sikessem.

🔒️ Good First Issues

We have a list of good first issues that contain bugs which have a relatively limited scope. This is a great place to get started, gain experience, and get familiar with our contribution process.

💬 Discussions

Larger discussions and proposals are discussed in Sikessem's GitHub discussions.

🔐 Security Reports

If you discover a security vulnerability within Sikessem, please email SIGUI Kessé Emmanuel at [e-mail]. All security vulnerabilities will be promptly addressed.

📄 License

The Sikessem Values is open-sourced software licensed under the MIT License - see the LICENSE file for details.

_{Made with ❤︎ by @siguici.}