XpressEngine Core  1.11.2
 All Classes Namespaces Files Functions Variables Pages
Public Member Functions | Public Attributes | List of all members
documentItem Class Reference
Inheritance diagram for documentItem:
BaseObject

Public Member Functions

 __construct ($document_srl=0, $load_extra_vars=true, $columnList=array())
 
 setDocument ($document_srl, $load_extra_vars=true)
 
 _loadFromDB ($load_extra_vars=true)
 
 setAttribute ($attribute, $load_extra_vars=true)
 
 isExists ()
 
 isGranted ()
 
 setGrant ()
 
 isAccessible ()
 
 allowComment ()
 
 allowTrackback ()
 
 isLocked ()
 
 isEditable ()
 
 isSecret ()
 
 isNotice ()
 
 useNotify ()
 
 doCart ()
 
 addCart ()
 
 removeCart ()
 
 isCarted ()
 
 notify ($type, $content)
 
 getLangCode ()
 
 getIpAddress ()
 
 isExistsHomepage ()
 
 getHomepageUrl ()
 
 getMemberSrl ()
 
 getUserID ()
 
 getUserName ()
 
 getNickName ()
 
 getLastUpdater ()
 
 getTitleText ($cut_size=0, $tail='...')
 
 getTitle ($cut_size=0, $tail='...')
 
 getContentText ($strlen=0)
 
 _addAllowScriptAccess ($m)
 
 _checkAllowScriptAccess ($m)
 
 getContent ($add_popup_menu=true, $add_content_info=true, $resource_realpath=false, $add_xe_content_class=true, $stripEmbedTagException=false)
 
 getTransContent ($add_popup_menu=true, $add_content_info=true, $resource_realpath=false, $add_xe_content_class=true)
 
 getSummary ($str_size=50, $tail= '...')
 
 getRegdate ($format= 'Y.m.d H:i:s')
 
 getRegdateTime ()
 
 getRegdateGM ()
 
 getRegdateDT ()
 
 getUpdate ($format= 'Y.m.d H:i:s')
 
 getUpdateTime ()
 
 getUpdateGM ()
 
 getUpdateDT ()
 
 getPermanentUrl ()
 
 getTrackbackUrl ()
 
 updateReadedCount ()
 
 isExtraVarsExists ()
 
 getExtraVars ()
 
 getExtraValue ($idx)
 
 getExtraValueHTML ($idx)
 
 getExtraEidValue ($eid)
 
 getExtraEidValueHTML ($eid)
 
 getExtraVarsValue ($key)
 
 getCommentCount ()
 
 getComments ()
 
 getTrackbackCount ()
 
 getTrackbacks ()
 
 thumbnailExists ($width=80, $height=0, $type= '')
 
 getThumbnail ($width=80, $height=0, $thumbnail_type= '')
 
 getExtraImages ($time_interval=43200)
 
 getStatus ()
 
 printExtraImages ($time_check=43200)
 
 hasUploadedFiles ()
 
 getUploadedFiles ($sortIndex= 'file_srl')
 
 getEditor ()
 
 isEnableComment ()
 
 getCommentEditor ()
 
 getProfileImage ()
 
 getSignature ()
 
 replaceResourceRealPath ($matches)
 
 _checkAccessibleFromStatus ()
 
 getTranslationLangCodes ()
 
 getDocumentMid ()
 
 getDocumentType ()
 
 getDocumentAlias ()
 
 getModuleName ()
 
 getBrowserTitle ()
 
- Public Member Functions inherited from BaseObject
 __construct ($error=0, $message= 'success')
 
 setError ($error=0)
 
 getError ()
 
 setHttpStatusCode ($code= '200')
 
 getHttpStatusCode ()
 
 setMessage ($message= 'success', $type=NULL)
 
 getMessage ()
 
 add ($key, $val)
 
 adds ($object)
 
 get ($key)
 
 gets ()
 
 getVariables ()
 
 getObjectVars ()
 
 toBool ()
 
 toBoolean ()
 

Public Attributes

 $document_srl = 0
 
 $lang_code = null
 
 $grant_cache = null
 
 $allow_trackback_status = null
 
 $columnList = array()
 
 $allowscriptaccessList = array()
 
 $allowscriptaccessKey = 0
 
 $uploadedFiles = array()
 
- Public Attributes inherited from BaseObject
 $error = 0
 
 $message = 'success'
 
 $variables = array()
 
 $httpStatusCode = NULL
 

Detailed Description

Definition at line 11 of file document.item.php.

Constructor & Destructor Documentation

documentItem::__construct (   $document_srl = 0,
  $load_extra_vars = true,
  $columnList = array() 
)

Constructor

