extraction-interface: models/extractapp.php comparison

comparison models/extractapp.php @ 81:f1f849d31272 extractapp

book_id as string

author	Zoe Hong <zhong@mpiwg-berlin.mpg.de>
date	Thu, 23 Apr 2015 14:58:27 +0200
parents	e6e213b26454
children	23b6bd897777

comparison

equal deleted inserted replaced

-:c15f53afd7a5
+:f1f849d31272
 <?php
+/*
+* extractapp.php
+* This file is part of Extraction-interface.
+*
+* Extraction-interface is free software: you can redistribute it and/or modify
+* it under the terms of the GNU General Public License as published by
+* the Free Software Foundation, either version 3 of the License, or
+* (at your option) any later version.
+*
+* Extraction-interface is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+* GNU General Public License for more details.
+*
+* You should have received a copy of the GNU General Public License
+* along with Extraction-interface.  If not, see <http://www.gnu.org/licenses/>.
+*/
 /**
-* ExtractappModel is extended from the BaseModel.
+* ExtractappModel class is extended from the BaseModel class.
-* This is where we implement the functions/models that related to extraction-interface.
+* This is where we implement the functions/models to prepare data that been sent to views.
+* ExtractappModel is notified by Extractapp controller when there has been a change in its state,
+* and produces the output/data to the corresponding view in "views/Extractapp/".
+*
 */
 class ExtractappModel extends BaseModel{
 protected $section_id = 0, $data_path, $file_id = 0, $current_fileId=0,
 $branch_id = 0, $user_id = 0, $lg_text = "", $topic, $taglist_infile = "", $book_meta = "",$book_dynasty="";
 public $messages = array('info'=>"",'error'=>"",'warning'=>"",'debug'=>"");
-public function GetTextFromFileId() {   // remove $_postdata as input
+public function SetTextFromFileId() {   // remove $_postdata as input
+/**
+* Get text content from LGService by $this->file_id.
+* After preprocessing the text string (replace space to circle symbol, link for page number, etc),
+* set $this->lg_text to the processed text gotten from LGService.
+*/
 /*
 $this->file_id = $_postdata['fileId'];
 $branch_id = $_postdata['branchId'];
 $section_id = $_postdata['sectionId'];
 $b['volume'],$b['author'], $b['edition'],$b['in_jibengujiku'], $b['admin_type']));    // missing author,year,pagenumber
 $this->book_meta = $book_meta;
 }
-public function GetTextFromSectionId() {  // remove $_postdata as input
+public function SetTextFromSectionId() {  // remove $_postdata as input
+/**
+* Get text content from LGService by $this->section_id.
+* After preprocessing the text string (replace space to circle symbol, link for page number, etc),
+* set $this->lg_text to the processed text gotten from LGService.
+*/
 /*
 $section_id = $_postdata['sectionId'];
 $this->section_id = $section_id;
 $this->user_id = $_postdata['userId'];
 $this->lg_text = $lg_text;
 }
 // This is only used on localhost
-public function GetTextFromLocal($_id){
+public function SetTextFromLocal($_id){
 $this->section_id = $_id;
 //$this->branch_id = 1;   // local test sets branch_id to 1
 $this->messages['debug'] .= "[Debug] from my local"."<br>";
 $this->lg_text = $this->GetSectionContent();
 }
-public function GetInfoFromPreviousPage($_postdata) {
+public function SetInfoFromPreviousPage($_postdata) {
+/**
+* Get information from post data passsed by the previous page, and set variables in $this.
+* The previous page could be:
+*
+* (1) LGService: the first time user enters Extraction-interface, which should linked from LGService.
+*
+* (2) Extraction-interface itself: changing topic then continue to tag, saving text to LGService, reload the text from LGService.
+*
+*/
 if (isset($_postdata['fileId'])) {
 $this->file_id = $_postdata['fileId'];
 }
 if (isset($_postdata['sectionId'])) {
 }
 if (isset($_postdata['bookName'])) {
 $this->book_name = $_postdata['bookName'];
 }
 if (isset($_postdata['bookId'])) {
-$this->book_id = $_postdata['bookId'];
+$book_id = $_postdata['bookId'];
+if ($book_id < 10000) {
+$book_id = '0'.(string)$book_id;
+} else if ($book_id < 1000) {
+$book_id = '00'.(string)$book_id;
+}
+$this->book_id = (string)$book_id;
 }
 if (isset($_postdata['currentFileId'])) {
 $this->current_fileId = $_postdata['currentFileId'];
 }
 if (isset($_postdata['taglistArray'])) {
 }
 // === for tagging ===
 public function StartTagging() {
+/**
+* This is the main method for tagging text. It passes all the information to "views/Extractapp/TaggingText.php" view.
+* The information contain the text string, taglist array, wordlis array, topic, etc.
+*/
 $section_id = $this->section_id;
 $stringInput = $this->lg_text;
 $data = array();    // data array to be passed to view
 return $data;
 }
 public function SaveFullText($postdata) {
+// locally
 if ($postdata['text']){
 $date = date('Y_m_d_H_i_s', time());
 if ( file_exists("data/parsing_files/".$postdata['filename'].".txt") ) {
 $oldFile = file_get_contents("data/parsing_files/".$postdata['filename'].".txt");
 file_put_contents("data/parsing_files/".$postdata['filename']."_".$date.".txt", $oldFile);
 }
 }
 public function UpdateInfoResponsedFromLGService($response) {
+/**
+*
+*/
 if (isset($response["file"])) {
 $response_file = $response["file"];
 }
 if (isset($response["branch"])) {
 $response_branch = $response["branch"];
 return $text;
 }
 public function SaveFullTextToLGService($_postdata) {
-// save tagged text (full text) by Jorge's API to lg service
+/**
+* It saves the full tagged text string in postdata to LGService.
+* The responses returned by LGService will later be handled in
+*/
 // --------
 global $AT_LOCAL;
 if ($_postdata['text']){
 $date = date('Y_m_d_H_i_s', time());
 return $new_contentString;
 }
 private function GetSectionContent() {
-/** This is only been called by GetTextFromLocal().
+/** This is only been called by SetTextFromLocal().
 */
 $section_id = $this->GetSectionId();
 $section_info = $this->GetSectionInfo();

Mercurial > hg > extraction-interface

comparison models/extractapp.php @ 81:f1f849d31272 extractapp