https://github.com/soatok/cupcake

PHP library for simply secure HTML forms (generation and processing). Secure-by-default.
https://github.com/soatok/cupcake

forms furry furry-fandom html5 php8 secure-by-default secure-by-design

Last synced: 4 months ago
JSON representation

PHP library for simply secure HTML forms (generation and processing). Secure-by-default.

• Host: GitHub
• URL: https://github.com/soatok/cupcake
• Owner: soatok
• License: isc
• Created: 2021-06-22T05:03:18.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2022-07-06T06:55:48.000Z (over 2 years ago)
• Last Synced: 2024-10-07T22:59:08.344Z (4 months ago)
• Topics: forms, furry, furry-fandom, html5, php8, secure-by-default, secure-by-design
• Language: PHP
• Homepage: https://soatok.blog
• Size: 785 KB
• Stars: 32
• Watchers: 2
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# ![Cupcake](docs/headers/cupcake.png)

[![Build Status](https://github.com/soatok/cupcake/actions/workflows/ci.yml/badge.svg)](https://github.com/soatok/cupcake/actions)

[![Latest Stable Version](https://poser.pugx.org/soatok/cupcake/v/stable)](https://packagist.org/packages/soatok/cupcake)

[![Latest Unstable Version](https://poser.pugx.org/soatok/cupcake/v/unstable)](https://packagist.org/packages/soatok/cupcake)

[![License](https://poser.pugx.org/soatok/cupcake/license)](https://packagist.org/packages/soatok/cupcake)

Sweet and fast form processing for PHP projects.

**Requires PHP 8 or newer.**

## Installation

Use Composer to install this library:

```terminal

composer require soatok/cupcake

```

To learn how to use Cupcake, please see the **[Documentation](docs)** online.

## Questions and Answers

### Why "Cupcake"?

Wordplay! The German word for a cupcake mold is förmchen.

### What Does Cupcake Do That Other Form Libraries Don't?

Three things: Security, simplicity, and ease-of-use. 

First, I designed Cupcake with [security as its first principle](docs#-tenets-of-cupcake).

This doesn't *just* mean the bare basics like preventing cross-site scripting

vulnerabilities and cross-site request forgery. Secure form processing means ensuring that [input validation isn't only performed client-side](https://soatok.blog/2020/04/27/why-server-side-input-validation-matters/).

To that end, Cupcake uses [Ionizer](https://github.com/paragonie/ionizer) for input filtering.

Second, Cupcake's interface is deliberately simple and intuitive. Piece o' cake!

Finally, Cupcake is easy to integrate with other platforms and frameworks,

by design. Cupcake has minimal dependencies and is unlikely to conflict with

your existing framework dependencies or explode the code size to an unreasonable

level.

(In the future, I will also provide shims for popular frameworks and ORMs.)

### How Do I Use Cupcake?

See the [Documentation](docs) directory.

If the documentation isn't helpful, please

[file an issue on Github](https://github.com/soatok/cupcake/issues/new).

### What's With the Cupcake Mascot?

Their name is **[Neophyte](docs/Neophyte)**! (They/them pronouns.)

Neophyte is a character owned by [Soatok](https://soatok.blog)

(the creator of Cupcake) to represent people who read his blog or

use his open source software.

### Is Cupcake a Furry Project?

![**Yes!**](docs/Soatok/Soatok-Yes.png)

The author, Soatok, is a furry. [The mascot](docs/Neophyte)

is a protogen (a fictitious species created within the furry fandom,

for the furry fandom to enjoy).

You can learn more about the Furry Fandom [here](https://soatok.blog/2020/04/23/never-underestimate-the-furry-fandom/).

### Is Cupcake API-Stable?

No, not until version 1.0.0 has been tagged.