Docs For Class Mage_XmlConnect_Model

Description

author: Magento Core Team <[email protected]>

Located in /XmlConnect/Model/Application.php (line 54)

Varien_Object
   |
   --Mage_Core_Model_Abstract
      |
      --Mage_XmlConnect_Model_Application

Class Constant Summary

APP_CODE_COOKIE_NAME = 'app_code'

APP_MAX_KEY_LENGTH = 40

APP_PREFIX_CUT_LENGTH = 3

APP_SCREEN_SIZE_DEFAULT = '320x480'

APP_SCREEN_SIZE_NAME = 'screen_size'

APP_SCREEN_SOURCE_DEFAULT = 'default'

APP_STATUS_INACTIVE = 0

APP_STATUS_SUCCESS = 1

XML_PATH_CONTACT_CREDENTIALS_EMAIL = 'xmlconnect/mobile_application/urbanairship_credentials_email'

XML_PATH_DESIGN_FOOTER_COPYRIGHT = 'design/footer/copyright'

XML_PATH_GENERAL_RESTRICTION_IS_ACTIVE = 'general/restriction/is_active'

XML_PATH_GENERAL_RESTRICTION_MODE = 'general/restriction/mode'

XML_PATH_URBAN_AIRSHIP_TOS_URL = 'xmlconnect/mobile_application/urbanairship_terms_of_service_url'

Variable Summary

null|string $code

null|array $conf

bool $is_resubmit_action

array $submit_params

array $_imageIds

null|array $_lastParams

Method Summary

string|null getActivationKey ()

string getAppKey ()

string getAppMasterSecret ()

string getAppSecret ()

string getCodePrefix ()

array: getEnabledTabsArray ()

array getFormData ()

array getImages ()

bool getIsSubmitted ()

array getLastParams ()

array getPages ()

array getRenderConf ()

string getScreenSize ()

int getStoreId ()

string getUserpwd ()

bool isCodePrefixed ()

Mage_XmlConnect_Model_Application loadByCode (string $code)

Mage_XmlConnect_Model_Application loadConfiguration ()

void loadDefaultConfiguration ()

bool loadSubmit ()

array prepareConfiguration ()

array prepareSubmitParams (array $data)

this setScreenSize (string $screenSize)

Mage_XmlConnect_Model_Application updateAllAppsUpdatedAtParameter ()

array|bool validate ()

array|bool validateSubmit (array $params)

array _absPath (array $subtree)

Mage_XmlConnect_Model_Application _beforeSave ()

array _configMerge ( $a, $b)

void _construct ()

array _flatArray (array $subtree, [string $prefix = null])

bool|array _validateConf ()

Variables

null|string $code (line 138)

Full application code

access: protected

null|array $conf (line 145)

Main configuration of current application

access: protected

bool $is_resubmit_action = false (line 131)

Application submit action type

access: protected

array $submit_params = array() (line 124)

Application submit info

access: protected

array $_imageIds = array('icon', 'loader_image', 'logo', 'big_logo') (line 110)

Images in "Params" history table

access: protected

null|array $_lastParams (line 117)

Last submitted data from history table

access: protected

Inherited Variables

Inherited from Mage_Core_Model_Abstract

Mage_Core_Model_Abstract::$_cacheTag
Mage_Core_Model_Abstract::$_dataSaveAllowed
Mage_Core_Model_Abstract::$_eventObject
Mage_Core_Model_Abstract::$_eventPrefix
Mage_Core_Model_Abstract::$_isObjectNew
Mage_Core_Model_Abstract::$_resource
Mage_Core_Model_Abstract::$_resourceCollectionName
Mage_Core_Model_Abstract::$_resourceName

Methods

getActivationKey (line 858)

Getter, returns activation key for current application

access: public

string|null getActivationKey ()

getAppKey (line 895)

Getter for Application Key

access: public

string getAppKey ()

getAppMasterSecret (line 915)

Getter for Application Master Secret

access: public

string getAppMasterSecret ()

getAppSecret (line 905)

Getter for Application Secret

access: public

string getAppSecret ()

getCodePrefix (line 293)

Return first part for application code field

access: public

string getCodePrefix ()

getEnabledTabsArray (line 455)

Return Enabled Tabs array from actual config

access: public

array: getEnabledTabsArray ()

getFormData (line 220)

Load data (flat array) for Varien_Data_Form

access: public

array getFormData ()

getImages (line 581)

Returns ( image[ ID ] => "SRC" ) array

access: public

array getImages ()

getIsSubmitted (line 210)

Checks is it app is submitted (edit is premitted only before submission)

access: public

bool getIsSubmitted ()

getLastParams (line 616)

Return last submitted data from history table

access: public

array getLastParams ()

getPages (line 490)

Return content pages

access: public

array getPages ()

getRenderConf (line 325)

Get config formatted for rendering

access: public

array getRenderConf ()

getScreenSize (line 429)

Return current screen_size parameter

access: public

string getScreenSize ()

getStoreId (line 845)

Retrieve Store Id

access: public

int getStoreId ()

getUserpwd (line 885)

Getter return concatenated user and password

access: public

string getUserpwd ()

isCodePrefixed (line 304)

Checks if application code field has autoincrement

access: public

bool isCodePrefixed ()

loadByCode (line 537)

Load application by code

access: public

Mage_XmlConnect_Model_Application loadByCode (string $code)

string $code

loadConfiguration (line 516)

Load configuration data (from serialized blob)

access: public

Mage_XmlConnect_Model_Application loadConfiguration ()

loadDefaultConfiguration (line 282)

