server/src/app/Libraries/Transcript/TranscriptConverterInterface.php
author ymh <ymh.work@gmail.com>
Wed, 18 Jan 2017 11:33:56 +0100
changeset 489 18613f052d56
parent 162 a6cf5a06f02d
permissions -rw-r--r--
Documents must be sorted by title, correct bug #0025982

<?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();


}