oxNews Class Reference

Inheritance diagram for oxNews:

Collaboration diagram for oxNews:

Public Member Functions
	__construct ()
	assign ($dbRecord)
	getGroups ()
	inGroup ($sGroupID)
	delete ($sOxid=null)
	getLongDesc ()
Public Member Functions inherited from oxI18n
	setLanguage ($iLang=null)
	getLanguage ()
	setEnableMultilang ($blEmployMultilanguage)
	isMultilingualField ($sFieldName)
	isMultilang ()
	loadInLang ($iLanguage, $sOxid)
	modifyCacheKey ($sCacheKey, $blOverride=false)
	getAvailableInLangs ()
	getUpdateSqlFieldName ($sField)
Public Member Functions inherited from oxBase
	getUseSkipSaveFields ()
	setUseSkipSaveFields ($blUseSkipSaveFields)
	__set ($sName, $sValue)
	__get ($sName)
	__isset ($mVar)
	__clone ()
	oxClone ($oObject)
	getUpdateSeo ()
	setUpdateSeo ($blUpdateSeo)
	init ($sTableName=null, $blForceAllFields=false)
	getClassName ()
	getCoreTableName ()
	getId ()
	setId ($sOXID=null)
	setShopId ($iShopId)
	getShopId ()
	getViewName ($blForceCoreTableUsage=null)
	disableLazyLoading ()
	isDerived ()
	setIsDerived ($blVal)
	load ($sOXID)
	isLoaded ()
	buildSelectString ($aWhere=null)
	assignRecord ($sSelect)
	getFieldData ($sFieldName)
	getSelectFields ($blForceCoreTableUsage=null)
	save ()
	allowDerivedUpdate ()
	allowDerivedDelete ()
	exists ($sOXID=null)
	getSqlActiveSnippet ($blForceCoreTable=null)
	beforeUpdate ($sOXID=null)
	onChange ($iAction=null, $sOXID=null)
	setInList ()
	isOx ()
	isReadOnly ()
	setReadOnly ($blReadOnly)
	getFieldNames ()
	addFieldName ($sName)
Public Member Functions inherited from oxSuperCfg
	__call ($sMethod, $aArgs)
	getConfig ()
	setConfig ($oConfig)
	getSession ()
	setSession ($oSession)
	getUser ()
	setUser ($oUser)
	isAdmin ()
	setAdminMode ($blAdmin)

Protected Member Functions
	_update ()
	_insert ()
	_setFieldData ($sFieldName, $sValue, $iDataType=oxField::T_TEXT)
Protected Member Functions inherited from oxI18n
	_getFieldStatus ($sFieldName)
	_getNonCachedFieldNames ($blForceFullStructure=false)
	_getFieldLang ($sFieldName)
	_setUpdateSeoOnFieldChange ($sField)
	_getUpdateFieldsForTable ($sTable, $blUseSkipSaveFields=true)
	_getUpdateFields ($blUseSkipSaveFields=true)
	_getLanguageSetTables ($sCoreTableName=null)
	_getObjectViewName ($sTable, $sShopID=null)
	_getAllFields ($blReturnSimple=false)
	_addField ($sName, $sStatus, $sType=null, $sLength=null)
	_canFieldBeNull ($sFieldName)
Protected Member Functions inherited from oxBase
	_removeElement2ShopRelations ($sOxId)
	_isInList ()
	_getTableFields ($sTable, $blReturnSimple=false)
	_initDataStructure ($blForceFullStructure=false)
	_getFieldLongName ($sFieldName)
	_getFieldDefaultValue ($sFieldName)
	_getUpdateFieldValue ($sFieldName, $oField)
	_isDisabledFieldCache ()
	_addSkippedSaveFieldsForMapping ()
	_disableLazyLoadingForCaching ()

Protected Attributes
	$_oGroups = null
	$_sClassName = 'oxnews'
Protected Attributes inherited from oxI18n
	$_sClassName = 'oxI18n'
	$_iLanguage = null
	$_blEmployMultilanguage = true
Protected Attributes inherited from oxBase
	$_sOXID = null
	$_iShopId = null
	$_blIsSimplyClonable = true
	$_sClassName = 'oxbase'
	$_sCoreTable = null
	$_sViewTable = null
	$_aFieldNames = array('oxid' => 0)
	$_sCacheKey = null
	$_blUseLazyLoading = false
	$_aSkipSaveFields = array('oxtimestamp')
	$_blUseSkipSaveFields = true
	$_sExistKey = 'oxid'
	$_blIsDerived = null
	$_blIsSeoObject = false
	$_blUpdateSeo = true
	$_blReadOnly = false
	$_blIsInList = false
	$_isLoaded = false
	$_aInnerLazyCache = null
	$_blEmployMultilanguage = false

Additional Inherited Members
Static Protected Attributes inherited from oxBase
static	$_blDisableFieldCaching = array()

Detailed Description

News manager. Performs news text collection. News may be sorted by user categories (only these user may read news), etc.

Deprecated:

since v.5.3.0 (2016-06-17); The Admin Menu: Customer Info -> News feature will be moved to a module in v6.0.0

Definition at line 10 of file oxnews.php.

Constructor & Destructor Documentation

oxNews::__construct

(

)

Class constructor, initiates parent constructor (parent::oxI18n()).

Returns

null

Reimplemented from oxI18n.

Definition at line 32 of file oxnews.php.

Member Function Documentation

oxNews::_insert ( )

protected

Inserts object details to DB, returns true on success.

Returns

bool

Reimplemented from oxI18n.

Definition at line 138 of file oxnews.php.

oxNews::_setFieldData (   $sFieldName,   $sValue,   $iDataType = oxField::T_TEXT  )

protected

Sets data field value

Parameters

string	$sFieldName	index OR name (eg. 'oxarticles__oxtitle') of a data field to set
string	$sValue	value of data field
int	$iDataType	field type

Returns

null

Reimplemented from oxBase.

Definition at line 160 of file oxnews.php.

oxNews::_update ( )

protected

Updates object information in DB.

Reimplemented from oxI18n.

Definition at line 125 of file oxnews.php.

oxNews::assign

(

$dbRecord

)

Assigns object data.

Parameters

string

$dbRecord

database record to be assigned

Returns

null

Reimplemented from oxBase.

Definition at line 45 of file oxnews.php.

oxNews::delete

(

$sOxid = null

)

Deletes object information from DB, returns true on success.

Parameters

string

$sOxid

Object ID (default null)

Returns

bool

Reimplemented from oxI18n.

Definition at line 104 of file oxnews.php.

oxNews::getGroups

(

)

Returns list of user groups assigned to current news object

Returns

oxlist

Definition at line 61 of file oxnews.php.

oxNews::getLongDesc

(

)

get long description, parsed through smarty

Returns

string

Definition at line 176 of file oxnews.php.

oxNews::inGroup

(

$sGroupID

)

Checks if this object is in group, returns true on success.

Parameters

string

$sGroupID

user group ID

Returns

bool

Definition at line 83 of file oxnews.php.

Member Data Documentation

oxNews::$_oGroups = null

protected

Definition at line 18 of file oxnews.php.

oxNews::$_sClassName = 'oxnews'

protected

Definition at line 25 of file oxnews.php.

---

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

• application/models/oxnews.php