oxActions Class Reference

Inheritance diagram for oxActions:

Collaboration diagram for oxActions:

List of all members.

Public Member Functions
	__construct ()
	addArticle ($sOxId)
	removeArticle ($sOxId)
	delete ($sOxId=null)
	getTimeLeft ()
	getTimeUntilStart ()
	start ()
	stop ()
	isRunning ()
	getLongDesc ()
	getBannerArticle ()
	getBannerPictureUrl ()
	getBannerLink ()
Protected Attributes
	$_sClassName = "oxactions"

---

Detailed Description

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

Definition at line 6 of file oxactions.php.

---

Constructor & Destructor Documentation

oxActions.__construct

(

)

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

Reimplemented from oxI18n.

Definition at line 18 of file oxactions.php.

---

Member Function Documentation

oxActions.addArticle

(

$

sOxId

)

Adds an article to this actions

Parameters:

string

$sOxId id of the article to be added

Returns:

null

Definition at line 31 of file oxactions.php.

oxActions.delete

(

$

sOxId = null

)

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

Parameters:

string

$sOxId Object ID

Returns:

bool

Reimplemented from oxI18n.

Definition at line 72 of file oxactions.php.

oxActions.getBannerArticle

(

)

return assigned banner article

Returns:

oxArticle

Definition at line 187 of file oxactions.php.

oxActions.getBannerLink

(

)

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

Returns:

string

Definition at line 230 of file oxactions.php.

oxActions.getBannerPictureUrl

(

)

Returns assigned banner article picture url

Returns:

string

Definition at line 216 of file oxactions.php.

oxActions.getLongDesc

(

)

get long description, parsed through smarty

Returns:

string

Definition at line 177 of file oxactions.php.

oxActions.getTimeLeft

(

)

return time left until finished

Returns:

int

Definition at line 95 of file oxactions.php.

oxActions.getTimeUntilStart

(

)

return time left until start

Returns:

int

Definition at line 107 of file oxactions.php.

oxActions.isRunning

(

)

check if this action is active

Returns:

bool

Definition at line 148 of file oxactions.php.

oxActions.removeArticle

(

$

sOxId

)

Removes an article from this actions

Parameters:

string

$sOxId id of the article to be removed

Returns:

null

Definition at line 53 of file oxactions.php.

oxActions.start

(

)

start the promotion NOW!

Returns:

null

Definition at line 119 of file oxactions.php.

oxActions.stop

(

)

stop the promotion NOW!

Returns:

null

Definition at line 137 of file oxactions.php.

---

Member Data Documentation

oxActions.$_sClassName = "oxactions" [protected]

Reimplemented from oxI18n.

Definition at line 13 of file oxactions.php.

---

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

• core/oxactions.php