The DocumentManager class provides the core API and management functions for uploading documents and managing document libraries. More...

Inheritance diagram for DocumentManager:

Public Member Functions
	DocumentManager ($library)
	Creates a new DocumentManager for the specified library. More...

	folderPermission ($folder)

	writeScript ()

	drawView ()

	drawButtons ()

	uploadFile ($field, $folder)
	Upload a file from the specified form field to the specified folder within the current document library. More...

	deleteDocument ($document)
	Delete the specified document (assuming the user has permission). More...

	deleteFolder ($folder)

	drawSelectView ($selectionChanged="", $doubleClick="", $width=700, $height=400)

	deleteDocumentLibrary ()

	formatLinkPickerTitle ($document)

	rescan ()

	scanFiles ($path)

	importMetaData ($file)

Static Public Member Functions
static	deleteUser ($user)
	Respond to fired event DeleteUser. More...

static	enumerateItems ($items)
	Enumerate the Document objects. More...

static	displayLibrary ($identifier, &$continue)

static	createLibraryObj ()

static	createLibrary ($form)

static	deleteRole ($del_role)

static	documentLibraryTabs ($key)

static	buildDocumentLibraryForm ($library)

static	formatDocumentLink ($document)

static	getStyles ()

static	zipLibrary ($library_id, $process=null)
	Generate a ZIP archive of all the documents in the specified library. More...

static	getRoleOptions ()

static	getRoleList ()

static	getMaxUploadBytes ()
	Calculate the maximum allowed file upload size in bytes. More...

static	getMaxUploadSize ()
	Returns the maximum allowed file upload size in human-readable format. More...

static	registerSearchables ($searchables)

static	registerSolrAdapter ()

static	upgradeComponent ($version)

static	registerCommentAdapter ()

static	registerTaxonomyClasses ($classes)

static	registerSerializationHandler ()

static	setDefaults ()

Public Attributes
	$library

	$docs

	$documents

	$width = 700

	$height = 400

Detailed Description

The DocumentManager class provides the core API and management functions for uploading documents and managing document libraries.

Author: Andy Green

Definition at line 70 of file document_manager.inc.

Member Function Documentation

◆ buildDocumentLibraryForm()

static DocumentManager::buildDocumentLibraryForm ( $library )

static

Definition at line 691 of file document_manager.inc.

      {
           $form = new AutoForm($library);
           $form->hide("owner_id", "allow_access", "manage_folders", "upload_files", "delete_files", "create_date");
           $form->required("name", "identifier");
           $form->annotate("allow_comments", "Allow users to comment on documents from the document details page (if commenting is enabled).");
           
           $form->allowDelete = true;
           $form->onDelete = deleteDocumentLibary;
           
           return $form;
      }    

◆ createLibrary()

static DocumentManager::createLibrary ( $form )

static

Definition at line 632 of file document_manager.inc.

      {
           $d = $form->data->getLibraryDirectory();
      }

◆ createLibraryObj()

static DocumentManager::createLibraryObj ( )

static

Definition at line 608 of file document_manager.inc.

      {
           global $user;
  
           $library = new DocumentLibrary();
           $library->owner_id = $user->user_id;
           $library->create_date = now();
           $defaultRole = DocumentLibrary::getDefaultRole();
           if($defaultRole)
           {
                $library->allow_access = $defaultRole;
                $library->manage_folders = $defaultRole;
                $library->upload_files = $defaultRole;
                $library->delete_files = $defaultRole;
           }    
           
           
           $library->filter = new InclusionFilter("document_library_id", "name", 
           "identifier", "description", "owner_id", "last_modified",
           "allow_access", "manage_folders", "upload_files", "delete_files", "create_date");
           
           return $library;
      }    

◆ deleteDocument()

DocumentManager::deleteDocument ( $document )

Delete the specified document (assuming the user has permission).

Parameters

Document $document the document object to be deleted

Returns: boolean true if the document was successfully deleted, false otherwise