Parameters
int$document_srl
bool$load_extra_vars
arraycolumnList
Returns
void

Definition at line 61 of file document.item.php.

Member Function Documentation

documentItem::_addAllowScriptAccess (   $m)

Definition at line 419 of file document.item.php.

documentItem::_checkAccessibleFromStatus ( )

Check accessible by document status

Parameters
array$matches
Returns
mixed

Definition at line 1184 of file document.item.php.

documentItem::_checkAllowScriptAccess (   $m)

Definition at line 429 of file document.item.php.

documentItem::_loadFromDB (   $load_extra_vars = true)

Get data from database, and set the value to documentItem object

Parameters
bool$load_extra_vars
Returns
void

Definition at line 80 of file document.item.php.

documentItem::addCart ( )

Definition at line 278 of file document.item.php.

documentItem::allowComment ( )

Definition at line 197 of file document.item.php.

documentItem::allowTrackback ( )

Definition at line 205 of file document.item.php.

documentItem::doCart ( )

Definition at line 271 of file document.item.php.

documentItem::getBrowserTitle ( )

Definition at line 1269 of file document.item.php.

documentItem::getCommentCount ( )

Definition at line 740 of file document.item.php.

documentItem::getCommentEditor ( )

Return comment editor's html

Returns
string

Definition at line 1120 of file document.item.php.

documentItem::getComments ( )

Definition at line 745 of file document.item.php.

documentItem::getContent (   $add_popup_menu = true,
  $add_content_info = true,
  $resource_realpath = false,
  $add_xe_content_class = true,
  $stripEmbedTagException = false 
)

Definition at line 462 of file document.item.php.

documentItem::getContentText (   $strlen = 0)

Definition at line 401 of file document.item.php.

documentItem::getDocumentAlias ( )

Returns the document's alias

Returns
string

Definition at line 1252 of file document.item.php.

documentItem::getDocumentMid ( )

Returns the document's mid in order to construct SEO friendly URLs

Returns
string

Definition at line 1230 of file document.item.php.

documentItem::getDocumentType ( )

Returns the document's type (document/page/wiki/board/etc)

Returns
string

Definition at line 1241 of file document.item.php.

documentItem::getEditor ( )

Return Editor html

Returns
string

Definition at line 1093 of file document.item.php.

documentItem::getExtraEidValue (   $eid)

Definition at line 691 of file document.item.php.

documentItem::getExtraEidValueHTML (   $eid)

Definition at line 714 of file document.item.php.

documentItem::getExtraImages (   $time_interval = 43200)

Functions to display icons for new post, latest update, secret(private) post, image/video/attachment Determine new post and latest update by $time_interval

Parameters
int$time_interval
Returns
array

Definition at line 980 of file document.item.php.

documentItem::getExtraValue (   $idx)

Definition at line 665 of file document.item.php.

documentItem::getExtraValueHTML (   $idx)

Definition at line 678 of file document.item.php.

documentItem::getExtraVars ( )

Definition at line 657 of file document.item.php.

documentItem::getExtraVarsValue (   $key)

Definition at line 733 of file document.item.php.

documentItem::getHomepageUrl ( )

Definition at line 341 of file document.item.php.

documentItem::getIpAddress ( )

Definition at line 325 of file document.item.php.

documentItem::getLangCode ( )

Definition at line 320 of file document.item.php.

documentItem::getLastUpdater ( )

Definition at line 371 of file document.item.php.

documentItem::getMemberSrl ( )

Definition at line 351 of file document.item.php.

documentItem::getModuleName ( )

Returns the document's actual title (browser_title)

Returns
string

Definition at line 1262 of file document.item.php.

documentItem::getNickName ( )

Definition at line 366 of file document.item.php.

documentItem::getPermanentUrl ( )

Definition at line 621 of file document.item.php.

documentItem::getProfileImage ( )

Return author's profile image

Returns
string

Definition at line 1132 of file document.item.php.

documentItem::getRegdate (   $format = 'Y.m.d H:i:s')

Definition at line 568 of file document.item.php.

documentItem::getRegdateDT ( )

Definition at line 590 of file document.item.php.

documentItem::getRegdateGM ( )

Definition at line 585 of file document.item.php.

documentItem::getRegdateTime ( )

Definition at line 573 of file document.item.php.

documentItem::getSignature ( )

Return author's signiture

Returns
string

Definition at line 1146 of file document.item.php.

documentItem::getStatus ( )

Definition at line 1024 of file document.item.php.

documentItem::getSummary (   $str_size = 50,
  $tail = '...' 
)

Definition at line 538 of file document.item.php.

documentItem::getThumbnail (   $width = 80,
  $height = 0,
  $thumbnail_type = '' 
)

