Fortem

A collection of form templates for PHP with full support for alpinejs properties.

<div>
  <?= $form->label('Name')->asRequired() ?>
  <?= $form->input('name')->asModel() ?>
</div>
<div>
  <?= $form->label('Description')->asRequired() ?>
  <?= $form->input('detail')->asModel() ?>
</div>
<div>
  <?= $form->button('Update')->onClick('update(id)') ?>
</div>

Installation

Install the package using Composer:

$ composer require rougin/fortem

Basic usage

The FormHelper class provides an interface for creating labels, inputs, buttons, select dropdowns, and error messages:

// index.php

use Rougin\Fortem\Helpers\FormHelper;

$form = new FormHelper;

echo $form->label('Name');

<label>Name</label>

Note

See the next sections for the documentation of the abovementioned elements.

The LinkHelper class helps in generating and checking URLs to the template:

use Rougin\Fortem\Helpers\LinkHelper;

$server = array();
$server['HTTP_HOST'] = 'localhost';
$server['REQUEST_URI'] = '/';

$link = new LinkHelper($server);

echo $link; // http://localhost/

Use the isActive method to check if a given link is the current URL:

$current = $link->isActive('/'); // true

If HTTP_HOST is not available, the setBase method can be used:

use Rougin\Fortem\Helpers\LinkHelper;

$data = /** instaceof $_SERVER */;

$link = new LinkHelper($data);

$link->setBase('roug.in')

echo $link; // http://roug.in/

Labels

To create a <label> element, the label method is used:

echo $form->label('Name');

<label>Name</label>

The class attribute can be specified using withClass:

echo $form->label('Name')->withClass('form-label');

<label class="form-label">Name</label>

A label can also be marked as required, which adds a red asterisk:

echo $form->label('Name')->asRequired();

<label>Name <span class="text-danger">*</span></label>

Inputs

To create an <input> element, the input method is used. By default, it creates a text input:

echo $form->input('name');

<input type="text" name="name">

Same from label, use withClass for the class attribute:

echo $form->input('name')->withClass('form-control');

<input type="text" name="name" class="form-control">

The input type can be changed using the withType method or the convenient asEmail and asNumber methods:

echo $form->input('email')->asEmail();

<input type="email" name="email">

echo $form->input('age')->asNumber();

<input type="number" name="age">

Buttons

To create a <button> element, the button method is used:

echo $form->button('Submit');

<button type="button">Submit</button>

Use withClass method for specifying its class attribute:

echo $form->button('Submit')->withClass('btn btn-primary');

<button type="button" class="btn btn-primary">Submit</button>

The button type can be changed using the withType method:

echo $form->button('Submit')->withType('submit');

<button type="submit">Submit</button>

Select dropdowns

To create a <select> element, the select method is used. An array of items can be passed to populate the options:

$items = array('Male', 'Female');

echo $form->select('gender', $items);

<select name="gender">
  <option value="">Please select</option>
  <option value="0">Male</option>
  <option value="1">Female</option>
</select>

An associative array with id and name keys can also be provided:

$items = [ array('id' => 'm', 'name' => 'Male') ];
$items[] = array('id' => 'f', 'name' => 'Female');

echo $form->select('gender', $items);

<select name="gender">
  <option value="">Please select</option>
  <option value="m">Male</option>
  <option value="f">Female</option>
</select>

Error messages

The error method is used to create a placeholder for validation error messages:

echo $form->error('error.name');

<template x-if="error.name">
  <p class="text-danger small mb-0" x-text="error.name[0]"></p>
</template>

Note

This is only works when integrated in alpinejs.

Using alpinejs

Fortem provides methods for seamless integration with alpinejs.

For Input and Select classes, the asModel method adds an x-model attribute to the element, binding its value to its variable:

echo $form->input('name')->asModel();

<input type="text" name="name" x-model="name">

echo $form->select('gender', $items)->asModel();

<select name="gender" x-model="gender">...</select>

In all elements, the disablesOn method adds the :disabled attribute, allowing an element to be disabled based on its condition:

echo $form->input('name')->disablesOn('loading');

<input type="text" name="name" :disabled="loading">

For the Button class, the onClick method adds the @click attribute to a button, executing its function on click:

echo $form->button('Submit')->onClick('submitForm');

<button type="button" @click="submitForm">Submit</button>

Scripts

The script method helps create a JavaScript object from PHP which is useful for initializing data for alpinejs:

echo $form->script('data')
  ->with('name', 'John Doe')
  ->with('age', 30)
  ->withLoading()
  ->withError();

<script>
  let data = {"name":"John Doe","age":30,"loading":false,"error":{}};
</script>

Changelog

Please see CHANGELOG for more recent changes.

Contributing

See CONTRIBUTING on how to contribute to the project.

License

The MIT License (MIT). Please see LICENSE for more information.