Definition at line 485 of file document_manager.inc.

      {
           $fullPath = $this->library->getLibraryDirectory() . DIRECTORY_SEPARATOR . $document->file;
           if (file_exists($fullPath))
           {
                unlink($fullPath);
           }
           
           $document->delete();
           return true;
      }

◆ deleteDocumentLibrary()

DocumentManager::deleteDocumentLibrary ( )

Definition at line 637 of file document_manager.inc.

      {
           $documents = $this->library->Documents();
           if(count($documents) > 0)
           {
                foreach($documents as $document)
                     $this->deleteDocument($document);
           }
                
           $folders = $this->library->Folders();
           if(count($folders) > 0)
           {
                foreach($folders as $folder)
                {
                     $this->deleteFolder($folder);
                }
           }
                
           $fileshareUsers = $this->library->FileshareUsers();
           if(count($fileshareUsers) > 0)
           {
                foreach($fileshareUsers as $f_user)
                     $f_user->delete();
           }    
           
           $this->library->delete();
      }

◆ deleteFolder()

DocumentManager::deleteFolder ( $folder )

Definition at line 500 of file document_manager.inc.

      {
           $folder = sanitizePath($folder);
           $path = $this->library->getLibraryDirectory() . DIRECTORY_SEPARATOR . $folder;
      
           if (file_exists($path))
                rmdir($path);
           $folder->delete();
      }

◆ deleteRole()

static DocumentManager::deleteRole ( $del_role )

static

Definition at line 666 of file document_manager.inc.

      {
           $constraint = "WHERE role like '%$del_role%'";
           
           $roleFields = array("upload_files", "delete_files", "manage_folders", "allow_access");
           foreach($roleFields as $field)
           {
                $libraries = Query::create(DocumentLibrary, "WHERE $field like '%$del_role%'")->execute();
                RoleManager::deleteRoleFromString($libraries, $del_role, $field);
           }
           
           return $del_role;   
      }         

◆ deleteUser()

static DocumentManager::deleteUser ( $user )

static

Respond to fired event DeleteUser.

Delete any records in this component that have dependencies on user object.

Parameters

obj $user - class SiteUser or custom user class

Definition at line 382 of file document_manager.inc.

      {
           $pk = $user->getPrimaryKey();
           $user_id = $user->$pk;
           
           trace("Component document is deleting objects dependent on user_id {$user_id}", 3);
      
           $tx = new DataTransaction();
           
           try
           {
                $libraries = Query::create(DocumentLibrary, "WHERE owner_id=:owner_id")
                ->bind(":owner_id", $user_id)
                ->execute();
                     
                if(count($libraries))
                {
                     foreach($libraries as $library)
                     {
                          $library->joinTransaction($tx);
                          $mgr = new DocumentManager($library);
                          $mgr->deleteDocumentLibrary();
                     }
                }
                
                $document = new Document();
                $document->joinTransaction($tx);
                $document->delete("WHERE owner_id={$user_id}");
                
                $download = new DocumentDownload();
                $download->joinTransaction($tx);
                $download->delete("WHERE user_id={$user_id}");
                     
                $tx->commit();
           }
           catch(Exception $e)
           {
                $tx->rollback();
                throw $e;
           }
           
           return $user;
      }

◆ displayLibrary()

static DocumentManager::displayLibrary	(		$identifier,
		&	$continue
	)

static

Definition at line 576 of file document_manager.inc.

      {
           try
           {
                $library = DocumentLibrary::findByIdentifier($identifier);            
                $page = ComponentPage::findByIdentifier("document_library", "WHERE enabled=1");
                
                $_GET["library"] = $identifier;
           
                $pageView = new ComponentPageView($page, "{$page->template}.tpl");
           
                $page_role = $page->role;
                
                if (!checkRole($page->role))
                {
                     LoginManager::storeRedirectPage();
                     redirect("/login");
                }
                
                echo $pageView->drawView();
                
                $continue = false;
           }
           catch(DataNotFoundException $e)
           {
                
           }
           
           return $identifier;
      }

◆ documentLibraryTabs()

