README

Equation is php library for conversion qty by conversion ladder of units.

Table of Contents

• Table of Contents
• Introduce
• Getting Started
  • Requirement
  • Project Structure
  • Installation
• Basic Usage
  • Use the class
  • Function And Method
• Advance Usage
• Authors
• License

Introduce

Dalam mengembangkan aplikasi yang mencatat data kuantitas barang dan bahan baku, sering kali kita dihadapkan permasalahan jumlah kuantitas berdasarkan satuan yang berbeda untuk barang yang sama. Contoh Transaksi:

• Pembelian Minyak sebanyak 1 liter
• Produksi sebuat produk menggunakan Minyak sebanyak 100 mililiter

Berdasarkan data transaksi diatas, sering kali kita diminta untuk membuat laporan sisa ketersedian Minyak tersebut. Untuk membuat data yang valid, maka dibutuhkan sebuah library yang dapat membantu untuk memudahkan proses konversi kuantitas dalam satuan yang berbeda. Equation bermaksud untuk menjadi alat bantu konversi satuan pada barang agar dapat membantu memudahkan seorang software developer dalam mengembangkan sebuah aplikasi. Selamat menggunakan, semoga bermanfaat.

Getting Started

Requirement

• PHP Version >= 7.4
• Composer

Project Structure

Equation
├── src
│	├── Data
│	│	└── DefaultUnit.php
│	├── Example
│	│	├── data.json
│	│	└── index.php
│	└── Equation.php
├── .gitignore
├── composer.json
├── LICENSE
└── README.md

Installation

Run composer via cli. See composer documentation.

composer require yudhaang/equation

Basic Usage

Use the class

Include the class into your php file and initialize to variable.

• Open your file in your project : example : path_of_your_project/index.php
• Write this code to include the class :

  <?php
  require __DIR__ . '/vendor/autoload.php';
  use yudhaAng/Equation;
  

• Initialize object variable :

  $units_data = [
      ['name'=>'kg', 'qty' => 1],
      ['name'=>'hg', 'qty' => 10],
      ['name'=>'dag', 'qty' => 10],
      ['name'=>'g', 'qty' => 10],
      ['name'=>'dg', 'qty' => 10],
      ['name'=>'mg', 'qty' => 10]
  ];
  $options = [
      'units' => $units_data
  ];
  $equation = new Equation($options);
  

Function and Method

• Convert

  $equation = new Equation($options);
  
  $qty = 1.745;
  $from_unit = 'kg';
  $to_unit = 'g';
  $output = $equation->convert($qty, $from_unit, $to_unit); 
  // Output Number = 1745
  
  $qty = 1245;
  $from_unit = 'g';
  $to_unit = 'dag';
  $output = $equation->convert($qty, $from_unit, $to_unit); 
  // Output Number = 124.5
  

• Render Text

  $equation = new Equation($options);
  
  $qty = 1.745;
  $unit = 'kg';
  $output = $equation->renderText($qty, $unit);
  // Output String = 1 kg, 7 hg, 4 dag, 5 g
  

• Convert Text

  $equation = new Equation($options);
  
  // Unspecific unit output
  $text = '1 kg, 7 hg, 4 dag, 5 g';
  $output = $equation->converText($text);
  // Output Array = ['kg'=>1.745, 'hg'=>17.45, 'dag'=>174.5, 'g'=>1745, 'dg'=>17450, 'cg'=>174500, 'mg'=>1745000]
  
  // Specific unit output
  $text = '1 kg, 7 hg, 4 dag, 5 g';
  $unit = 'g';
  $output = $equation->converText($text, $unit);
  // Output Number = 1745
  

Advance Usage

• Customize options the field of units.

  $units_data = [
      ['text'=>'kg', 'value' => 1],
      ['text'=>'hg', 'value' => 10],
      ['text'=>'dag', 'value' => 10],
      ['text'=>'g', 'value' => 10],
      ['text'=>'dg', 'value' => 10],
      ['text'=>'mg', 'value' => 10]
  ];
  $options = [
      'units'         => $units_data,
      'unit_property' => 'text',
      'qty_property'  => 'value'
  ];
  $equation   = new Equation($options);
  $output     = $equation->convert(1245,'g','dag');
  // Output Number = 1745
  

• Change the units conversion ladder.

  $units  = [
      ['text'=>'l', 'value' => 1],
      ['text'=>'ml', 'value' => 1000]
  ];
  $equation->units($units);
  $output = $equation->convert(1,'l','ml');
  // Output Number = 1000
  

Authors

Yudha Angga Wijaya

• GitHub
• LinkedIn

License

Equation is open source software licensed as MIT.