atk14/slug-field

ATK14 form field for entering slugs

v1.2 2020-03-02 09:33 UTC

Requires

• php: >=5.3.0

Requires (Dev)

• atk14/core: dev-master
• atk14/forms: dev-master
• atk14/tester: *

MIT

• ATK14 Development Team

• Forms
• slug
• field
• atk14

README

ATK14 form field for entering slugs.

Usage

In a form:

<?php
// file: app/forms/articles/create_new_form.php
class CreateNewForm extends ApplicationForm {

  function set_up(){

    $this->add_field("title", new CharField([
      "label" => "Article title",
      "max_length" => 100, // by default it is either constant SLUG_MAX_LENGTH (if defined) or 65
    ]));

    // ... other article fields

    $this->add_field("slug", new SlugField([
      "label" => "Slug for cool looking url",
      "hint" => "are-you-too-clever-for-success",
      "auto_slugify" => true, // whether to convert automatically something like "Nice Title!" to "nice-title"; default is true
      "max_length" => 100,
    ]));
  }
}

Configuration

Optionally the default value for the max_length option can be set by the constant SLUG_MAX_LENGTH.

<?php
// file: config/settings.php

// ...

define("SLUG_MAX_LENGTH",100);

Installation

Just use the Composer:

cd path/to/your/atk14/project/
composer require atk14/slug-field dev-master

ln -s ../../vendor/atk14/slug-field/src/slug_field.php app/fields/slug_field.php

License

SlugField is free software distributed under the terms of the MIT license