server/src/app/Libraries/Transcript/TranscriptConverterInterface.php
changeset 162 a6cf5a06f02d
equal deleted inserted replaced
161:5f011170de74 162:a6cf5a06f02d
       
     1 <?php
       
     2 namespace CorpusParole\Libraries\Transcript;
       
     3 
       
     4 interface TranscriptConverterInterface {
       
     5 
       
     6     /**
       
     7      * parse the source document.
       
     8      */
       
     9     function parseSource();
       
    10 
       
    11     /**
       
    12      * Return the id of the media used as reference.
       
    13      */
       
    14     function getMediaRefId();
       
    15 
       
    16     /**
       
    17      * return the source title, can return null.
       
    18      */
       
    19     function getSourceTitle();
       
    20 
       
    21     /**
       
    22      * build the various document parts
       
    23      */
       
    24     function buildMedias();
       
    25     function buildResources();
       
    26     function buildLists();
       
    27     function buildAnnotationTypes();
       
    28     function buildAnnotations();
       
    29 
       
    30     /**
       
    31      * Convert xml to json.
       
    32      * return an PHP array ready for serialization
       
    33      */
       
    34     function convertToJson();
       
    35 
       
    36 
       
    37 }