Redaktilo Fork me on GitHub

Redaktilo Extension Points

Search

Use the EditorBuilder in order to register custom SearchStrategy implementations:

<?php
require_once __DIR__.'/vendor/autoload.php';

use Gnugat\Redaktilo\EditorFactory;

$strategy = new MyCustomStrategy();

$builder = EditorFactory::createBuilder();
$builder->addSearchStrategy($strategy);

$editor = $builder->getEditor();

The strategy will then be automatically used (if it's the first to support the given pattern) when calling one of the following Editor method:

  • jumpAbove
  • jumpBelow
  • hasAbove
  • hasBelow

If your strategy should be used instead of another already registered strategy (ie. they support the same pattern), you can give it a higher priority:

$builder->addSearchStrategy($strategy, 50);

Important: The higher the priority is, the sooner the strategy will be returned if it supports the given pattern.

Note:A default priority of 0 is assigned to strategies if you don't specify it.

SearchStrategy API

A lookup strategy supporting a specific kind of pattern:

<?php

namespace Gnugat\Redaktilo\Search;

use Gnugat\Redaktilo\Text;

interface SearchStrategy
{
    public function findAbove(Text $text, $pattern, $location = null);
    public function findBelow(Text $text, $pattern, $location = null);

    public function supports($pattern);
}

Implementations provided out of the box are:

  • LineRegexSearchStrategy: regular expression search, supports regex (/pattern/)
  • SameSearchStrategy: strict equality search (===), supports strings

Commands

Use the EditorBuilder in order to register custom Command implementations:

<?php
require_once __DIR__.'/vendor/autoload.php';

use Gnugat\Redaktilo\EditorFactory;

$command = new DoSomethingCommand();

$builder = EditorFactory::createBuilder();
$builder->addCommand($command);
$commandInvoker = $builder->getCommandInvoker();
$editor = $builder->getEditor();
$file = $editor->open('/tmp/menu_spam.txt', true);

$editor->run('do_something', array('text' => $file));

Editor actually uses the CommandInvoker in its following methods:

  • insertAbove
  • insertBelow
  • remove
  • replace
  • replaceAll
  • run

Command API

Executes a task with the given input:

<?php

namespace Gnugat\Redaktilo\Command;

interface Command
{
    public function getName();
    public function execute(array $input);
}

Implementations provided out of the box are:

  • LineInsertAboveCommand: text, addition and optional location (name: insert_above)
  • LineInsertBelowCommand: text, addition and optional location (name: insert_below)
  • LineRemoveCommand: text and optional location (name: remove)
  • LineReplaceCommand: text, replacement and optional location (name: replace)
  • LineReplaceAllCommand: text, pattern and replacement (name: replace_all)

Input Sanitizers

In order to safely extract the parameters in the given input, commands can rely on input sanitizer:

<?php

namespace Gnugat\Redaktilo\Command\Sanitizer;

interface InputSanitizer
{
    public function sanitize(array $input);
}

Currently, here's the sanitizers provided out of the box:

  • LocationSanitizer: checks if the line number is valid (positive integer strictly inferior to the text's length) or return the current line number
  • TextSanitizer: checks the presence and type of the text parameter

Next readings

Previous readings