open-orchestra/open-orchestra-bbcode-bundle

<?php 

namespace OpenOrchestra\BBcodeBundle\ElementNode;

use OpenOrchestra\BBcodeBundle\Definition\BBcodeDefinitionInterface;

/**
 * Interface BBcodeElementNodeInterface
 */
Interface BBcodeElementNodeInterface
{
    /**
     * Return the element as html with all replacements made
     *
     * @return the html representation of this node
     */
    public function getAsHTML();

    /**
     * Return the element as text with all replacements made
     *
     * @return the text representation of this node
     */
    public function getAsText();

    /**
     * Return the element as html with all replacements made, in a preview context
     *
     * @return the html representation of this node
     */
    public function getAsPreviewHTML();

    /**
     * Sets the CodeDefinition that defines this element.
     *
     * @param codeDef the code definition that defines this element node
     */
    public function setBBCodeDefinition(BBcodeDefinitionInterface $codeDef);

    /**
     * Returns all the children of this element.
     *
     * @return array
     */
    public function getChildren();

    /**
     * Returns the element as bbcode (with all unclosed tags closed)
     *
     * @return string
     */
    public function getAsBBCode();

    /**
     * Returns the attribute (used as the option in bbcode definitions) of this element.
     *
     * @return array
     */
    public function getAttribute();
}