Skapa en klass för textfiltrering och formattering (v2)

Samla koden för textfiltrering och formattering i en egen klass som du kan använda i din webbplats för att filtrera/formattera textbaserat innehåll från databasen.

#Förkunskaper

Du har jobbat igenom artikeln “Lagra innehåll i databas för webbsidor och bloggposter (v2)”.

#Introduktion och förberedelse

Gå igenom följande steg för att förbereda dig inför uppgiften.

Du kan se hur jag jobbar igenom stegen i videoserien “Uppgiften “Skapa en klass för textfiltrering och formattering (v2)” kursen oophp”.

Tanken är att du skall bygga en klass TextFilter som kan filtrera/formattera en textmassa.

#Använda klassen TextFilter

Du kan alltså ta en text som du till exempel har sparat i databasen och låta klassen TextFilter parsa texten enligt vissa regler, eller filter, eller formatterar, hur man nu vill benämna det.

Här är en översikt av hur din klass kan se ut, se även kursrepot example/textfilter.

Döp din klass till MyTextFilter eller något annat, annars riskerar den att krocka med den befintliga klassen Anax\TextFilter\TextFilter eftersom autoloadern inte kan skilja dem åt då både vendor Mos och Anax är mappade mot katalogen src/.

namespace Mos\TextFilter;

/**
 * Filter and format text content.
 */
class MyTextFilter
{
    /**
     * @var array $filters Supported filters with method names of 
     *                     their respective handler.
     */
    private $filters = [
        "bbcode"    => "bbcode2html",
        "link"      => "makeClickable",
        "markdown"  => "markdown",
        "nl2br"     => "nl2br",
    ];



    /**
     * Call each filter on the text and return the processed text.
     *
     * @param string $text   The text to filter.
     * @param array  $filter Array of filters to use.
     *
     * @return string with the formatted text.
     */
    public function parse($text, $filter) { }



    /**
     * Helper, BBCode formatting converting to HTML.
     *
     * @param string $text The text to be converted.
     *
     * @return string the formatted text.
     */
    public function bbcode2html($text) { }



    /**
     * Make clickable links from URLs in text.
     *
     * @param string $text The text that should be formatted.
     *
     * @return string with formatted anchors.
     */
    public function makeClickable($text) { }



    /**
     * Format text according to Markdown syntax.
     *
     * @param string $text The text that should be formatted.
     *
     * @return string as the formatted html text.
     */
    public function markdown($text) { }



    /**
     * For convenience access to nl2br formatting of text.
     *
     * @param string $text The text that should be formatted.
     *
     * @return string the formatted text.
     */
    public function nl2br($text) { }
}

Det var en översikt av hur du kan skapa klassen och dess metoder. Tanken är att det finns en metod parse($text, $filter) som anropar respektive filter.

Själva användningen kan se ut så här.

$filter = new \Mos\TextFilter\MyTextFilter();
$text = "En [b]fet[/b] moped.";
$html = $filter->parse($text, ["bbcode"]);

Den resulterande texten bör bli "En <b>fet</b> moped.".

#Metoden parse()

Metoden parse() är ett API till hela klassen. Tanken är att det är den enda metoden som användaren behöver anropa. Man skickar med texten och en array av filter som skall processas.

/**
 * Call each filter on the text and return the processed text.
 *
 * @param string $text   The text to filter.
 * @param array  $filter Array of filters to use.
 *
 * @return string with the formatted text.
 */
public function parse($text, $filter) { }

Internt i klassen så översätts varje filter till ett metodanrop som bearbetar texten.

Du kan uppdatera metodens DocBlock om du hellre vill att argumentet $filter skall vara av typen sträng för att hantera en komma-separerad lista av filter.

#Metoden bbcode2html()

Metoden bbcode2html() matchar filtret bbcode och översätter texten till HTML enligt de BBCode regler som stöds.

/**
 * Helper, BBCode formatting converting to HTML.
 *
 * @param string $text The text to be converted.
 *
 * @return string the formatted text.
 */
public function bbcode2html($text) { }

Du kan se ett exempel på en sådan här funktion i artikeln “Reguljära uttryck i PHP ger BBCode formattering”.

#Metoden makeClickable()

Metoden makeClickable() matchar filtret link och översätter delar av texten till klickbara länkar. Koden använder sig av ett reguljärt uttryck för att hitta de text-delar som ser ut som en klickbar länk.

/**
 * Make clickable links from URLs in text.
 *
 * @param string $text The text that should be formatted.
 *
 * @return string with formatted anchors.
 */
public function makeClickable($text) { }

Du kan se ett exempel på en sådan här funktion i artikeln “Låt PHP-funktion make_clickable() automatiskt skapa klickbara länkar”.

#Metoden markdown()

Metoden markdown() matchar filtret markdown och översätter texten enligt syntaxen Markdown. Funktionen använder sig av en extern modul för att utföra översättningen.

/**
 * Format text according to Markdown syntax.
 *
 * @param string $text The text that should be formatted.
 *
 * @return string as the formatted html text.
 */
public function markdown($text) { }

Du kan se ett exempel på en sådan här funktion i artikeln “Skriv för webben med Markdown och formattera till HTML med PHP (v2)”.

#Metoden nl2br()

Metoden nl2br() matchar filtret nl2br och lägger till ett HTML-element <br> för varje \n som finns i texten. Funktionen som är tänkt att användas är en inbyggd PHP-funktion.

/**
 * For convenience access to nl2br formatting of text.
 *
 * @param string $text The text that should be formatted.
 *
 * @return string the formatted text.
 */
public function nl2br($text) { }

Läs på hur du använder den inbyggda PHP-funktionen nl2br().

#Krav

1. Din klass skall stödja filter för bbcode, link, markdown, nl2br.

2. Din klass skall innehålla en metod parse() som tar text och filter som inparametrar, bearbetar texten enligt angivna filter i sagd ordning och slutligen returnerar den modifierade texten.

3. Gör en (eller flera) test routes på din redovisa sida som visar hur du formatterar innehåll på de sätt som skall stödjas. Lägg en länk i navbaren så man kan nå din testsida.

4. Validera och publicera din kod.

#Extrauppgift

Om du har tid, lust och energi så kan du bygga vidare på din textfilter-klass, här är ett par förslag.

1. Din klass kan stödja ett filter strip som gör strip_tags() på texten.

2. Din klass kan stödja ett filter esc som gör htmlentities() på texten.

#Tips från coachen

Om du vill kika på en Anax modul som gör ungefär liknande som du gör i denna uppgiften, så kan du titta på anax/textfilter.

Se till att du har bytt namn på klassen TextFilter så att den inte krockar med den befintliga klassen Anax\TextFilter\TextFilter, se även forumtråd.

Det finns ett foruminlägg som visar hur du löser felmeddelandet “Avoid using static access to class \Michelf\MarkdownExtra”.

Lycka till och hojta till i forumet om du behöver hjälp!

#Revision history