static DocumentManager::documentLibraryTabs ( $key )

static

Definition at line 680 of file document_manager.inc.

      {
           $tabs = array( 
                     "Details"      =>   "document_library_form",
                     "Files"             =>   "document_library_files"
                          );
  
           $qs = ($key) ? "document_library_id=$key" : ""; 
           return new TabBar("tabs", $tabs, $qs);
      }    

◆ DocumentManager()

DocumentManager::DocumentManager ( $library )

Creates a new DocumentManager for the specified library.

Parameters

DocumentLibrary $library the library to be managed

Definition at line 82 of file document_manager.inc.

      {         
           $this->library = $library;
           if ($this->library->document_library_id) 
           {
                $this->documents = $library->Documents("ORDER BY title");
           }
           else
           {
                $this->documents = array();
           }
      }

◆ drawButtons()

DocumentManager::drawButtons ( )

Definition at line 338 of file document_manager.inc.

           {
 ?>        
           <br/>
           <button id="download" class="button" disabled="disabled"  onclick="downloadFile()"> Download File </button>&nbsp;&nbsp;
           <?
           if (checkRole($this->library->upload_files))
           {
 ?>
           <button id="edit" class="button" disabled="disabled" onclick="editFile()">Edit Details...</button>&nbsp;&nbsp;
           <button id="upload" class="button" onclick="uploadFile()">Upload a File...</button>
 <?
           }
           
           if (checkRole($this->library->delete_files))
           {
 ?>
           <button id="deleteButton" class="button" disabled="disabled" onclick="deleteFile()">Delete File</button>&nbsp;&nbsp;
 <?
           }
           
           if (checkRole($this->library->manage_folders))
           {
 ?>
           &nbsp;&nbsp;<button id="createFolder" class="button" onclick="createFolder()">Create Folder...</button>&nbsp;&nbsp;
           <button id="deleteFolder" class="button" onclick="deleteFolder()">Delete Folder</button>&nbsp;&nbsp;
 <?php               
           }
  
           if (checkRole("admin"))
           {
 ?>
           <button id="rescan" class="button" onclick="rescanLibrary()">Rescan</button>
 <?
           }
      }

◆ drawSelectView()

DocumentManager::drawSelectView	(	$selectionChanged = `""`,
		$doubleClick = `""`,
		$width = `700`,
		$height = `400`
	)

Definition at line 510 of file document_manager.inc.

      {
           global $config;
           
           $tree = new DirectoryTreeControl("files");
           $tree->width = $width;
           $tree->height = $height;
           $tree->onSelectionChanged = $selectionChanged;
           $tree->onDoubleClick = $doubleClick;
           
           $tree->selectMode = "file";
           $tree->permissionCallback = array($this, folderPermission);
           
           if ($this->documents)
           {
                $root = $this->library->getLibraryDirectory();
                
                $tree->buildFolderTree($config["uploaddir"], $root);
                          
                foreach($this->documents as $doc)
                {
                     $file = str_replace("/", DIRECTORY_SEPARATOR, $doc->file);
                     $file = str_replace("\\", DIRECTORY_SEPARATOR, $file);
                     
                     trace($file, 4);
                     $folderNode = $tree->findFolder(dirname($file));
                     
                     if ($folderNode != null)
                     {
                          trace("Found Folder {$folderNode->id} for document {$doc->document_id}", 4);
                          $id = str_replace(DIRECTORY_SEPARATOR, "_", $file);
                          $fileNode = new FileNode($id, basename($file), $doc->document_id);
                     
                          $folderNode->add($fileNode);
                     }
                     else
                     {
                          trace("*** NODE NOT FOUND - $file", 3);
                     }
                }
                          
                $tree->children["documents"]->open = true;
                $tree->writeHTML(); 
           }
           else
           {
 ?>
           <div style="width: <?echo $width?>px;height:<?echo $height?>px;border: solid 1px #000;">&nbsp;</div>
 <?             
      
           }
      }

◆ drawView()

DocumentManager::drawView ( )

