oxActions Class Reference

Inheritance diagram for oxActions:

Collaboration diagram for oxActions:

Public Member Functions
	__construct ()
	addArticle ($sOxId)
	removeArticle ($sOxId)
	delete ($sOxId=null)
	getTimeLeft ()
	getTimeUntilStart ()
	start ()
	stop ()
	isRunning ()
	getLongDesc ()
	getBannerArticle ()
	getBannerPictureUrl ()
	getBannerLink ()
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)
	assign ($dbRecord)
	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 Attributes
	$_sClassName = "oxactions"
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
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)
Static Protected Attributes inherited from oxBase
static	$_blDisableFieldCaching = array()

Detailed Description

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

Definition at line 7 of file oxactions.php.

Constructor & Destructor Documentation

oxActions::__construct

(

)

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

Reimplemented from oxI18n.

Definition at line 20 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

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 76 of file oxactions.php.

oxActions::getBannerArticle

(

)

return assigned banner article

Returns

oxArticle

Definition at line 193 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 238 of file oxactions.php.

oxActions::getBannerPictureUrl

(

)

Returns assigned banner article picture url

Returns

string

Definition at line 223 of file oxactions.php.

oxActions::getLongDesc

(

)

get long description, parsed through smarty

Returns

string

Definition at line 181 of file oxactions.php.

oxActions::getTimeLeft

(

)

return time left until finished

Returns

int

Definition at line 99 of file oxactions.php.

oxActions::getTimeUntilStart

(

)

return time left until start

Returns

int

Definition at line 112 of file oxactions.php.

oxActions::isRunning

(

)

check if this action is active

Returns

bool

Definition at line 151 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 55 of file oxactions.php.

oxActions::start

(

)

start the promotion NOW!

Definition at line 123 of file oxactions.php.

oxActions::stop

(

)

stop the promotion NOW!

Definition at line 140 of file oxactions.php.

Member Data Documentation

oxActions::$_sClassName = "oxactions"

protected

Definition at line 15 of file oxactions.php.

---

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

• application/models/oxactions.php