oxVendor Class Reference

Inheritance diagram for oxVendor:

Collaboration diagram for oxVendor:

Public Member Functions
	__construct ()
	setShowArticleCnt ($blShowArticleCount=false)
	assign ($dbRecord)
	load ($sOxid)
	getBaseSeoLink ($iLang, $iPage=0)
	getLink ($iLang=null)
	getBaseStdLink ($iLang, $blAddId=true, $blFull=true)
	getStdLink ($iLang=null, $aParams=array())
	getNrOfArticles ()
	getSubCats ()
	getIsVisible ()
	setIsVisible ($blVisible)
	getHasVisibleSubCats ()
	setHasVisibleSubCats ($blHasVisibleSubcats)
	getContentCats ()
	delete ($sOXID=null)
	getIconUrl ()
	getThumbUrl ()
	getTitle ()
	getShortDescription ()
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)
	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
	_setRootObjectData ()
Protected Member Functions inherited from oxI18n
	_getFieldStatus ($sFieldName)
	_getNonCachedFieldNames ($blForceFullStructure=false)
	_getFieldLang ($sFieldName)
	_setUpdateSeoOnFieldChange ($sField)
	_getUpdateFieldsForTable ($sTable, $blUseSkipSaveFields=true)
	_getUpdateFields ($blUseSkipSaveFields=true)
	_update ()
	_getLanguageSetTables ($sCoreTableName=null)
	_insert ()
	_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)
	_setFieldData ($sFieldName, $sValue, $iDataType=oxField::T_TEXT)
	_getFieldDefaultValue ($sFieldName)
	_getUpdateFieldValue ($sFieldName, $oField)
	_isDisabledFieldCache ()
	_addSkippedSaveFieldsForMapping ()
	_disableLazyLoadingForCaching ()

Protected Attributes
	$_sClassName = 'oxvendor'
	$_blShowArticleCnt = false
	$_iNrOfArticles = -1
	$_blIsSeoObject = true
	$_blIsVisible
	$_blHasVisibleSubCats
	$_aSeoUrls = array()
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

Static Protected Attributes
static	$_aRootVendor = array()

Detailed Description

Vendor manager

Definition at line 7 of file oxvendor.php.

Constructor & Destructor Documentation

oxVendor::__construct

(

)

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

Reimplemented from oxI18n.

Definition at line 62 of file oxvendor.php.

Member Function Documentation

oxVendor::_setRootObjectData ( )

protected

Sets root vendor data. Returns true

Returns

bool

Definition at line 118 of file oxvendor.php.

oxVendor::assign

(

$dbRecord

)

Assigns to $this object some base parameters/values.

Parameters

array

$dbRecord

parameters/values

Reimplemented from oxBase.

Definition at line 84 of file oxvendor.php.

oxVendor::delete

(

$sOXID = null

)

Delete this object from the database, returns true on success.

Parameters

string

$sOXID

Object ID(default null)

Returns

bool

Reimplemented from oxI18n.

Definition at line 286 of file oxvendor.php.

oxVendor::getBaseSeoLink	(		$iLang,
			$iPage = 0
	)

Returns raw content seo url

Parameters

int	$iLang	language id
int	$iPage	page number [optional]

Returns

string

Definition at line 136 of file oxvendor.php.

oxVendor::getBaseStdLink	(		$iLang,
			$blAddId = true,
			$blFull = true
	)

Returns base dynamic url: shopurl/index.php?cl=details

Parameters

int	$iLang	language id
bool	$blAddId	add current object id to url or not
bool	$blFull	return full including domain name [optional]

Returns

string

Implements oxIUrl.

Definition at line 179 of file oxvendor.php.

oxVendor::getContentCats

(

)

Empty method, called in templates when vendor is used in same code like category

Definition at line 275 of file oxvendor.php.

oxVendor::getHasVisibleSubCats

(

)

returns if a vendor has visible sub categories

Returns

bool

Definition at line 253 of file oxvendor.php.

oxVendor::getIconUrl

(

)

Returns article picture

Returns

string

Definition at line 303 of file oxvendor.php.

oxVendor::getIsVisible

(

)

returns the visibility of a vendor

Returns

bool

Definition at line 233 of file oxvendor.php.

oxVendor::getLink

(

$iLang = null

)

Returns vendor link Url

Parameters

int

$iLang

language id [optional]

Returns

string

Implements oxIUrl.

Definition at line 153 of file oxvendor.php.

oxVendor::getNrOfArticles

(

)

returns number or articles of this vendor

Returns

integer

Definition at line 212 of file oxvendor.php.

oxVendor::getShortDescription

(

)

Returns short description

Returns

string

Definition at line 341 of file oxvendor.php.

oxVendor::getStdLink	(		$iLang = null,
			$aParams = array()
	)

Returns standard URL to vendor

Parameters

int	$iLang	language
array	$aParams	additional params to use [optional]

Returns

string

Implements oxIUrl.

Definition at line 198 of file oxvendor.php.

oxVendor::getSubCats

(

)

returns the sub category array

Definition at line 224 of file oxvendor.php.

oxVendor::getThumbUrl

(

)

Returns category thumbnail picture url if exist, false - if not

Returns

mixed

Definition at line 321 of file oxvendor.php.

oxVendor::getTitle

(

)

Returns vendor title

Returns

string

Definition at line 331 of file oxvendor.php.

oxVendor::load

(

$sOxid

)

Loads object data from DB (object data ID is passed to method). Returns true on success.

Parameters

string

$sOxid

object id

Returns

oxvendor

Reimplemented from oxBase.

Definition at line 104 of file oxvendor.php.

oxVendor::setHasVisibleSubCats

(

$blHasVisibleSubcats

)

sets the state of has visible sub vendors

Parameters

bool

$blHasVisibleSubcats

marker if vendor has visible subcategories

Definition at line 267 of file oxvendor.php.

oxVendor::setIsVisible

(

$blVisible

)

sets the visibilty of a category

Parameters

bool

$blVisible

vendors visibility status setter

Definition at line 243 of file oxvendor.php.

oxVendor::setShowArticleCnt

(

$blShowArticleCount = false

)

Marker to load vendor article count info setter

Parameters

bool

$blShowArticleCount

Marker to load vendor article count

Definition at line 74 of file oxvendor.php.

Member Data Documentation

oxVendor::$_aRootVendor = array()

staticprotected

Definition at line 10 of file oxvendor.php.

oxVendor::$_aSeoUrls = array()

protected

Definition at line 57 of file oxvendor.php.

oxVendor::$_blHasVisibleSubCats

protected

Definition at line 50 of file oxvendor.php.

oxVendor::$_blIsSeoObject = true

protected

Definition at line 36 of file oxvendor.php.

oxVendor::$_blIsVisible

protected

Definition at line 43 of file oxvendor.php.

oxVendor::$_blShowArticleCnt = false

protected

Definition at line 22 of file oxvendor.php.

oxVendor::$_iNrOfArticles = -1

protected

Definition at line 29 of file oxvendor.php.

oxVendor::$_sClassName = 'oxvendor'

protected

Definition at line 15 of file oxvendor.php.

---

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

• application/models/oxvendor.php