1599fe24f5513a8ae376e9cf8626b2709556b53c
[acontent.git] / docs / include / classes / A4a / A4aExport.class.php
1 <?php
2 /************************************************************************/
3 /* AContent                                                             */
4 /************************************************************************/
5 /* Copyright (c) 2010                                                   */
6 /* Inclusive Design Institute                                           */
7 /*                                                                      */
8 /* This program is free software. You can redistribute it and/or        */
9 /* modify it under the terms of the GNU General Public License          */
10 /* as published by the Free Software Foundation.                        */
11 /************************************************************************/
12
13 require_once(TR_INCLUDE_PATH.'classes/A4a/A4a.class.php');
14 //require(TR_INCLUDE_PATH.'classes/zipfile.class.php'); // for zipfile
15
16 /**
17  * Accessforall Export class.
18  * Based on the specification at: 
19  *              http://www.imsglobal.org/accessibility/index.html
20  *
21  * @date        Oct 3rd, 2008
22  * @author      Harris Wong
23  */
24 class A4aExport extends A4a {
25         var $original_files = array();  //store all the primary/original resources in [id]=>[incrementer]=>[resource, language, type]
26 //      var $alternative_files = array();       //secondary files aka. alternative, equivalent
27
28         /**
29          * Get information for this content
30          * @return the xml content
31          */     
32         function getAlternative(){
33                 $resources = parent::getPrimaryResources();
34
35                 foreach($resources as $rid => $prop){
36                         $resources_types = parent::getPrimaryResourcesTypes($rid);
37                         $temp = array();
38                         $secondary_array = array();
39                         foreach($resources_types as $rtid){
40                                 $sec_resources['secondary_resources'] = parent::getSecondaryResources($rid);
41                                 //determine secondary resource type
42                                 foreach ($sec_resources['secondary_resources'] as $sec_id => $sec_resource){
43                                         $current_sec_file = $sec_resource['resource'];
44                                         $secondary_array['secondary_resources'][] = $current_sec_file ;
45
46                                         //add to secondary file array if it's not there
47                                         if (!isset($this->original_files[$current_sec_file]) || empty($this->original_files[$current_sec_file]) ){
48                                                 //TODO merge these values i think
49                                                 $this->original_files[$current_sec_file ] = $sec_resource;
50                                                 $this->original_files[$current_sec_file ]['resource_type'][$prop['resource']] = parent::getSecondaryResourcesTypes($sec_id);
51                                         } else {
52                                                 $this->original_files[$current_sec_file ]['resource_type'][$prop['resource']] = parent::getSecondaryResourcesTypes($sec_id);
53                                         }
54                                         //add this primary file ref, and the resources type to the secondary file
55                                         $this->original_files[$current_sec_file]['primary_resources'][$prop['resource']] = $rtid;
56 //                                      $this->original_files[$current_sec_file]['primary_resources'][$prop['resource']]['language_code'] = $sec_resource['language_code'];
57                                         }
58                                 }
59                                 $res_type['resource_type'] = $rtid;     //could be 1+
60                                 $temp = array_merge($prop, $res_type, $secondary_array);
61                                 if (isset($this->original_files[$temp['resource']])){
62                                         //use the existing temp array values, but merge in the secondary_array
63                                         $temp = array_merge($this->original_files[$temp['resource']], $secondary_array);
64                         }
65                         if (!empty($temp)){
66                                 $this->original_files[$temp['resource']] = $temp;
67                         }
68                 }
69                 return $this->original_files;
70         }
71
72         /**
73          * Get all secondary files
74          * @return array of secondary files that is being used in this->content.
75          */
76         function getAllSecondaryFiles(){
77                 global $db;
78                 $secondary_files = array();
79
80                 include_once(TR_INCLUDE_PATH.'classes/DAO/SecondaryResourcesDAO.class.php');
81                 $secondaryResourcesDAO = new SecondaryResourcesDAO();
82                 $rows = $secondaryResourcesDAO->getByContent($this->cid);
83 //              $sql = "SELECT DISTINCT secondary_resource FROM ".TABLE_PREFIX."primary_resources a LEFT JOIN ".TABLE_PREFIX."secondary_resources s
84 //                              ON a.primary_resource_id = s.primary_resource_id WHERE content_id=".$this->cid;
85 //              $result = mysql_query ($sql);
86
87                 if (is_array($rows)){
88                         foreach ($rows as $row) {
89                                 if (!empty($row['secondary_resource'])){
90                                         $secondary_files[] = $row['secondary_resource'];
91                                 }
92                         }
93                 }
94                 return $secondary_files;
95         }
96
97         // Save all the xml into an array. 
98         // key=filename, value=xml content
99         function exportA4a(){
100                 global $savant;
101
102                 $xml_array = array();   //array of xml
103
104                 // Get the alt content first.
105                 $this->getAlternative();
106
107                 // Get original files' xml 
108                 foreach($this->original_files as $id=>$resource){
109                         $orig_access_mode = array();
110
111                         foreach($resource['resource_type'] as $type_id){
112                                 if (!is_array($type_id)){
113                                         //primary resource will always have just on type
114                                         $orig_access_mode[] = $this->getResourceNameById($type_id);
115                                 } else {
116                                         foreach($type_id as $k=>$type_id2){
117                                                 $orig_access_mode[] = $this->getResourceNameById($type_id2[0]);
118                                         }
119                                 }
120                         }
121                         $savant->assign('relative_path', $this->relative_path); //the template will need the relative path
122                         $savant->assign('orig_access_mode', $orig_access_mode);
123                         $savant->assign('language_code', $resource['language_code']);
124                         $savant->assign('secondary_resources', $resource['secondary_resources']);
125                         
126                         // If this is an alternative, and it is mapping to 
127                         // 1+ original files.  Each of these mapping requires
128                         // its own xml
129                         if(isset($resource['primary_resources'])){
130                                 foreach($resource['primary_resources'] as $uri=>$pri_resource_types){
131                                         $savant->assign('primary_resource_uri', $uri);
132                                         $savant->assign('primary_resources', $pri_resource_types);
133                                         //A file can be both original and alternative, and each could represent diff language
134                                         //Tried to resolve but the A4a v.2 only accept 1 language
135 //                                      $savant->assign('language_code', $pri_resource_types['language_code']);
136                                         //overwrite orig_access_mode                                    
137                                         $orig_access_mode = array(); //reinitialize
138                                         foreach($resource['resource_type'][$uri] as $type_id){
139                                                 $orig_access_mode[] = $this->getResourceNameById($type_id);
140                                                 $savant->assign('orig_access_mode', $orig_access_mode);
141                                                 $xml_array[$id.' to '.$uri][] = $savant->fetch(TR_INCLUDE_PATH.'classes/A4a/A4a.tmpl.php');
142                                         }
143                                 }
144                         } else {
145                                 $savant->assign('primary_resource_uri', '');
146                                 $savant->assign('primary_resources', '');
147                                 $xml_array[$id] = $savant->fetch(TR_INCLUDE_PATH.'classes/A4a/A4a.tmpl.php');
148                         }
149                 }
150                 return $xml_array;
151         }
152
153         /**
154          * Get resource name by id
155          * @return      array
156          */
157         function getResourceNameById($type_id){
158                 $orig_access_mode = '';
159                 if (is_array($type_id)) {
160                         $type_id = $type_id[0];
161                 }
162                 switch($type_id){
163                         case 1:
164                                 $orig_access_mode = 'auditory';
165                                 break;
166                         case 3:
167                                 $orig_access_mode = 'textual';
168                                 break;
169                         case 2:
170                                 $orig_access_mode = 'sign_language';
171                                 break;
172                         case 4:
173                                 $orig_access_mode = 'visual';
174                                 break;
175                         default:
176                                 $orig_access_mode = '';
177                 }
178                 return $orig_access_mode;
179         }
180
181 }
182
183 ?>