Definition at line 288 of file document_manager.inc.

      {
           global $config;
           
           $tree = new DirectoryTreeControl("files");
           $tree->width = $this->width;
           $tree->height = $this->height;
           $tree->onSelectionChanged = "selectionChanged";
           $tree->onDoubleClick = "downloadFile";
           
           $tree->selectMode = "file";
           $tree->permissionCallback = array($this, folderPermission);
           
           $root = $this->library->getLibraryDirectory();
           
           $tree->buildFolderTree($config["uploaddir"], $root);
                     
           foreach($this->documents as $doc)
           {
                // Do not list files to which the user does not have access
                if (!checkRole($doc->allow_access)) continue;
                
                $file = str_replace("/", DIRECTORY_SEPARATOR, $doc->file);
                $file = str_replace("\\", DIRECTORY_SEPARATOR, $file);
                
                trace($file, 4);
                $folderNode = $tree->findFolder(dirname($file));
                
                if ($folderNode != null)
                {
                     trace("Found Folder {$folderNode->id}", 4);
                     $id = str_replace(DIRECTORY_SEPARATOR, "_", $file);
                
                     $folderNode->add(new FileNode($id, basename($file), $doc->document_id));
                }
                else
                {
                     trace("*** NODE NOT FOUND - $file", 3);
                }
           }
                     
                $tree->children["documents"]->open = true;
           
                $page->page_title = "Documents";
      
                $tree->writeHTML(); 
  
                $this->drawButtons();
           }

◆ enumerateItems()

static DocumentManager::enumerateItems ( $items )

static

Enumerate the Document objects.

Parameters

$items collection that the Document items are returned in

Definition at line 568 of file document_manager.inc.

      {
           $documents = Query::create(DocumentLibrary, "ORDER BY name")->execute();
           
           $items["Document Libraries"] = $documents;
           return $items;
      }

◆ folderPermission()

DocumentManager::folderPermission ( $folder )

Definition at line 95 of file document_manager.inc.

      {
           global $user;
           
           $permission = true;
           
           if (strpos($folder, "Board Members Only") !== FALSE && (!checkRole("board,admin,super") && !$this->library->allowManageFiles()))
           {
                $permission = false;
           }
           
           trace("folderPermission: $folder ($permission)", 3);
           
           return $permission;
      }

◆ formatDocumentLink()

static DocumentManager::formatDocumentLink ( $document )

static

Definition at line 721 of file document_manager.inc.

      {
           $library = $document->DocumentLibrary();
           $size = $library->getFileSize($document);
           $img = DocumentHandler::getDocIcon($document->file);
      
           return "<img src='$img' alt='' style='display: inline-block; vertical-align: middle'>&nbsp;".
                   "<a href='/action/document/download?document_id={$document->document_id}'>{$document->title}</a>&nbsp;$size";
      }

◆ formatLinkPickerTitle()

DocumentManager::formatLinkPickerTitle ( $document )

Definition at line 704 of file document_manager.inc.

      {
           $file = $document->file;
           
           $type = getDocType($file);
           $icon = getDocIcon($file);
           
           $library = $document->DocumentLibrary();
           $file_size = $library->getFileSize($document);
           if($file_size)
           {
                $size = "($file_size)";
           }
                
           return $document->format("<a style='display: inline' id='document_id_{document_id}' href='#' ondblclick=\"new LinkPicker().documentPickerInsertLink({document_id})\" onclick=\"new LinkPicker().toggleDocumentSelected(this, {document_id}); return false;\">{title}</a>&nbsp;<img style='display:inline; vertical-align: middle' src='$icon' alt='$type'/>&nbsp;$size");
      }

◆ getMaxUploadBytes()

static DocumentManager::getMaxUploadBytes ( )

static

Calculate the maximum allowed file upload size in bytes.

