Class PublisherItem

Base class for all objects in the Xoops kernel (and beyond)

Xoops\Core\Kernel\XoopsObject implements ArrayAccess

PublisherItem

Package: Xoops\Core\Kernel
Category: Xoops\Core\Kernel\XoopsObject
Copyright: 2000-2015 XOOPS Project (http://xoops.org)
License: GPL 2 or later (http://www.gnu.org/licenses/gpl-2.0.html)
Author: Kazumi Ono (AKA onokazu) <http://www.myweb.ne.jp/, http://jp.xoops.org/>
Author: Taiwen Jiang phppp@users.sourceforge.net
Since: 2.0.0
Link: http://xoops.org
Located at odules/publisher/class/item.php

Methods summary
`public`	# `__construct( integer\|null $id = null )` Parameters `$id`
`public null\|PublisherCategory`	# `category( )` Returns null\|`PublisherCategory`
`public string`	# `title( integer $maxLength = 0, string $format = "S" )` Parameters `$maxLength` `$format` Returns string
`public mixed\|string`	# `subtitle( integer $maxLength = 0, string $format = "S" )` Parameters `$maxLength` `$format` Returns mixed\|string
`public mixed\|string`	# `summary( integer $maxLength = 0, string $format = "S", string $stripTags = '' )` Parameters `$maxLength` `$format` `$stripTags` Returns mixed\|string
`public mixed\|string`	# `getBlockSummary( integer $maxLength = 0, boolean $fullSummary = false )` Parameters `$maxLength` `$fullSummary` Returns mixed\|string
`public string`	# `wrappage( string $file_name )` Parameters `$file_name` Returns string
`public mixed\|string`	# `body( integer $maxLength = 0, string $format = 'S', string $stripTags = '' )` This method returns the body to be displayed. Not to be used for editing This method returns the body to be displayed. Not to be used for editing Parameters `$maxLength` `$format` `$stripTags` Returns mixed\|string
`public string`	# `datesub( string $dateFormat = '', string $format = 'S' )` Parameters `$dateFormat` `$format` Returns string
`public string`	# `posterName( integer $realName = -1 )` Parameters `$realName` Returns string
`public string`	# `posterAvatar( )` Returns string
`public string`	# `linkedPosterName( )` Returns string
`public mixed`	# `updateCounter( )` Returns mixed
`public boolean`	# `store( boolean $force = true )` Parameters `$force` Returns boolean
`public string`	# `getCategoryName( )` Returns string
`public string`	# `getCategoryUrl( )` Returns string
`public string`	# `getCategoryLink( )` Returns string
`public string`	# `getCategoryPath( boolean $withAllLink = true )` Parameters `$withAllLink` Returns string
`public string`	# `getCategoryImagePath( )` Returns string
`public mixed`	# `getFiles( )` Returns mixed
`public string`	# `getAdminLinks( )` Returns string
`public`	# `sendNotifications( array $notifications = array() )` Parameters `$notifications`
`public boolean`	# `notLoaded( )` Returns boolean
`public string`	# `getItemUrl( )` Returns string
`public string`	# `getItemLink( boolean $class = false, integer $maxsize = 0 )` Parameters `$class` `$maxsize` Returns string
`public string`	# `getWhoAndWhen( )` Returns string
`public string`	# `plain_maintext( null\|string $body = null )` Parameters `$body` Returns string
`public string`	# `buildmaintext( integer $item_page_id = -1, null\|string $body = null )` Parameters `$item_page_id` `$body` Returns string
`public mixed`	# `getImages( )` Returns mixed
`public array`	# `toArray( string $display = 'default', integer $max_char_title = 0, integer $max_char_summary = 0, boolean $full_summary = false )` Parameters `$display` `$max_char_title` `$max_char_summary` `$full_summary` Returns array Overrides `Xoops\Core\Kernel\XoopsObject::toArray()`
`public array`	# `toArrayFull( array $item )` Parameters `$item` Returns array
`public array`	# `toArrayAll( array $item, integer $item_page_id )` Parameters `$item` `$item_page_id` Returns array
`public array`	# `getMainImage( array $item = array() )` Parameters `$item` Returns array
`public array`	# `getOtherImages( array $item = array() )` Parameters `$item` Returns array
`public string`	# `highlight( string $content, string\|array $keywords )` Parameters `$content` `$keywords` Returns string Text
`public`	# `createMetaTags( )` Create metada and assign it to template Create metada and assign it to template
`public string`	# `_convert_for_japanese( string $str )` Parameters `$str` Returns string
`public boolean`	# `accessGranted( )` Checks if a user has access to a selected item. if no item permissions are set, access permission is denied. The user needs to have necessary category permission as well. Also, the item needs to be Published Checks if a user has access to a selected item. if no item permissions are set, access permission is denied. The user needs to have necessary category permission as well. Also, the item needs to be Published Returns boolean : TRUE if the no errors occured
`public`	# `setVarsFromRequest( )` The name says it all The name says it all

Methods inherited from Xoops\Core\Kernel\XoopsObject
`__clone(), assignVar(), assignVars(), cleanVars(), destroyVars(), getErrors(), getHtmlErrors(), getValues(), getVar(), getVars(), initVar(), isDirty(), isNew(), loadFilters(), offsetExists(), offsetGet(), offsetSet(), offsetUnset(), registerFilter(), setDirty(), setErrors(), setFormVars(), setNew(), setVar(), setVars(), unsetDirty(), unsetNew(), xoopsClone()`

Properties summary
`public Publisher`	`$publisher`	# `null`
`public PublisherCategory`	`$_category`	# `null`

Properties inherited from Xoops\Core\Kernel\XoopsObject
`$cleanVars, $plugin_path, $vars`

Namespaces

Classes

Interfaces

Functions

Class PublisherItem

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Returns

Parameters

Returns

Returns

Returns

Returns

Parameters

Returns

Returns

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Overrides

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns