robbieaverill / silverstripe-markdowntextareafield

forms/MarkdownTextareaField.php

<?php
/**
 * Configure the input field for markdown
 */
class MarkdownTextareaField extends TextareaField

PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions.

{
    /**
     * Define the actions allowed on this field
     * @var array
     */
    private static $allowed_actions = array(

Consider using a different property name as you override a private property of the parent class.

The property $allowed_actions is not used and could be removed.

        'preview',
        'parse'
    );

    /**
     * @var int Visible number of text lines.
     * Default on TextareaField is too small
     */
    protected $rows = 15;

    /**
     * Toggle rendering markdown with extra syntax enabled.
     * @link http://michelf.ca/projects/php-markdown/extra
     * @var boolean
     */
    protected $enable_extra = false;

    /**
     * Returns the field holder used by templates
     *
     * @param  array $properties
     * @return string            HTML to be used
     */
    public function FieldHolder($properties = array())
    {
        $this->extraClasses['stacked'] = 'stacked';

        Requirements::css(MARKDOWN_DIR . '/templates/css/styles.css');

        Requirements::javascript(THIRDPARTY_DIR . '/jquery/jquery.js');
        Requirements::javascript(THIRDPARTY_DIR . '/jquery-entwine/dist/jquery.entwine-dist.js');
        Requirements::javascript(MARKDOWN_DIR . '/thirdparty/textinputs_jquery.js');
        Requirements::javascript(MARKDOWN_DIR . '/templates/javascript/script.js');

        return parent::FieldHolder($properties);
    }

    /**
     * Turn on extra syntax support
     * @return MarkdownTextareaField
     */
    public function enableExtra()
    {
        $this->enable_extra = true;
        return $this;
    }

    /**
     * Body for the preview iframe with just the typography styles included
     * @return string html

Should the return type not be HTMLText?

     */
    public function preview()
    {
        Requirements::clear();
        // Should contain text styles of the page by Silverstripe theme conventions.
        Requirements::css('themes/' . Config::inst()->get('SSViewer', 'theme') . '/css/editor.css');
        return $this->renderWith('PreviewFrame');
    }

    /**
     * Parse markdown into html
     * @return string html
     */
    public function parse()
    {
        $parser = new MarkdownParser($this->request['markdown']);

        return ($this->enable_extra) ? $parser->parseExtra() : $parser->parse();
    }

    /**
     * Get buttons described in buttons.yml and wrap them in ViewableData
     * @return ArrayList list of buttons and theyr configurations
     */
    public function ToolbarButtons()
    {
        $buttons = new ArrayList();

        foreach ($this->config()->get('buttons') as $button) {
            $buttons->push(new ArrayData($button));
        }

        return $buttons;
    }
}