Definition at line 923 of file document_manager.inc.

      {
           $max = ini_get("upload_max_filesize");
           
           if (endsWith($max, "M"))
           {
                $max *= 1024 * 1024;
           }
           else if (endsWith($max, "K"))
           {
                $max *= 1024;
           }
           else if (endsWidth($max, "G"))
           {
                $max *= 1024 * 1024 * 1024;
           }
           
           $postMax = ini_get("post_max_size");
           
           if (endsWith($postMax, "M"))
           {
                $postMax *= 1024 * 1024;
           }
           else if (endsWith($postMax, "K"))
           {
                $postMax *= 1024;
           }
           else if (endsWidth($postMax, "G"))
           {
                $postMax *= 1024 * 1024 * 1024;
           }
           
           return min($max, $postMax);
      }

◆ getMaxUploadSize()

static DocumentManager::getMaxUploadSize ( )

static

Returns the maximum allowed file upload size in human-readable format.

Definition at line 961 of file document_manager.inc.

      {
           return getScaledSize(DocumentManager::getMaxUploadBytes(), 0);
      }

◆ getRoleList()

static DocumentManager::getRoleList ( )

static

Definition at line 914 of file document_manager.inc.

      {
           $roles = DocumentManager::getRoleOptions();
           return implode(",", array_keys($roles));
      }    

◆ getRoleOptions()

static DocumentManager::getRoleOptions ( )

static

Definition at line 907 of file document_manager.inc.

      {
           $roles = SiteRole::getRolesArray();
           $roles["visitor"] = "Visitor";     
           return $roles;
      }

◆ getStyles()

static DocumentManager::getStyles ( )

static

Definition at line 731 of file document_manager.inc.

      {
           $styles .= "<link href=\"/fakoli/css/tabs.css\" rel=\"stylesheet\"/>\n";
           
           return $styles;
      }    

◆ importMetaData()

DocumentManager::importMetaData ( $file )

Definition at line 782 of file document_manager.inc.

      {
           $this->indexedDocuments = reindexList($this->documents, "file");
           
           $fp = fopen($file, "r");
           
           $fields = fgetcsv($fp);
           
           $fileIdx = -1;
           
           foreach($fields as $field)
           {
                if ($field == "file")
                {
                     $fileIdx = $i;
                     break;
                }
                
                $i++;
           }
  
           if ($fileIdx < 0)
           {
                throw new FakoliException("'field' column not present");
           }
           
           while($values = fgetcsv($fp))
           {
                $files = explode(";", $values[$fileIdx]);
                foreach($files as $f)
                {
                     $f = trim($f);
                     
                     trace($path, 3);
                     
                     foreach($this->indexedDocuments as $path => $doc)
                     {
                          if (basename($path) == $f)
                          {
                               $i = 0;
                               
                               foreach($fields as $field)
                               {
                                    if ($field == "file")
                                    {
                                         $i++;
                                         break;
                                    }
                                    
                                    $doc->set($field, $values[$i]);
                                    $i++;
                               }
                          
                               $doc->save();
                          }
                     }
                }
           }
      }

◆ registerCommentAdapter()

static DocumentManager::registerCommentAdapter ( )

static

Definition at line 987 of file document_manager.inc.

      {
           CommentManager::registerAdapter("document", Document, DocumentCommentXref);
      }

◆ registerSearchables()

static DocumentManager::registerSearchables ( $searchables )

static

Definition at line 966 of file document_manager.inc.

      {
           trace("DocumentManager registerSearchables", 3);
           if (!Settings::getValue("solr", "enabled"))
           {
                $searchables["document"] = array(Document);
           }
           return $searchables;
      }

◆ registerSerializationHandler()

static DocumentManager::registerSerializationHandler ( )

static

Definition at line 998 of file document_manager.inc.

      {
           SerializationManager::registerHandler("document_libraries", "Document Libraries &amp; Document Records (files need to be transferred manually)", new DocumentSerializationHandler());
           return true;
      }

◆ registerSolrAdapter()

static DocumentManager::registerSolrAdapter ( )

static

Definition at line 976 of file document_manager.inc.

      {
           SolrManager::registerSolrAdapter(Document, new DocumentSolrAdapter());
      }

◆ registerTaxonomyClasses()

