server/src/app/Libraries/Transcript/TranscriptConverterInterface.php
author Chloe Laisne <chloe.laisne@gmail.com>
Tue, 07 Jun 2016 19:49:43 +0200
changeset 179 9b703ece424f
parent 162 a6cf5a06f02d
permissions -rw-r--r--
Discourse and theme linting

<?php
namespace CorpusParole\Libraries\Transcript;

interface TranscriptConverterInterface {

    /**
     * parse the source document.
     */
    function parseSource();

    /**
     * Return the id of the media used as reference.
     */
    function getMediaRefId();

    /**
     * return the source title, can return null.
     */
    function getSourceTitle();

    /**
     * build the various document parts
     */
    function buildMedias();
    function buildResources();
    function buildLists();
    function buildAnnotationTypes();
    function buildAnnotations();

    /**
     * Convert xml to json.
     * return an PHP array ready for serialization
     */
    function convertToJson();


}