Document Class Reference

This class maps the publication table. More...

Inheritance diagram for Document:

Collaboration diagram for Document:

Public Member Functions
	Topics ($constraint="")
	Comments ($constraint="")
	Image ()
	Owner ()
	isOwner ()
	fileshareAllowEdit ()
	fileshareAllowDelete ()
	DocumentLibrary ()
	Document ()
	search ($params, $range=null)
	DataItems must implement this method to provide search functionality. More...

Public Attributes
	$fields
	$relations
	$fieldAliases

Detailed Description

This class maps the publication table.

Definition at line 42 of file document.inc.

Member Function Documentation

Comments()

Document::Comments

(

$constraint = ""

)

Definition at line 80 of file document.inc.

     {
          return $this->crossReference(Comment, DocumentCommentXref, $constraint);
     }

Document()

Document::Document

(

)

Definition at line 140 of file document.inc.

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

DocumentLibrary()

Document::DocumentLibrary

(

)

Definition at line 135 of file document.inc.

     {
          return $this->getRelated(DocumentLibrary);
     }

fileshareAllowDelete()

Document::fileshareAllowDelete

(

)

Definition at line 124 of file document.inc.

     {
          $library = $this->DocumentLibrary();
          
          if($this->isOwner() || $library->isOwner() || 
               checkRole($library->delete_files))
               return true;
          else
               return false;
     }

fileshareAllowEdit()

Document::fileshareAllowEdit

(

)

Definition at line 109 of file document.inc.

     {
          global $user;
          
          $library = $this->DocumentLibrary();
          
          $member = $library->getFileshareUser($user->user_id);
          
          if($this->isOwner() || checkRole($library->manage_folders) || 
          checkRole($library->upload_files) || checkRole($library->delete_files) || $member)
               return true;
          else
               return false;
     }

Image()

Document::Image

(

)

Definition at line 85 of file document.inc.

     {
          return $this->getRelated(ImageRecord);
     }

isOwner()

Document::isOwner

(

)

Definition at line 96 of file document.inc.

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

Owner()

Document::Owner

(

)

Definition at line 90 of file document.inc.

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

search()

Document::search	(		$params,
			$range = null
	)

DataItems must implement this method to provide search functionality.

Parameters

mixed	$params	either search text or a SearchParameters object
array	$range	an array of primary key IDs to which the search must be constrained

Implements Searchable.

Definition at line 154 of file document.inc.

     {
          trace("Searching Documents", 3);
          
 
          if ($range)
          {
               $range = " AND {$this->primary_key} IN (".implode($range, ", ").")";
          }
          
          if (is_object($params))
          {
               $search = clone $params;
               $search->target = $this;
               
               if (!$range)
               {
                    if (!$search->get("text", "like"))
                    {
                         $search->secondaryFields("author", "notes", "publication");
                    }
                    else
                    {
                         $search->remapField("text", "notes");
                    }
               }
               
               $constraint = $search->generateConstraint();
               $constraint .= $constraint ? " AND public=1" : " WHERE public=1";
               
               $constraint .= $range;
               
               $documents = Query::create(Document, $constraint)
                                     ->execute();
          }
          else
          {
               $params = preg_replace('/[^\w]+/', ' ', $params);
               $params = "%$params%";
               $documents = Query::create(Document, "WHERE (title like :a OR keywords LIKE :b OR notes Like :c) and public=1 $range")
                                ->bind(":a", $params, ":b", $params, ":c", $params)
                                ->execute();
          }
                                     
          return SearchManager::wrap($documents, DocumentSearchResult);
     }

Topics()

Document::Topics

(

$constraint = ""

)

Definition at line 75 of file document.inc.

     {
          return $this->crossReference(Topic, DocumentTopicXref, $constraint);
     }

Member Data Documentation

$fieldAliases

Document::$fieldAliases

Initial value:

= array("image_id"  =>   "Image", 
                                     "url"             =>   "External URL")

Definition at line 72 of file document.inc.

$fields

Document::$fields

Initial value:

= array("document_id"              =>   Number,
                              "title"                       =>   String,
                              "file"                        =>   String,
                              "url"                         =>   String,
                              "publication_date"       =>   Date,
                              "keywords"                    =>  String,
                              "author"                 =>   String,
                              "publication"            =>   String,
                              "image_id"                    =>   Image,
                              "notes"                       =>   HTML,
                              "public"                 =>   Boolean,
                              "last_modified"               =>   Timestamp,
                              "document_library_id"    =>   Number,
                              "owner_id"                    =>   Number,
                              "allow_access"           =>   String
     )

Definition at line 46 of file document.inc.

$relations

Document::$relations

Initial value:

= array(  "Topics"            =>   Topic,
                                   "Owner"                  =>   "",
                                   "DocumentLibrary"   =>   DocumentLibrary,
                                   "Comments"               =>   Comment,
                                   "Image"                  =>   ImageRecord
     )

Definition at line 65 of file document.inc.

---

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

• C:/code/cms.sonjara.com/cms/components/document/datamodel/document.inc