OxidEsales\EshopCommunity\Application\Model\Vendor Class Reference

Inheritance diagram for OxidEsales\EshopCommunity\Application\Model\Vendor:

Collaboration diagram for OxidEsales\EshopCommunity\Application\Model\Vendor:

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=[])
	getNrOfArticles ()
	getSubCats ()
	getIsVisible ()
	setIsVisible ($blVisible)
	getHasVisibleSubCats ()
	setHasVisibleSubCats ($blHasVisibleSubcats)
	getContentCats ()
	delete ($sOXID=null)
	getIconUrl ()
	getThumbUrl ()
	getTitle ()
	getShortDescription ()

Protected Member Functions
	_setRootObjectData ()

Protected Attributes
	$_sClassName = 'oxvendor'
	$_blShowArticleCnt = false
	$_iNrOfArticles = -1
	$_blIsSeoObject = true
	$_blIsVisible
	$_blHasVisibleSubCats
	$_aSeoUrls = []

Static Protected Attributes
static	$_aRootVendor = []

Detailed Description

Vendor manager

Constructor & Destructor Documentation

__construct()

OxidEsales\EshopCommunity\Application\Model\Vendor::__construct

(

)

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

Member Function Documentation

_setRootObjectData()

OxidEsales\EshopCommunity\Application\Model\Vendor::_setRootObjectData ( )

protected

Sets root vendor data. Returns true

Returns

bool

assign()

OxidEsales\EshopCommunity\Application\Model\Vendor::assign

(

$dbRecord

)

Assigns to $this object some base parameters/values.

Parameters

array

$dbRecord

parameters/values

delete()

OxidEsales\EshopCommunity\Application\Model\Vendor::delete

(

$sOXID = null

)

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

Parameters

string

$sOXID

Object ID(default null)

Returns

bool

getBaseSeoLink()

OxidEsales\EshopCommunity\Application\Model\Vendor::getBaseSeoLink	(		$iLang,
			$iPage = 0
	)

Returns raw content seo url

Parameters

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

Returns

string

getBaseStdLink()

OxidEsales\EshopCommunity\Application\Model\Vendor::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

getContentCats()

OxidEsales\EshopCommunity\Application\Model\Vendor::getContentCats

(

)

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

getHasVisibleSubCats()

OxidEsales\EshopCommunity\Application\Model\Vendor::getHasVisibleSubCats

(

)

returns if a vendor has visible sub categories

Returns

bool

getIconUrl()

OxidEsales\EshopCommunity\Application\Model\Vendor::getIconUrl

(

)

Returns article picture

Returns

string

getIsVisible()

OxidEsales\EshopCommunity\Application\Model\Vendor::getIsVisible

(

)

returns the visibility of a vendor

Returns

bool

getLink()

OxidEsales\EshopCommunity\Application\Model\Vendor::getLink

(

$iLang = null

)

Returns vendor link Url

Parameters

int

$iLang

language id [optional]

Returns

string

getNrOfArticles()

OxidEsales\EshopCommunity\Application\Model\Vendor::getNrOfArticles

(

)

returns number or articles of this vendor

Returns

integer

getShortDescription()

OxidEsales\EshopCommunity\Application\Model\Vendor::getShortDescription

(

)

Returns short description

Returns

string

getStdLink()

OxidEsales\EshopCommunity\Application\Model\Vendor::getStdLink	(		$iLang = null,
			$aParams = []
	)

Returns standard URL to vendor

Parameters

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

Returns

string

getSubCats()

OxidEsales\EshopCommunity\Application\Model\Vendor::getSubCats

(

)

returns the sub category array

getThumbUrl()

OxidEsales\EshopCommunity\Application\Model\Vendor::getThumbUrl

(

)

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

Returns

mixed

getTitle()

OxidEsales\EshopCommunity\Application\Model\Vendor::getTitle

(

)

Returns vendor title

Returns

string

load()

OxidEsales\EshopCommunity\Application\Model\Vendor::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

setHasVisibleSubCats()

OxidEsales\EshopCommunity\Application\Model\Vendor::setHasVisibleSubCats

(

$blHasVisibleSubcats

)

sets the state of has visible sub vendors

Parameters

bool

$blHasVisibleSubcats

marker if vendor has visible subcategories

setIsVisible()

OxidEsales\EshopCommunity\Application\Model\Vendor::setIsVisible

(

$blVisible

)

sets the visibilty of a category

Parameters

bool

$blVisible

vendors visibility status setter

setShowArticleCnt()

OxidEsales\EshopCommunity\Application\Model\Vendor::setShowArticleCnt

(

$blShowArticleCount = false

)

Marker to load vendor article count info setter

Parameters

bool

$blShowArticleCount

Marker to load vendor article count

Member Data Documentation

$_aRootVendor

OxidEsales\EshopCommunity\Application\Model\Vendor::$_aRootVendor = []

staticprotected

$_aSeoUrls

OxidEsales\EshopCommunity\Application\Model\Vendor::$_aSeoUrls = []

protected

$_blHasVisibleSubCats

OxidEsales\EshopCommunity\Application\Model\Vendor::$_blHasVisibleSubCats

protected

$_blIsSeoObject

OxidEsales\EshopCommunity\Application\Model\Vendor::$_blIsSeoObject = true

protected

$_blIsVisible

OxidEsales\EshopCommunity\Application\Model\Vendor::$_blIsVisible

protected

$_blShowArticleCnt

OxidEsales\EshopCommunity\Application\Model\Vendor::$_blShowArticleCnt = false

protected

$_iNrOfArticles

OxidEsales\EshopCommunity\Application\Model\Vendor::$_iNrOfArticles = -1

protected

$_sClassName

OxidEsales\EshopCommunity\Application\Model\Vendor::$_sClassName = 'oxvendor'

protected

---

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

• /oxideshop-ce/source/Application/Model/Vendor.php