Set default configuration data

access: public

void loadDefaultConfiguration ()

loadSubmit (line 548)

Loads submit tab data from xmlconnect/history table

access: public

bool loadSubmit ()

prepareConfiguration (line 315)

Load application configuration

access: public

array prepareConfiguration ()

prepareSubmitParams (line 784)

Imports post/get data into the model

access: public

array prepareSubmitParams (array $data)

array $data: - $_REQUEST[]

setScreenSize (line 444)

Setter for current screen_size parameter

access: public

this setScreenSize (string $screenSize)

string $screenSize

updateAllAppsUpdatedAtParameter (line 874)

Perform update for all applications "updated at" parameter with current date

access: public

Mage_XmlConnect_Model_Application updateAllAppsUpdatedAtParameter ()

validate (line 629)

Validate application data

access: public

array|bool validate ()

validateSubmit (line 653)

Validate submit application data

access: public

array|bool validateSubmit (array $params)

array $params

_absPath (line 469)

Change URLs to absolute

access: protected

array _absPath (array $subtree)

array $subtree

_beforeSave (line 503)

Processing object before save data

access: protected

Mage_XmlConnect_Model_Application _beforeSave ()

Redefinition of:

Mage_Core_Model_Abstract::_beforeSave(): Processing object before save data

_configMerge (line 259)

Like array_merge_recursive(), but string values is replaced

access: protected

array _configMerge ( $a, $b)

array $a
array $b

_construct (line 199)

Initialize application

access: protected

void _construct ()

_flatArray (line 233)

Load data (flat array) for Varien_Data_Form

access: protected

array _flatArray (array $subtree, [string $prefix = null])

array $subtree
string $prefix

_validateConf (line 717)

Check config for valid values

throws: Mage_Core_Exception
access: protected

bool|array _validateConf ()

Inherited Methods

Inherited From Mage_Core_Model_Abstract

Mage_Core_Model_Abstract::afterCommitCallback()
Mage_Core_Model_Abstract::afterLoad()
Mage_Core_Model_Abstract::cleanModelCache()
Mage_Core_Model_Abstract::clearInstance()
Mage_Core_Model_Abstract::delete()
Mage_Core_Model_Abstract::getCacheIdTags()
Mage_Core_Model_Abstract::getCacheTags()
Mage_Core_Model_Abstract::getCollection()
Mage_Core_Model_Abstract::getEntityId()
Mage_Core_Model_Abstract::getId()
Mage_Core_Model_Abstract::getIdFieldName()
Mage_Core_Model_Abstract::getResource()
Mage_Core_Model_Abstract::getResourceCollection()
Mage_Core_Model_Abstract::getResourceName()
Mage_Core_Model_Abstract::isObjectNew()
Mage_Core_Model_Abstract::load()
Mage_Core_Model_Abstract::save()
Mage_Core_Model_Abstract::setId()
Mage_Core_Model_Abstract::_afterDelete()
Mage_Core_Model_Abstract::_afterDeleteCommit()
Mage_Core_Model_Abstract::_afterLoad()
Mage_Core_Model_Abstract::_afterSave()
Mage_Core_Model_Abstract::_afterSaveCommit()
Mage_Core_Model_Abstract::_beforeDelete()
Mage_Core_Model_Abstract::_beforeLoad()
Mage_Core_Model_Abstract::_beforeSave()
Mage_Core_Model_Abstract::_clearData()
Mage_Core_Model_Abstract::_clearReferences()
Mage_Core_Model_Abstract::_getEventData()
Mage_Core_Model_Abstract::_getResource()
Mage_Core_Model_Abstract::_hasModelChanged()
Mage_Core_Model_Abstract::_init()
Mage_Core_Model_Abstract::_protectFromNonAdmin()
Mage_Core_Model_Abstract::_setResourceModel()

Class Constants

APP_CODE_COOKIE_NAME = 'app_code' (line 61)

Application code cookie name

APP_MAX_KEY_LENGTH = 40 (line 152)

Submission/Resubmission key max length

APP_PREFIX_CUT_LENGTH = 3 (line 103)

Application prefix length of cutted part of deviceType and storeCode

APP_SCREEN_SIZE_DEFAULT = '320x480' (line 75)

Device screen size name

APP_SCREEN_SIZE_NAME = 'screen_size' (line 68)

Device screen size name

APP_SCREEN_SOURCE_DEFAULT = 'default' (line 82)

Device screen size source name

APP_STATUS_INACTIVE = 0 (line 96)

Application status "not submitted" value

APP_STATUS_SUCCESS = 1 (line 89)

Application status "submitted" value

XML_PATH_CONTACT_CREDENTIALS_EMAIL = 'xmlconnect/mobile_application/urbanairship_credentials_email' (line 161)

XML path to config with an email address for contact to receive credentials of Urban Airship notifications

XML_PATH_DESIGN_FOOTER_COPYRIGHT = 'design/footer/copyright' (line 175)

XML path to config copyright data

XML_PATH_GENERAL_RESTRICTION_IS_ACTIVE = 'general/restriction/is_active' (line 183)

XML path to config restriction status (EE module)

XML_PATH_GENERAL_RESTRICTION_MODE = 'general/restriction/mode' (line 191)

XML path to config restriction mode (EE module)

XML_PATH_URBAN_AIRSHIP_TOS_URL = 'xmlconnect/mobile_application/urbanairship_terms_of_service_url' (line 168)

XML path to config with Urban Airship Terms of Service URL

Class Mage_XmlConnect_Model_Application

Inherited Variables

Inherited Methods