static DocumentManager::registerTaxonomyClasses ( $classes )

static

Definition at line 992 of file document_manager.inc.

      {
           $classes[] = Document;
           return $classes;
      }

◆ rescan()

DocumentManager::rescan ( )

Definition at line 738 of file document_manager.inc.

      {
           $this->indexedDocuments = reindexList($this->documents, "file");
           $this->indexedFolders = IndexedQuery::create(DocumentFolder, "WHERE document_library_id=:id", "path")
                                                        ->bind(":id", $this->library->document_library_id)
                                                        ->execute();
                                                        
           $this->scanFiles("documents");                                                       
      }

◆ scanFiles()

DocumentManager::scanFiles ( $path )

Definition at line 748 of file document_manager.inc.

      {
           global $user;
           
           $base = sanitizePath($this->library->getLibraryDirectory() . DIRECTORY_SEPARATOR . $path);
           
           $files = scandir($base);
           foreach($files as $file)
           {
                if ($file == "." || $file == "..") continue;
                 
                $f = $path . DIRECTORY_SEPARATOR . $file;
                                    
                if (is_dir($base . DIRECTORY_SEPARATOR . $file))
                {
                     $this->scanFiles($f);
                }
                else
                {
                     if ($this->indexedDocuments[$f]) continue;
                     
                     $doc = new Document();
                     $doc->title = $file;
                     $doc->file = $f;
                     $doc->keywords = "";
                     $doc->notes = "";
                     $doc->public = true;
                     $doc->document_library_id = $this->library->document_library_id;
                     $doc->owner_id = $user->get($user->getPrimaryKey());
                     $doc->save();
                }
           }
      }

◆ setDefaults()

static DocumentManager::setDefaults ( )

static

Definition at line 1004 of file document_manager.inc.

      {
           Settings::setDefaultValue("document", "show_upload_details",  true, Boolean, "Include upload details on the document library view");
           Settings::setDefaultValue("document", "link_to_details", false, Boolean, "Link to the document details page for each document from the library view");
           Settings::setDefaultValue("document", "show_table_filter", false, Boolean, "Show the generic column filter controls for the document table view");
           Settings::setDefaultValue("document", "always_display_PDFs_in_browser", false, Boolean, "When downloading PDF documents, have them display in the browser in a new tab, rather than as a file download");
      }

◆ upgradeComponent()

static DocumentManager::upgradeComponent ( $version )

static

Definition at line 981 of file document_manager.inc.

      {
           $mgr = new DocumentUpgradeManager();
           $mgr->upgrade($version);
      }    

◆ uploadFile()

DocumentManager::uploadFile	(	$field,
		$folder
	)

Upload a file from the specified form field to the specified folder within the current document library.

Parameters

string	$field	the form field containing the record for uploaded file
string	$folder	the folder within the document library to which the file is to be uploaded

Returns: string the path of the uploaded file within the document library.

Definition at line 432 of file document_manager.inc.

      {
           
           if (!$_FILES[$field]) 
           {
                throw new FakoliException("No upload record found.");
           }
           
           if ($_FILES[$field]["name"]=="") 
           {
                throw new FakoliException("Upload name is empty");
           }
           
           /* Copy across the uploaded file */
           $folder = str_replace("/", DIRECTORY_SEPARATOR, $folder);
           $folder = str_replace("\\", DIRECTORY_SEPARATOR, $folder);
           
           $name = $_FILES[$field]["name"];
           
           if (!$folder) $folder = "documents";
           
           $filepath = $folder . DIRECTORY_SEPARATOR . $name;
           $base = $this->library->getLibraryDirectory();
           $dir = $base . DIRECTORY_SEPARATOR . $folder;
           $fullpath = $dir . DIRECTORY_SEPARATOR . $name;
           
           trace("Upload Directory: {$dir}", 3);
                     
           trace("Uploading file to $fullpath", 3);
           
           if (!file_exists($dir))
           {
                // If the directory does not exist, create it 
                mkdir($dir);
           }
           
           if (file_exists($fullpath))
           {
                // If a previous copy of the file already exists, remove it
                unlink($fullpath);
           }
           
           move_uploaded_file($_FILES[$field]["tmp_name"], $fullpath);
           chmod($fullpath, 0755);
           
           return str_replace(DIRECTORY_SEPARATOR, "/", $filepath);
      }

