Inherits DataItem.

Public Member Functions
	Owner ()

	isOwner ()

	Documents ($constraint="")

	Folders ($constraint="")

	getOwnerName ()

	getLibraryDirectory ()

	getFolders ($constraint="")

	countDocuments ()

	FileshareUsers ($constraint="")

	getFileshareUser ($user_id)

	allowAccess ()

	allowDelete ()
	Can only delete an empty library. More...

	allowManageFiles ()

	fileshareAllowUpload ()

	isFileshareMember ()

	getFileSize ($document)

	DocumentLibrary ()

Static Public Member Functions
static	findByIdentifier ($identifier)

static	getDefaultRole ($fileshare=false)

Public Attributes
	$fields

	$relations

Detailed Description

Definition at line 41 of file document_library.inc.

Member Function Documentation

◆ allowAccess()

DocumentLibrary::allowAccess ( )

Definition at line 156 of file document_library.inc.

      {
           global $user;
           
           if(!$user)
                $user = FileshareManager::setVisitor();
                
           if($this->isOwner() || checkRole($this->allow_access) || $this->isFileshareMember($user->user_id))
           {
                return true;
           }
           return false;
      }

◆ allowDelete()

DocumentLibrary::allowDelete ( )

Can only delete an empty library.

Returns: boolean

Definition at line 175 of file document_library.inc.

      {
           if(!$this->document_library_id) return false;
           
           return (!count($this->Documents()) && checkRole($this->delete_files)) ? true : false;
      }

◆ allowManageFiles()

DocumentLibrary::allowManageFiles ( )

Definition at line 182 of file document_library.inc.

      {
           global $user;
           
           if(!$user)
                return false;
                
           if($this->isOwner() || checkRole($this->manage_folders) || $this->isFileshareMember())
           {
                return true;
           }
           return false;
           
      }

◆ countDocuments()

DocumentLibrary::countDocuments ( )

Definition at line 128 of file document_library.inc.

      {
           return queryValue(Document, "COUNT(1)", "WHERE document_library_id={$this->document_library_id}");
      }

◆ DocumentLibrary()

DocumentLibrary::DocumentLibrary ( )

Definition at line 256 of file document_library.inc.

      {
           $this->primary_key = "document_library_id";
           $this->table = "document_library";
      
           $this->default_format = "{name}";
           $this->cacheLocal = true;
           
           // Patch in the user class, since this can be overridden by the application
           $mgr = new UserManager();
           $this->relations["Owner"] = $mgr->getUserClass(); 
           
           $this->DataItem(func_get_args());
      }

◆ Documents()

DocumentLibrary::Documents ( $constraint = "" )

Definition at line 89 of file document_library.inc.

      {
           return $this->getRelatedList(Document, "", $constraint);
      }

◆ fileshareAllowUpload()

DocumentLibrary::fileshareAllowUpload ( )

Definition at line 197 of file document_library.inc.

      {
           global $user;
           
           if(!$user)
                return false;
           
           if($this->isOwner() || checkRole($this->upload_files) || $this->isFileshareMember())
                return true;
           else
                return false;
      }

◆ FileshareUsers()

DocumentLibrary::FileshareUsers ( $constraint = "" )

Definition at line 142 of file document_library.inc.

      {
           return $this->getRelatedList(FileshareUserXref, "document_library_id", $constraint); 
      }

◆ findByIdentifier()

static DocumentLibrary::findByIdentifier ( $identifier )

static

Definition at line 133 of file document_library.inc.

      {
           $match = Query::create(DocumentLibrary, "WHERE identifier=:id")
                            ->bind(":id", $identifier)
                            ->executeSingle();
  
           return $match;
      }

◆ Folders()

DocumentLibrary::Folders ( $constraint = "" )

Definition at line 94 of file document_library.inc.

      {
           return $this->getRelatedList(DocumentFolder, "", $constraint);
      }

◆ getDefaultRole()

static DocumentLibrary::getDefaultRole ( $fileshare = false )

static

Definition at line 227 of file document_library.inc.

      {
           $identifier = $_REQUEST["identifier"];
  
           if(preg_match("/fileshare/i", $identifier) || $fileshare)
                $constraint = "WHERE role like 'admin%' or role like 'fileshare%'";
           else
                $constraint = "WHERE role like 'admin%'";
      
           $roles = Query::create(SiteRole, $constraint)->execute();
  
           if(count($roles) > 0)
                $role = formatItems($roles, "{role}", ",");
                
           return $role;
      }

◆ getFileshareUser()

DocumentLibrary::getFileshareUser ( $user_id )

Definition at line 147 of file document_library.inc.

      {
           $xrefs = $this->FileshareUsers("WHERE user_id = $user_id");
           return (count($xrefs) > 0) ? $xrefs[0] : null;    
      }

◆ getFileSize()

DocumentLibrary::getFileSize ( $document )

Definition at line 244 of file document_library.inc.

      {
           $path = $this->getLibraryDirectory() . DIRECTORY_SEPARATOR . $document->file;
           
           if (file_exists($path))
           {
                return getScaledSize(filesize($path));  
           }
           
           return "";
      }

◆ getFolders()

DocumentLibrary::getFolders ( $constraint = "" )

Definition at line 123 of file document_library.inc.

      {
           return reindexList($this->Folders($constraint), "path");
      }

◆ getLibraryDirectory()

DocumentLibrary::getLibraryDirectory ( )

Definition at line 106 of file document_library.inc.

      {
           global $config;
           
           $d = $config['uploadbase'] . DIRECTORY_SEPARATOR . "library_{$this->document_library_id}";
           
           if (!is_dir($d) && !file_exists($d))
           {
                $docs = $d.DIRECTORY_SEPARATOR."documents";
                mkdir($d);
                mkdir($docs);
                chmod($docs, 0777);
           }         
           
           return $d;
      }

◆ getOwnerName()

DocumentLibrary::getOwnerName ( )

Definition at line 99 of file document_library.inc.

      {
           $owner = $this->Owner();
           
           return ($owner) ? $owner->getFullName() : "";
      }

◆ isFileshareMember()

DocumentLibrary::isFileshareMember ( )

Definition at line 211 of file document_library.inc.

      {
           global $user;
           
           $member = $this->getFileshareUser($user->user_id);
           
           return ($member) ? true : false;
      }

◆ isOwner()

DocumentLibrary::isOwner ( )

Definition at line 76 of file document_library.inc.

      {
           global $user;
           
           if(!$user)
                return false;
                
           $owner = $this->Owner();
  
           return ($owner->user_id == $user->user_id) ? true : false;
      }

◆ Owner()

DocumentLibrary::Owner ( )

Definition at line 67 of file document_library.inc.

      {
           if(!$this->owner_id)
                return null;
                
           $mgr = new UserManager();
           return $mgr->getUser($this->owner_id);
      }

Member Data Documentation

◆ $fields

DocumentLibrary::$fields

Initial value:

= array("document_library_id" =>   Number,
                              "name"                        =>   String,
                              "identifier"             =>   String,
                              "description"            =>   Text,
                              "hidden"                 =>   Boolean,
                              "allow_comments"         =>   Boolean,
                              "owner_id"                    =>   Number,
                              "allow_access"           =>   String,
                              "manage_folders"         =>   String,
                              "upload_files"           =>   String,
                              "delete_files"           =>   String,
                              "create_date"            =>   Timestamp,
                              "last_modified"               =>   Timestamp)

Definition at line 45 of file document_library.inc.

◆ $relations

DocumentLibrary::$relations