Definition at line 812 of file document.item.php.

documentItem::getTitle (   $cut_size = 0,
  $tail = '...' 
)

Definition at line 386 of file document.item.php.

documentItem::getTitleText (   $cut_size = 0,
  $tail = '...' 
)

Definition at line 376 of file document.item.php.

documentItem::getTrackbackCount ( )

Definition at line 790 of file document.item.php.

documentItem::getTrackbacks ( )

Definition at line 795 of file document.item.php.

documentItem::getTrackbackUrl ( )

Definition at line 626 of file document.item.php.

documentItem::getTransContent (   $add_popup_menu = true,
  $add_content_info = true,
  $resource_realpath = false,
  $add_xe_content_class = true 
)

Return transformed content by Editor codes

Parameters
bool$add_popup_menu
bool$add_content_info
bool$resource_realpath
bool$add_xe_content_class
Returns
string

Definition at line 528 of file document.item.php.

documentItem::getTranslationLangCodes ( )

Definition at line 1205 of file document.item.php.

documentItem::getUpdate (   $format = 'Y.m.d H:i:s')

Definition at line 595 of file document.item.php.

documentItem::getUpdateDT ( )

Definition at line 616 of file document.item.php.

documentItem::getUpdateGM ( )

Definition at line 611 of file document.item.php.

documentItem::getUpdateTime ( )

Definition at line 600 of file document.item.php.

documentItem::getUploadedFiles (   $sortIndex = 'file_srl')

Definition at line 1073 of file document.item.php.

documentItem::getUserID ( )

Definition at line 356 of file document.item.php.

documentItem::getUserName ( )

Definition at line 361 of file document.item.php.

documentItem::hasUploadedFiles ( )

Definition at line 1065 of file document.item.php.

documentItem::isAccessible ( )

Definition at line 192 of file document.item.php.

documentItem::isCarted ( )

Definition at line 288 of file document.item.php.

documentItem::isEditable ( )

Definition at line 249 of file document.item.php.

documentItem::isEnableComment ( )

Check whether to have a permission to write comment Authority to write a comment and to write a document is separated

Returns
bool

Definition at line 1107 of file document.item.php.

documentItem::isExists ( )

Definition at line 155 of file document.item.php.

documentItem::isExistsHomepage ( )

Definition at line 335 of file document.item.php.

documentItem::isExtraVarsExists ( )

Definition at line 649 of file document.item.php.

documentItem::isGranted ( )

Definition at line 160 of file document.item.php.

documentItem::isLocked ( )

Definition at line 242 of file document.item.php.

documentItem::isNotice ( )

Definition at line 261 of file document.item.php.

documentItem::isSecret ( )

Definition at line 255 of file document.item.php.

documentItem::notify (   $type,
  $content 
)

Send notify message to document owner

Parameters
string$type
string$content
Returns
void

Definition at line 299 of file document.item.php.

documentItem::printExtraImages (   $time_check = 43200)

Return the value obtained from getExtraImages with image tag

Parameters
int$time_check
Returns
string

Definition at line 1038 of file document.item.php.

documentItem::removeCart ( )

Definition at line 283 of file document.item.php.

documentItem::replaceResourceRealPath (   $matches)

Change an image path in the content to absolute path

Parameters
array$matches
Returns
mixed

Definition at line 1174 of file document.item.php.

documentItem::setAttribute (   $attribute,
  $load_extra_vars = true 
)

Definition at line 127 of file document.item.php.

documentItem::setDocument (   $document_srl,
  $load_extra_vars = true 
)

Definition at line 69 of file document.item.php.

documentItem::setGrant ( )

Definition at line 186 of file document.item.php.

documentItem::thumbnailExists (   $width = 80,
  $height = 0,
  $type = '' 
)

Definition at line 805 of file document.item.php.

documentItem::updateReadedCount ( )

Update readed count

Returns
void

Definition at line 639 of file document.item.php.

documentItem::useNotify ( )

Definition at line 266 of file document.item.php.

Member Data Documentation

documentItem::$allow_trackback_status = null

Definition at line 32 of file document.item.php.

documentItem::$allowscriptaccessKey = 0

Definition at line 47 of file document.item.php.

documentItem::$allowscriptaccessList = array()

Definition at line 42 of file document.item.php.

documentItem::$columnList = array()

Definition at line 37 of file document.item.php.

documentItem::$document_srl = 0

Definition at line 17 of file document.item.php.

documentItem::$grant_cache = null

Definition at line 27 of file document.item.php.

documentItem::$lang_code = null

Definition at line 22 of file document.item.php.

documentItem::$uploadedFiles = array()

Definition at line 52 of file document.item.php.


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