◆ writeScript()

DocumentManager::writeScript ( )

Definition at line 111 of file document_manager.inc.

      {
           global $dialogs;
           
           ob_start();
 ?>
 <div class="dialog" id="documentManagerDlg" style="width: 760px">
  <div class="dialog_header" id="documentManagerDlgHeader">
   <div style="padding: 4px;">
    <div style="float: right">&nbsp;<a id='closeDocumentManagerDlg' href="javascript:docManagerDlg.hide();">Close &times;</a></div>
    <span style="font-weight: bold" id="documentManagerTitle">Document Manager</span>
   </div>  
  </div>
  <div id="documentManagerDlgBody" class="dialog_body">
  </div>
 </div>
 <?
           $dialogs .= ob_get_contents();
           ob_end_clean();
           
           ob_start();
 ?>
 <script type="text/javascript">
  
 window.addEvent('domready', function()
 {
      docManagerDlg = new ModalDialog(document.id('documentManagerDlg'), {handle: document.id('documentManagerDlgHeader'), draggable: true, body: document.id('documentManagerDlgBody')});
 });       
  
 function downloadFile()
 {
      id = document.id('files_value').value;
      go("/action/document/download?document_id=" + id);
 }
  
 function editFile()
 {
      id = document.id('files_value').value;
      docManagerDlg.show(function() {}, "/action/document/edit?document_id=" + id);
 }
  
 function editResult(result)
 {
      if (result == "1")
      {
           docManagerDlg.hide();
      }
      else
      {
           document.id('Document_form__error').set({'text': result, 'display': 'table-cell'});
      }
 }
  
  
 function uploadFile()
 {
      id = document.id('files_value').value;
      docManagerDlg.show(function() {}, "/action/document/upload?document_library_id=<?echo $this->library->document_library_id?>");
 }
  
 function uploadResult(responseText)
 {
      if (responseText == "1") 
      {
           window.location.reload();
      }
      else
      {
           alert(responseText);
      }
 }
  
 function deleteFile()
 {
      if (confirm("Are you sure you want to delete this file?"))
      {
           id = document.id('files_value').value;
           
           var request = new Request({'url':       '/action/document/delete?document_id=' + id, 
                                            'method':   'get',
                                            'onSuccess': function(responseText) 
           { 
                if (responseText == "1") 
                {
                     window.location.reload();
                }
                else
                {
                     alert(responseText);
                }
           },
           'onFailure':   function() { alert("Failed to communicate with server");}});
  
           request.send();
      }
 }    
  
 function selectionChanged()
 {
      var id = document.id('files_value').value;
  
      if (id > 0)
      {
           document.id('download').removeProperty("disabled");
           if(document.id('edit')) document.id('edit').removeProperty("disabled");
           document.id('deleteButton').removeProperty("disabled");
           
      }
      else
      {
           document.id('download').addProperty("disabled", "disabled");
           if(document.id('edit')) document.id('edit').addProperty("disabled", "disabled");
           document.id('deleteButton').addProperty("disabled", "disabled");
      }
 }
  
 function rescanLibrary()
 {
      result = httpRequest("/action/document/rescan?document_library_id=<?echo $this->library->document_library_id?>");
      if (result == "OK")
      {
           window.location.reload();
      }
      else
      {
           alert(result);
      }
 }
  
 <?
           if (checkRole($this->library->manage_folders) || $this->library->allowManageFiles())
           {
 ?>
 function createFolder()
 {
      docManagerDlg.show(function() {}, "/action/document/create_folder?document_library_id=<?echo $this->library->document_library_id?>");
 }
  
 function createFolderResult(result)
 {
      if (result == 1)
      {
           window.location.reload();
      }
      else
      {
           alert(result);
      }
 }
  
 function deleteFolder()
 {
      docManagerDlg.show(function() {}, "/action/document/delete_folder?document_library_id=<?echo $this->library->document_library_id?>");
 }
  
 function deleteFolderResult(result)
 {
      if (result == 1)
      {
           window.location.reload();
      }
      else
      {
           alert(result);
      }
 }
  
 <?
           }
 ?>
 </script>
 <?
           $script .= ob_get_contents();
           ob_end_clean();
           return $script;          
      }

