https://github.com/khumam/censorit
A simple PHP package that allows you to censor text
https://github.com/khumam/censorit
censorship php security-tools
Last synced: 8 months ago
JSON representation
A simple PHP package that allows you to censor text
- Host: GitHub
- URL: https://github.com/khumam/censorit
- Owner: khumam
- Created: 2022-01-24T14:26:02.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2022-02-02T16:11:46.000Z (over 3 years ago)
- Last Synced: 2025-02-07T00:36:56.151Z (8 months ago)
- Topics: censorship, php, security-tools
- Language: PHP
- Homepage:
- Size: 12.7 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# Hallo selamat datang di Censorit
Censorit merupakan sebuah package PHP yang memiliki fungsi untuk memberikan efek sensor terhadap suatu kata. Censorit sebagian besar menggunakan regex untuk menentukan posisi karakter mana yang akan disensor.
## Cara instalasi
Pastikan sudah memiliki composer di mesin kalian. Jika belum, silakan install composer terlebih dahulu.
Untuk menginstall Censorit, jalankan perintah di bawah
```
composer require khumam/censorit
```
Jika sudah selesai, artinya Censorit siap digunakan.
## Cara penggunaan
Cara penggunaannya sangat mudah. Contohnya dapat dilihat di bawah ini.
```php
full() // Hasil ***********
$censoredString = Censorit::censor($string)->half() // Hasil ABCDEF GHI**
$censoredString = Censorit::censor($string)->middle() // Hasil AB**** ***JK
```
## Kumpulan method
Ada beberapa method yang bisa digunakan di dalam Censorit.
|Method|Parameter|Deskripsi|Example|
|---|---|---|---|
|full|With space (default: true)|Untuk mensensor seluruh teks. Jika memasukan parameter false, maka spasi tidak akan ikut tersensor|full() atau full(false)|
|half|offset (default: 2)|Untuk mensensor sebagian teks. Jika offset diisi positif, akan mensensor huruf sebanyak offset dari belakang. Jika negatif, dari depan|half(2) atau half(-2)|
|middle|offset (default: 2), reverse (default: false)|Untuk mensensor karakter yang berada di tengah teks sebanyak offset. Jika reverse true, yang disensor yang disamping kiri kanan nya|middle(2) atau middle(2, true)|
Jika offset lebih besar dari kata, maka hasilnya akan disensor seluruh kata.
## To do list
- [X] Sensor full teks
- [X] Sensor full teks selain spasi
- [X] Sensor di awal teks sebanyak offset
- [X] Sensor di akhir teks sebanyak offset
- [X] Sensor di tengah teks sebanyak offset
- [X] Sensor kecuali di tengah teks sebanyak offset
- [ ] Sensor di posisi random
## Kontribusi
Saya sangat mengharapkan teman-teman untuk berkontribusi di repo ini. Detail kontribusi akan dijelaskan di lain waktu.