OxidEsales\EshopCommunity\Application\Model\Actions Class Reference

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

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

Public Member Functions
	__construct ()
	addArticle ($articleId)
	removeArticle ($articleId)
	delete ($articleId=null)
	getTimeLeft ()
	getTimeUntilStart ()
	start ()
	stop ()
	isRunning ()
	getLongDesc ()
	getBannerArticle ()
	getBannerPictureUrl ()
	getBannerLink ()
	isDefault ()

Protected Member Functions
	fetchBannerArticleId ()

Protected Attributes
	$_sClassName = "oxactions"

Detailed Description

Article actions manager. Collects and keeps actions of chosen article.

Constructor & Destructor Documentation

__construct()

OxidEsales\EshopCommunity\Application\Model\Actions::__construct

(

)

Class constructor. Executes oxActions::init(), initiates parent constructor.

Member Function Documentation

addArticle()

OxidEsales\EshopCommunity\Application\Model\Actions::addArticle

(

$articleId

)

Adds an article to this actions

Parameters

string

$articleId

id of the article to be added

delete()

OxidEsales\EshopCommunity\Application\Model\Actions::delete

(

$articleId = null

)

Removes article action, returns true on success. For performance - you can not load action object - just pass action ID.

Parameters

string

$articleId

Object ID

Returns

bool

fetchBannerArticleId()

OxidEsales\EshopCommunity\Application\Model\Actions::fetchBannerArticleId ( )

protected

Fetch the oxobjectid of the article corresponding this action.

Returns

string The id of the oxobjectid belonging to this action.

getBannerArticle()

OxidEsales\EshopCommunity\Application\Model\Actions::getBannerArticle

(

)

return assigned banner article

Returns

oxArticle

getBannerLink()

OxidEsales\EshopCommunity\Application\Model\Actions::getBannerLink

(

)

Returns assigned banner link. If no link is defined and article is assigned to banner, article link will be returned.

Returns

string

getBannerPictureUrl()

OxidEsales\EshopCommunity\Application\Model\Actions::getBannerPictureUrl

(

)

Returns assigned banner article picture url

Returns

string

getLongDesc()

OxidEsales\EshopCommunity\Application\Model\Actions::getLongDesc

(

)

get long description, parsed through smarty

Returns

string

getTimeLeft()

OxidEsales\EshopCommunity\Application\Model\Actions::getTimeLeft

(

)

return time left until finished

Returns

int

getTimeUntilStart()

OxidEsales\EshopCommunity\Application\Model\Actions::getTimeUntilStart

(

)

return time left until start

Returns

int

isDefault()

OxidEsales\EshopCommunity\Application\Model\Actions::isDefault

(

)

Returns true if Action is default.

Returns

bool

isRunning()

OxidEsales\EshopCommunity\Application\Model\Actions::isRunning

(

)

check if this action is active

Returns

bool

removeArticle()

OxidEsales\EshopCommunity\Application\Model\Actions::removeArticle

(

$articleId

)

Removes an article from this actions

Parameters

string

$articleId

id of the article to be removed

Returns

bool

start()

OxidEsales\EshopCommunity\Application\Model\Actions::start

(

)

start the promotion NOW!

stop()

OxidEsales\EshopCommunity\Application\Model\Actions::stop

(

)

stop the promotion NOW!

Member Data Documentation

$_sClassName

OxidEsales\EshopCommunity\Application\Model\Actions::$_sClassName = "oxactions"

protected

---

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

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