◆ zipLibrary()

static DocumentManager::zipLibrary	(	$library_id,
		$process = `null`
	)

static

Generate a ZIP archive of all the documents in the specified library.

Parameters

integer $library_id the ID of the library to be zipped

Definition at line 846 of file document_manager.inc.

      {
           global $config;
           
           Fakoli::assertRole("admin");
           $library = new DocumentLibrary($library_id);
           
           if ($process)
           {
                $process->setProgress("Running", "Scanning files", 0);
           }
           
           $files = $library->Documents("ORDER BY file");
           
           $libraryFileName = $library->format("library_{document_library_id}.zip");
           $libraryDir = $library->getLibraryDirectory();
           $libraryZipFile = $config['uploadbase'] . DIRECTORY_SEPARATOR . $libraryFileName;
           if (file_exists($libraryZipFile))
           {
                unlink($libraryZipFile);
           }
           
  
           $zip = new ZipArchive();
           
           // open archive
           if ($zip->open($libraryZipFile, ZIPARCHIVE::CREATE) !== TRUE) 
           {
                if ($process)
                {
                     $process->setProgress("Error", "Could not create ZIP archive");
                     throw new FakoliException("Could not create ZIP archive");
                }
           }
  
           $max = count($files);
           $c = 0;
           
           foreach($files as $file)
           {
                $fullPath = $libraryDir . DIRECTORY_SEPARATOR . $file->file;
                $zip->addFile($fullPath, $file->file);
      
                if ($process)
                {
                     $process->setProgress("Running", "Added $c of $max ".pluralize("file", $max), number_format(100 * $c / $max, 0));
                }
           }
           
           $zip->close();
           
           if ($process)
           {
                $process->setProgress("Completed", "Zip archive created", 100);
           }
      }

Member Data Documentation

◆ $docs

DocumentManager::$docs

Definition at line 73 of file document_manager.inc.

◆ $documents

DocumentManager::$documents

Definition at line 74 of file document_manager.inc.

◆ $height

DocumentManager::$height = 400

Definition at line 76 of file document_manager.inc.

◆ $library

DocumentManager::$library

Definition at line 72 of file document_manager.inc.

◆ $width

DocumentManager::$width = 700

Definition at line 75 of file document_manager.inc.

The documentation for this class was generated from the following file:

C:/code/cms.sonjara.com/cms/components/document/document_manager.inc

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

◆ buildDocumentLibraryForm()

◆ createLibrary()

◆ createLibraryObj()

◆ deleteDocument()

◆ deleteDocumentLibrary()

◆ deleteFolder()

◆ deleteRole()

◆ deleteUser()

◆ displayLibrary()

◆ documentLibraryTabs()

◆ DocumentManager()

◆ drawButtons()

◆ drawSelectView()

◆ drawView()

◆ enumerateItems()

◆ folderPermission()

◆ formatDocumentLink()

◆ formatLinkPickerTitle()

◆ getMaxUploadBytes()

◆ getMaxUploadSize()

◆ getRoleList()

◆ getRoleOptions()

◆ getStyles()

◆ importMetaData()

◆ registerCommentAdapter()

◆ registerSearchables()

◆ registerSerializationHandler()

◆ registerSolrAdapter()

◆ registerTaxonomyClasses()

◆ rescan()

◆ scanFiles()

◆ setDefaults()

◆ upgradeComponent()

◆ uploadFile()

◆ writeScript()

◆ zipLibrary()

Member Data Documentation

◆ $docs

◆ $documents

◆ $height

◆ $library

◆ $width