DocumentSearchResult Class Reference

Inheritance diagram for DocumentSearchResult:

Collaboration diagram for DocumentSearchResult:

Public Member Functions
	DocumentSearchResult ($item)
	getPrimaryKey ()
	get ($field)
	prettifyClassName ($plural=false)
	format ($format)
	relevance ()
	title ()
	date ()
	summary ()
	Display the item title and any other essential details for the item such as author and a create date. More...
Public Member Functions inherited from AbstractSearchResult
	formatIcon ($icon, $alt)

Public Attributes
	$item

Detailed Description

Definition at line 202 of file document.inc.

Member Function Documentation

date()

DocumentSearchResult::date

(

)

Reimplemented from AbstractSearchResult.

Definition at line 226 of file document.inc.

     {
          return $this->item->publication_date;
     }

DocumentSearchResult()

DocumentSearchResult::DocumentSearchResult

(

$item

)

Definition at line 206 of file document.inc.

     {
          $this->item = $item;
     }

format()

DocumentSearchResult::format

(

$format

)

Reimplemented from AbstractSearchResult.

Definition at line 214 of file document.inc.

{ return $this->item->format($format); }

get()

DocumentSearchResult::get

(

$field

)

Reimplemented from AbstractSearchResult.

Definition at line 212 of file document.inc.

{ return $this->item->get($field); }

getPrimaryKey()

DocumentSearchResult::getPrimaryKey

(

)

Reimplemented from AbstractSearchResult.

Definition at line 211 of file document.inc.

{ return $this->item->getPrimaryKey(); }

prettifyClassName()

DocumentSearchResult::prettifyClassName

(

$plural = false

)

Reimplemented from AbstractSearchResult.

Definition at line 213 of file document.inc.

{ return $this->item->prettifyClassName($plural = false); }

relevance()

DocumentSearchResult::relevance

(

)

Reimplemented from AbstractSearchResult.

Definition at line 216 of file document.inc.

     {
          return 1;
     }

summary()

DocumentSearchResult::summary

(

)

Display the item title and any other essential details for the item such as author and a create date.

If Application Settings is set to show text fragment, display the teaser and a Read More link; otherwise, put the link to the full item' details directly on the title.

Reimplemented from AbstractSearchResult.

Definition at line 231 of file document.inc.

     {
          $file = $this->item->file;
               
          $library = $this->item->DocumentLibrary();
          $size = $library->getFileSize($this->item);
 
          if (Settings::getValue("document", "link_to_details"))
          {
               $link = "/document_details";  
               $linkText = "View Details";
          }
          else
          {
               $link = "/action/document/download";
               $linkText = "Download";
          }
          
          $img = $this->formatIcon(getDocIcon($file), getDocType($file));
          return $this->item->format("<h4>{title}</h4><p><em>{author} {publication_date:short}</em></p>{$img} <a href='{$link}?document_id={document_id}'>{$linkText}</a> $size");
     }

title()

DocumentSearchResult::title

(

)

Reimplemented from AbstractSearchResult.

Definition at line 221 of file document.inc.

     {
          return $this->item->title;
     }

Member Data Documentation

$item

DocumentSearchResult::$item

Definition at line 204 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