/app/code/core/Mage/XmlConnect/Helper/Ipad.php
PHP | 728 lines | 511 code | 42 blank | 175 comment | 44 complexity | 3aa3d7bb814bfb7b9ffc12ad2c9b48d5 MD5 | raw file
Possible License(s): CC-BY-SA-3.0, LGPL-2.1, GPL-2.0, WTFPL
- <?php
- /**
- * Magento
- *
- * NOTICE OF LICENSE
- *
- * This source file is subject to the Open Software License (OSL 3.0)
- * that is bundled with this package in the file LICENSE.txt.
- * It is also available through the world-wide-web at this URL:
- * http://opensource.org/licenses/osl-3.0.php
- * If you did not receive a copy of the license and are unable to
- * obtain it through the world-wide-web, please send an email
- * to license@magentocommerce.com so we can send you a copy immediately.
- *
- * DISCLAIMER
- *
- * Do not edit or add to this file if you wish to upgrade Magento to newer
- * versions in the future. If you wish to customize Magento for your
- * needs please refer to http://www.magentocommerce.com for more information.
- *
- * @category Mage
- * @package Mage_XmlConnect
- * @copyright Copyright (c) 2010 Magento Inc. (http://www.magentocommerce.com)
- * @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
- */
- /**
- * XmlConnect device helper for iPad
- *
- * @category Mage
- * @package Mage_XmlConnect
- * @author Magento Core Team <core@magentocommerce.com>
- */
- class Mage_XmlConnect_Helper_Ipad extends Mage_Core_Helper_Abstract
- {
- /**
- * Submission title length
- *
- * @var int
- */
- const SUBMISSION_TITLE_LENGTH = 200;
- /**
- * Submission description length
- *
- * @var int
- */
- const SUBMISSION_DESCRIPTION_LENGTH = 500;
- /**
- * Ipad landscape orientation identificator
- *
- * @var string
- */
- const ORIENTATION_LANDSCAPE = 'landscape';
- /**
- * Ipad portrait orientation identificator
- *
- * @var string
- */
- const ORIENTATION_PORTRAIT = 'portrait';
- /**
- * Ipad preview banner widht
- *
- * @var int
- */
- const PREVIEW_BANNER_WIDTH = 350;
- /**
- * Ipad preview banner image height
- *
- * @var int
- */
- const PREVIEW_BANNER_HEIGHT = 135;
- /**
- * Ipad landscape orientation preview image widht
- *
- * @var int
- */
- const PREVIEW_LANDSCAPE_BACKGROUND_WIDTH = 467;
- /**
- * Ipad landscape orientation preview image height
- *
- * @var int
- */
- const PREVIEW_LANDSCAPE_BACKGROUND_HEIGHT = 321;
- /**
- * Ipad portrait orientation preview image widht
- *
- * @var int
- */
- const PREVIEW_PORTRAIT_BACKGROUND_WIDTH = 350;
- /**
- * Ipad portrait orientation preview image height
- *
- * @var int
- */
- const PREVIEW_PORTRAIT_BACKGROUND_HEIGHT = 438;
- /**
- * Submit images that are stored in "params" field of history table
- *
- * @var array
- */
- protected $_imageIds = array('icon',
- 'ipad_loader_portrait_image',
- 'ipad_loader_landscape_image',
- 'ipad_logo',
- 'big_logo'
- );
- /**
- * Country field renderer
- *
- * @var Mage_XmlConnect_Block_Adminhtml_Mobile_Submission_Renderer_Country_Istore
- */
- protected $_countryRenderer = null;
- /**
- * Get submit images that are required for application submit
- *
- * @return array
- */
- public function getSubmitImages()
- {
- return $this->_imageIds;
- }
- /**
- * Get default application tabs
- *
- * @param string
- * @return array
- */
- public function getDefaultDesignTabs()
- {
- if (!isset($this->_tabs)) {
- $this->_tabs = array(
- array(
- 'label' => Mage::helper('xmlconnect')->__('Home'),
- 'image' => 'tab_home.png',
- 'action' => 'Home',
- ),
- array(
- 'label' => Mage::helper('xmlconnect')->__('Search'),
- 'image' => 'tab_search.png',
- 'action' => 'Search',
- ),
- array(
- 'label' => Mage::helper('xmlconnect')->__('Cart'),
- 'image' => 'tab_cart.png',
- 'action' => 'Cart',
- ),
- array(
- 'label' => Mage::helper('xmlconnect')->__('Account'),
- 'image' => 'tab_account_ipad.png',
- 'action' => 'Account',
- ),
- );
- }
- return $this->_tabs;
- }
- /**
- * Default application configuration
- *
- * @return array
- */
- public function getDefaultConfiguration()
- {
- return array(
- 'native' => array(
- 'body' => array(
- 'backgroundColor' => '#ABABAB',
- 'scrollBackgroundColor' => '#EDEDED',
- ),
- 'itemActions' => array(
- 'relatedProductBackgroundColor' => '#404040',
- ),
- 'fonts' => array(
- 'Title1' => array(
- 'name' => 'HelveticaNeue-Bold',
- 'size' => '20',
- 'color' => '#FEFEFE',
- ),
- 'Title2' => array(
- 'name' => 'HelveticaNeue-Bold',
- 'size' => '15',
- 'color' => '#222222',
- ),
- 'Title3' => array(
- 'name' => 'HelveticaNeue',
- 'size' => '14',
- 'color' => '#222222',
- ),
- 'Title4' => array(
- 'name' => 'HelveticaNeue',
- 'size' => '12',
- 'color' => '#FFFFFF',
- ),
- 'Title5' => array(
- 'name' => 'HelveticaNeue-Bold',
- 'size' => '18',
- 'color' => '#d55000',
- ),
- 'Title6' => array(
- 'name' => 'HelveticaNeue-Bold',
- 'size' => '16',
- 'color' => '#FFFFFF',
- ),
- 'Title7' => array(
- 'name' => 'HelveticaNeue-Bold',
- 'size' => '13',
- 'color' => '#222222',
- ),
- 'Title8' => array(
- 'name' => 'HelveticaNeue-Bold',
- 'size' => '13',
- 'color' => '#FFFFFF',
- ),
- 'Title9' => array(
- 'name' => 'HelveticaNeue-Bold',
- 'size' => '18',
- 'color' => '#FFFFFF',
- ),
- 'Text1' => array(
- 'name' => 'HelveticaNeue-Bold',
- 'size' => '14',
- 'color' => '#222222',
- ),
- 'Text2' => array(
- 'name' => 'HelveticaNeue',
- 'size' => '12',
- 'color' => '#222222',
- ),
- ),
- ),
- );
- }
- /**
- * List of allowed fonts for iPad application
- *
- * @return array
- */
- public function getFontList()
- {
- return array(
- array(
- 'value' => 'HiraKakuProN-W3',
- 'label' => 'HiraKakuProN-W3',
- ),
- array(
- 'value' => 'Courier',
- 'label' => 'Courier',
- ),
- array(
- 'value' => 'Courier-BoldOblique',
- 'label' => 'Courier-BoldOblique',
- ),
- array(
- 'value' => 'Courier-Oblique',
- 'label' => 'Courier-Oblique',
- ),
- array(
- 'value' => 'Courier-Bold',
- 'label' => 'Courier-Bold',
- ),
- array(
- 'value' => 'ArialMT',
- 'label' => 'ArialMT',
- ),
- array(
- 'value' => 'Arial-BoldMT',
- 'label' => 'Arial-BoldMT',
- ),
- array(
- 'value' => 'Arial-BoldItalicMT',
- 'label' => 'Arial-BoldItalicMT',
- ),
- array(
- 'value' => 'Arial-ItalicMT',
- 'label' => 'Arial-ItalicMT',
- ),
- array(
- 'value' => 'STHeitiTC-Light',
- 'label' => 'STHeitiTC-Light',
- ),
- array(
- 'value' => 'STHeitiTC-Medium',
- 'label' => 'STHeitiTC-Medium',
- ),
- array(
- 'value' => 'AppleGothic',
- 'label' => 'AppleGothic',
- ),
- array(
- 'value' => 'CourierNewPS-BoldMT',
- 'label' => 'CourierNewPS-BoldMT',
- ),
- array(
- 'value' => 'CourierNewPS-ItalicMT',
- 'label' => 'CourierNewPS-ItalicMT',
- ),
- array(
- 'value' => 'CourierNewPS-BoldItalicMT',
- 'label' => 'CourierNewPS-BoldItalicMT',
- ),
- array(
- 'value' => 'CourierNewPSMT',
- 'label' => 'CourierNewPSMT',
- ),
- array(
- 'value' => 'Zapfino',
- 'label' => 'Zapfino',
- ),
- array(
- 'value' => 'HiraKakuProN-W6',
- 'label' => 'HiraKakuProN-W6',
- ),
- array(
- 'value' => 'ArialUnicodeMS',
- 'label' => 'ArialUnicodeMS',
- ),
- array(
- 'value' => 'STHeitiSC-Medium',
- 'label' => 'STHeitiSC-Medium',
- ),
- array(
- 'value' => 'STHeitiSC-Light',
- 'label' => 'STHeitiSC-Light',
- ),
- array(
- 'value' => 'AmericanTypewriter',
- 'label' => 'AmericanTypewriter',
- ),
- array(
- 'value' => 'AmericanTypewriter-Bold',
- 'label' => 'AmericanTypewriter-Bold',
- ),
- array(
- 'value' => 'Helvetica-Oblique',
- 'label' => 'Helvetica-Oblique',
- ),
- array(
- 'value' => 'Helvetica-BoldOblique',
- 'label' => 'Helvetica-BoldOblique',
- ),
- array(
- 'value' => 'Helvetica',
- 'label' => 'Helvetica',
- ),
- array(
- 'value' => 'Helvetica-Bold',
- 'label' => 'Helvetica-Bold',
- ),
- array(
- 'value' => 'MarkerFelt-Thin',
- 'label' => 'MarkerFelt-Thin',
- ),
- array(
- 'value' => 'HelveticaNeue',
- 'label' => 'HelveticaNeue',
- ),
- array(
- 'value' => 'HelveticaNeue-Bold',
- 'label' => 'HelveticaNeue-Bold',
- ),
- array(
- 'value' => 'DBLCDTempBlack',
- 'label' => 'DBLCDTempBlack',
- ),
- array(
- 'value' => 'Verdana-Bold',
- 'label' => 'Verdana-Bold',
- ),
- array(
- 'value' => 'Verdana-BoldItalic',
- 'label' => 'Verdana-BoldItalic',
- ),
- array(
- 'value' => 'Verdana',
- 'label' => 'Verdana',
- ),
- array(
- 'value' => 'Verdana-Italic',
- 'label' => 'Verdana-Italic',
- ),
- array(
- 'value' => 'TimesNewRomanPSMT',
- 'label' => 'TimesNewRomanPSMT',
- ),
- array(
- 'value' => 'TimesNewRomanPS-BoldMT',
- 'label' => 'TimesNewRomanPS-BoldMT',
- ),
- array(
- 'value' => 'TimesNewRomanPS-BoldItalicMT',
- 'label' => 'TimesNewRomanPS-BoldItalicMT',
- ),
- array(
- 'value' => 'TimesNewRomanPS-ItalicMT',
- 'label' => 'TimesNewRomanPS-ItalicMT',
- ),
- array(
- 'value' => 'Georgia-Bold',
- 'label' => 'Georgia-Bold',
- ),
- array(
- 'value' => 'Georgia',
- 'label' => 'Georgia',
- ),
- array(
- 'value' => 'Georgia-BoldItalic',
- 'label' => 'Georgia-BoldItalic',
- ),
- array(
- 'value' => 'Georgia-Italic',
- 'label' => 'Georgia-Italic',
- ),
- array(
- 'value' => 'STHeitiJ-Medium',
- 'label' => 'STHeitiJ-Medium',
- ),
- array(
- 'value' => 'STHeitiJ-Light',
- 'label' => 'STHeitiJ-Light',
- ),
- array(
- 'value' => 'ArialRoundedMTBold',
- 'label' => 'ArialRoundedMTBold',
- ),
- array(
- 'value' => 'TrebuchetMS-Italic',
- 'label' => 'TrebuchetMS-Italic',
- ),
- array(
- 'value' => 'TrebuchetMS',
- 'label' => 'TrebuchetMS',
- ),
- array(
- 'value' => 'Trebuchet-BoldItalic',
- 'label' => 'Trebuchet-BoldItalic',
- ),
- array(
- 'value' => 'TrebuchetMS-Bold',
- 'label' => 'TrebuchetMS-Bold',
- ),
- array(
- 'value' => 'STHeitiK-Medium',
- 'label' => 'STHeitiK-Medium',
- ),
- array(
- 'value' => 'STHeitiK-Light',
- 'label' => 'STHeitiK-Light',
- ),
- );
- }
- /**
- * List of allowed font sizes for iPad application
- *
- * @return array
- */
- public function getFontSizes()
- {
- $result = array( );
- for ($i = 6; $i < 32; $i++) {
- $result[] = array(
- 'value' => $i,
- 'label' => $i . ' pt',
- );
- }
- return $result;
- }
- /**
- * Get list of countries that allowed in Itunes by Apple Store for Ipad
- * (we get info from Iphone helper)
- *
- * @return array
- */
- public function getItunesCountriesArray()
- {
- return Mage::helper('xmlconnect/iphone')->getItunesCountriesArray();
- }
- /**
- * Validate submit application data
- *
- * @param array $params
- * @return array
- */
- public function validateSubmit($params)
- {
- $errors = array();
- if (!Zend_Validate::is(isset($params['title']) ? $params['title'] : null, 'NotEmpty')) {
- $errors[] = Mage::helper('xmlconnect')->__('Please enter the Title.');
- }
- if (isset($params['title'])) {
- $titleLength = self::SUBMISSION_TITLE_LENGTH;
- $strRules = array('min' => '1', 'max' => $titleLength);
- if (!Zend_Validate::is($params['title'], 'StringLength', $strRules)) {
- $errors[] = Mage::helper('xmlconnect')->__('"Title" is more than %d characters long', $strRules['max']);
- }
- }
- if (!Zend_Validate::is(isset($params['description']) ? $params['description'] : null, 'NotEmpty')) {
- $errors[] = Mage::helper('xmlconnect')->__('Please enter the Description.');
- }
- if (isset($params['description'])) {
- $descriptionLength = self::SUBMISSION_DESCRIPTION_LENGTH;
- $strRules = array('min' => '1', 'max' => $descriptionLength);
- if (!Zend_Validate::is($params['title'], 'StringLength', $strRules)) {
- $errors[] = Mage::helper('xmlconnect')->__('"Description" is more than %d characters long', $strRules['max']);
- }
- }
- if (!Zend_Validate::is(isset($params['copyright']) ? $params['copyright'] : null, 'NotEmpty')) {
- $errors[] = Mage::helper('xmlconnect')->__('Please enter the Copyright.');
- }
- if (empty($params['price_free'])) {
- if (!Zend_Validate::is(isset($params['price']) ? $params['price'] : null, 'NotEmpty')) {
- $errors[] = Mage::helper('xmlconnect')->__('Please enter the Price.');
- }
- }
- if (!Zend_Validate::is(isset($params['country']) ? $params['country'] : null, 'NotEmpty')) {
- $errors[] = Mage::helper('xmlconnect')->__('Please select at least one country.');
- }
- $keyLenght = Mage_XmlConnect_Model_Application::APP_MAX_KEY_LENGTH;
- if (Mage::helper('xmlconnect')->getApplication()->getIsResubmitAction()) {
- if (isset($params['resubmission_activation_key'])) {
- $resubmissionKey = $params['resubmission_activation_key'];
- } else {
- $resubmissionKey = null;
- }
- if (!Zend_Validate::is($resubmissionKey, 'NotEmpty')) {
- $errors[] = Mage::helper('xmlconnect')->__('Please enter the Resubmission Key.');
- } else if (!Zend_Validate::is($resubmissionKey, 'StringLength', array(1, $keyLenght))) {
- $errors[] = Mage::helper('xmlconnect')->__('Submit App failure. Invalid activation key provided');
- }
- } else {
- $key = isset($params['key']) ? $params['key'] : null;
- if (!Zend_Validate::is($key, 'NotEmpty')) {
- $errors[] = Mage::helper('xmlconnect')->__('Please enter the Activation Key.');
- } else if (!Zend_Validate::is($key, 'StringLength', array(1, $keyLenght))) {
- $errors[] = Mage::helper('xmlconnect')->__('Submit App failure. Invalid activation key provided');
- }
- }
- return $errors;
- }
- /**
- * Check config for valid values
- *
- * @param array $native
- * @return array
- */
- public function validateConfig($native)
- {
- $errors = array();
- if ( ($native === false)
- || (!isset($native['navigationBar']) || !is_array($native['navigationBar'])
- || !isset($native['navigationBar']['icon'])
- || !Zend_Validate::is($native['navigationBar']['icon'], 'NotEmpty'))) {
- $errors[] = Mage::helper('xmlconnect')->__('Please upload an image for "Logo in Header" field from Design Tab.');
- }
- if (!Mage::helper('xmlconnect')->validateConfFieldNotEmpty('bannerIpadImage', $native)) {
- $errors[] = Mage::helper('xmlconnect')->__('Please upload an image for "Banner on Home Screen" field from Design Tab.');
- }
- if (!Mage::helper('xmlconnect')->validateConfFieldNotEmpty('backgroundIpadLandscapeImage', $native)) {
- $errors[] = Mage::helper('xmlconnect')->__('Please upload an image for "App Background (landscape mode)" field from Design Tab.');
- }
- if (!Mage::helper('xmlconnect')->validateConfFieldNotEmpty('backgroundIpadPortraitImage', $native)) {
- $errors[] = Mage::helper('xmlconnect')->__('Please upload an image for "App Background (portrait mode)" field from Design Tab.');
- }
- return $errors;
- }
- /**
- * Get renderer for submission country
- *
- * @return Mage_XmlConnect_Block_Adminhtml_Mobile_Submission_Renderer_Country_Istore
- */
- public function getCountryRenderer()
- {
- if (empty($this->_countryRenderer)) {
- $renderer = 'xmlconnect/adminhtml_mobile_submission_renderer_country_'
- . Mage_XmlConnect_Helper_Iphone::SUBMISSION_COUNTRY_RENDERER;
- $this->_countryRenderer = Mage::app()->getLayout()->createBlock($renderer);
- }
- return $this->_countryRenderer;
- }
- /**
- * Get label for submission country
- *
- * @return string
- */
- public function getCountryLabel()
- {
- return Mage::helper('xmlconnect')->__('App Stores');
- }
- /**
- * Get columns for submission country
- *
- * @return int
- */
- public function getCountryColumns()
- {
- return Mage_XmlConnect_Helper_Iphone::SUBMISSION_COUNTRY_COLUMNS;
- }
- /**
- * Get placement of Country Names for submission country
- *
- * @return bool
- */
- public function isCountryNamePlaceLeft()
- {
- return true;
- }
- /**
- * Get class name for submission country
- *
- * @return string
- */
- public function getCountryClass()
- {
- return Mage_XmlConnect_Helper_Iphone::SUBMISSION_COUNTRY_RENDERER . ' stripy';
- }
- /**
- * Check image fields
- *
- * We set empty value for image field if file was missed in some reason
- *
- * @param array $data
- * @return array
- */
- public function checkImages(array $data)
- {
- if (isset($data['conf']['native']['navigationBar']['icon']) &&
- !file_exists($data['conf']['native']['navigationBar']['icon'])
- ) {
- $data['conf']['native']['navigationBar']['icon'] = '';
- }
- if (isset($data['conf']['native']['body']['bannerIpadImage']) &&
- !file_exists($data['conf']['native']['body']['bannerIpadImage'])
- ) {
- $data['conf']['native']['body']['bannerIpadImage'] = '';
- }
- if (isset($data['conf']['native']['body']['backgroundIpadLandscapeImage']) &&
- !file_exists($data['conf']['native']['body']['backgroundIpadLandscapeImage'])
- ) {
- $data['conf']['native']['body']['backgroundIpadLandscapeImage'] = '';
- }
- if (isset($data['conf']['native']['body']['backgroundIpadPortraitImage']) &&
- !file_exists($data['conf']['native']['body']['backgroundIpadPortraitImage'])
- ) {
- $data['conf']['native']['body']['backgroundIpadPortraitImage'] = '';
- }
- return $data;
- }
- /**
- * Check required fields of a config for a front-end
- *
- * @throws Mage_Core_Exception
- * @param array $data
- * @return void
- */
- public function checkRequiredConfigFields($data)
- {
- if (!is_array($data)) {
- return;
- }
- if (isset($data['navigationBar']['icon'])
- && empty($data['navigationBar']['icon'])
- ) {
- Mage::throwException(
- Mage::helper('xmlconnect')->__('Logo in Header image missing.')
- );
- }
- if (isset($data['body']['bannerIpadImage'])
- && empty($data['body']['bannerIpadImage'])
- ) {
- Mage::throwException(
- Mage::helper('xmlconnect')->__('Banner on Home Screen image missing.')
- );
- }
- if (isset($data['body']['backgroundIpadLandscapeImage'])
- && empty($data['body']['backgroundIpadLandscapeImage'])
- ) {
- Mage::throwException(
- Mage::helper('xmlconnect')->__('App Background (landscape mode).')
- );
- }
- if (isset($data['body']['backgroundIpadPortraitImage'])
- && empty($data['body']['backgroundIpadPortraitImage'])
- ) {
- Mage::throwException(
- Mage::helper('xmlconnect')->__('App Background (portrait mode).')
- );
- }
- }
- }