sfExtjs2Plugin: sfExtjs2Helper.php

<?php

/**
 * @plugin           sfExtjs2Plugin
 * @description      sfExtjs2Plugin is a symfony plugin that provides an easy to use wrapper for the Ext javascript library
 * @author           Benjamin Runnels<benjamin.r.runnels [at] citi [dot] com>, Leon van der Ree, Wolfgang Kubens<wolfgang.kubens [at] gmx [dot] net>, Jerome Macias
 * @version          0.0.58
 * @last modified    
 *                   18.02.2008 swagner
 *                    - Fixed harmless bug (a simple empty array resulted in "['']" insted of"[]")
 *                   12.02.2008 swagner
 *                    - added two help-functions (isAssoc() and isSimpleArray())
 *                    - Fixed _quote() and added check for simple Array
 *                   04.02.2008 swagner
 *                    - Fixed handling of arrays in getExtObjectComponent
 *                   12.28.2007 Jerome
 *                    - Fixed method getExtObject
 *                    - Added constants
 *                    - Fixed method _build_datas (return empty string if array is empty)
 *                   12.27.2007 Jerome
 *                    - Added handling of null values
 *                   12.26.2007 Jerome
 *                    - Fixed method getExtObject when we want to assign a name attribute and we don't specify "attributes" key in $attributes param
 *                    - Fixed order for display private attributes in method beginApplication
 *                    - Added datas parameter for method getExtObjectComponent
 *                    - Added method _build_datas
 *                    - Replaced all call_user_func and sfExtjs2Plugin:: by self::
 *                    - Added possibility to load js or/and css addons/plugins
 *                    - Added possibility to set name for a function in method asMethod
 *                    - Replaced some ',' by self::LBR_CM
 *                    - Added method initApplication
 *                   12.20.2007 Wolfgang
 *                                      - Added method asListener
 *                                      - Renamed method customClass into asCustomClass
 *                                      - Renamed method anonymousClass into asAnonymousClass
 *                                   12.19.2007 Wolfgang
 *                    - Added method asVar
 *                    - Added logic for anonymousClass
 *                    - Changed parameters handling 
 *                   12.18.2007 Wolfgang
 *                    - Added sf_extjs2_comment
 *                   12.17.2007 Leon:
 *                    - handling of inner (recursive) arrays (see items => array(array(...), array(...))
 *                   12.17.2007 Kubens:
 *                    - Added handling of boolean values
 *                    - Fixed quoting logic for beginClass
 *                    - Fixed quoting logic for beginApplication
 *                   12.15.2007 Kubens:
 *                     - Overworked quoting logic
 *                   11.22.2007 Kubens:
 *                     - Added features to create application
 *                     - Added parameters support for Ext.object constructors
 *                    11.17.2007 Kubens:
 *                     - Added features to create custom classes and custom methods
 *                    11.12.2007  Kubens:
 *                     - Fixed loading order of adapters. If adapters are used then it is important to load
 *                       adapters and coresponding files before ext-all.js
 *                     - Overworked: load method. Adapters and themes are setuped in config.php
 *                     - Overworked: constructor. If no adapter or theme is passed then default
 *                       settings from config.php will used
 *                    11.07.2007 Benjamin:
 *                     - Fixed the adapter includes to load all required files in the correct order
 *                       moved ext-base into adapters, pass ext as adapter for standalone
 *                       changed all javascript to load first so they will come before files specified in view.yml
 *                   07.15.2007 Kubens:
 *                     - created
 */
class sfExtjs2Plugin {

  const 
    LBR      = "\n",
    LBR_CM   = ",\n",
    LBR_SM   = ";\n",
    LBR_CB_L = "{\n",
    LBR_CB_R = "\n}",
    LBR_SB_L = "[\n",
    LBR_SB_R = "\n]";
  
  private 
    $items     = array(),
    $namespace = '', // current namespace
    $options   = array('theme' => '', // current theme
                       'adapter' => ''), // current adapter
    $addons    = array('css' => array(), // current js plugins
                       'js' => array()); // current css addons
  
  static public function isAssoc($arr){
    foreach ( $arr as $key => $skip ) {
      if ( !is_integer( $key ) ) {
            return true;
      }
    }
    return false;
  }
  
  /**
   * Creates an instance of sfExtjs2Plugin.
   *
   * Usage:
   *
   *   $sfExtjs2Plugin = new sfExtjs2Plugin(
   *                           array
   *                           (
   *                             'adapter' => 'jquery', // config.sf_extjs2_adapters
   *                             'theme'   => 'gray'    // config.sf_extjs2_themes
   *                           ),
   *                           array
   *                           (
   *                             'js' => '/js/myExtjsPlugin.js',
   *                             'css' => '/css/symfony-extjs.css'
   *                           )
   *                         );
   *
   * @param array options
   */
  public function __construct($options = array(), $addons = array())
  {
    if ($options)
    {
      $this->setOptions($options);
    }
    
    if ($addons)
    {
      $this->setAddons($addons);
    }
  }
  
  /**
   * set theme and adapter
   *
   */
  private function setOptions($options)
  {
    foreach ($this->options as $optName => $v)
    {
      $this->options[$optName] = isset($options[$optName]) && array_key_exists($options[$optName], sfConfig::get('sf_extjs2_'.$optName.'s', array())) ? $options[$optName] : sfConfig::get('sf_extjs2_default_'.$optName);
    }
  }
  
  /**
   * set js and/or css addons
   *
   */  
  private function setAddons($addons)
  {
    foreach ($this->addons as $type => $v)
    {
      if (array_key_exists($type, $addons))
      {
        $this->addons[$type] = is_array($addons[$type]) ? $addons[$type] : array($addons[$type]);
      }
    }
  }

  /**
   * If method does not exists and method is listed in
   * config.sf_extjs2_classes then Extjs2.class.constructor will rendered.
   *
   * Usage:
   *
   *   $sfExtjs2Plugin = new sfExtjs2Plugin(
   *                           array
   *                           (
   *                             'adapter' => 'jquery',
   *                             'theme'   => 'gray'
   *                           ),
   *                           array
   *                           (
   *                             'js' => '/js/myExtjsPlugin.js',
   *                             'css' => '/css/symfony-extjs.css'
   *                           )
   *                         );
   *   $sfExtjs2Plugin->Window(
   *                      array
   *                      (
   *                        'title'  => 'Window Title',
   *                        'border' => false,
   *                        'width'  => 600,
   *                        'height' => 500
   *                      )
   *                    );
   *
   * @param string class
   * @param array attributes
   * @return string Javascript source of Extjs2.class
   */
  public static function __call ($class, $attributes)
  {
    $classes = sfConfig::get('sf_extjs2_classes');
    if (is_array($classes) && array_key_exists($class, $classes))
    {
      $object = sfConfig::get($classes[$class]);
      return self::getExtObject($object['class'], $attributes[0]);
    }
  }

  /**
   * Creates Javascript source for Extjs2.class
   *
   * Usage:
   * 
   *   Syntax A = short form without any options
   *   $sfExtjs2Plugin->Object(array
   *   (
   *     'id'       => 'id',
   *     'renderTo' => $sfExtjs2Plugin->asVar('document.body'),
   *     'items'    => array
   *     (
   *       $sfExtjs2Plugin->Object(array('title'=>'Object A')),
   *       $sfExtjs2Plugin->Object(array('title'=>'Object B'))
   *     )
   *   ));
   * 
   *   => new Object({id: 'id', renderTo: document.body, items: [new Object(title: 'Object A'), new Object(title: 'Object B')]})   
   *
   *
   *   Syntax B = long form with additional options
   *   $sfExtjs2Plugin->Object(array
   *   (
   *     'name'       => 'string',      // option to render Javascript variable
   *     'parameters' => array
   *      (
   *        'parameter1',
   *        'parameter2'
   *      ),
   *     'attributes' => array          // attributes for Ext constructor
   *     (
   *       'id'       => 'id',
   *       'renderTo' => 'document.body',
   *       'items'    => array
   *       (
   *         $sfExtjs2Plugin->Object(array('title' => 'Object A')),
   *         $sfExtjs2Plugin->Object(array('title' => 'Object B'))
   *       )
   *     )
   *   ));
   *   
   *   => new Object(parameter1, parameter2, {id: 'id', renderTo: document.body, items: [new Object(title: 'Object A'), new Object(title: 'Object B')]})   
   *
   * @param string class
   * @param array attributes
   * @return string source
   */
  public static function getExtObject($class, $params = array())
  {
    $name = $lbr = null;
    $attributes = $parameters = $datas = array();
    
    # syntax A is a shortform of syntax B
    # if syntax A is used then convert syntax A to syntax B
    if (is_array($params) && !array_key_exists('attributes', $params) && !array_key_exists('parameters', $params) && !array_key_exists('datas', $params))
    {
      $attributes = $params;
    }
    else
    {
      $attributes = array_key_exists('attributes', $params) ? $params['attributes'] : array();
      
      // name for var      
      if (is_array($params) && array_key_exists('name', $params))
      {
        $name = $params['name'];
        unset($params['name']);
      }
      
      // 'lbr' for a line break
      if (is_array($params) && array_key_exists('lbr', $params))
      {
        $lbr = $params['lbr'];
        unset($params['name']);
      }
      
      // parameters for constructor
      if (is_array($params) && array_key_exists('parameters', $params))
      {
        $parameters = $params['parameters'];
        unset($params['parameters']);
      }
      
      // datas for constructor
      if (is_array($params) && array_key_exists('datas', $params))
      {
        $datas = $params['datas'];
        unset($params['datas']);
      }
    }
  
    # list attributes must defined as an Javascript array
    # therefore all list attributes must be rendered as [attributeA, attributeB, attributeC]
    foreach (sfConfig::get('sf_extjs2_list_attributes') as $attribute)
    {
      if (array_key_exists($attribute, $attributes) && !$attributes[$attribute] instanceof sfExtjs2Var)
      {
        $attributes[$attribute] = sprintf
        (
          self::LBR_SB_L.'%s'.self::LBR_SB_R, 
          self::_build_attributes($attributes[$attribute])
        );
      }
    }

    // get source of component
    $source = self::getExtObjectComponent($attributes, sfConfig::get($class), $parameters, $datas);

    // if 'name' is assigned then we must render
    // either a Javascript variable or an attribute of this
    if ($name)
    {
      $source = sprintf
      (
        '%s%s = %s',
        strpos($name, 'this.') === false ? 'var ' : '',
        $name,
        $source
      );
    }
  
    // if 'lbr' assigned then we must render a line break
    if ($lbr)
    {
      $source .= $lbr;
    }
  
    return $source;
  }

  /**
   * Creates Javascript source for Extjs2.class
   *
   * @param array attributes
   * @param array config
   * @param array parameters
   * @return string source
   */
  public static function getExtObjectComponent($attributes = array(), $config = array(), $parameters = array(), $datas = array())
  {

    $isAssoc = self::isAssoc($attributes);
    $LBR_B_L = $isAssoc ? self::LBR_CB_L : self::LBR_SB_L;
    $LBR_B_R = $isAssoc ? self::LBR_CB_R : self::LBR_SB_R;
        
    $attributes = self::_build_attributes($attributes, $config['attributes']);
    $attributes = sprintf('%s', $attributes != '' ? $LBR_B_L.$attributes.$LBR_B_R : '');

    $parameters = implode(self::LBR_CM, $parameters);
    $datas = $config['class'] == 'anonymousClass' ? self::_build_datas($datas) : (!empty($datas) ? "'".implode("'".self::LBR_CM."'", $datas)."'" : '');
    
    switch ($config['class'])
    {
      case 'anonymousClass':
        $source = sprintf(
          '%s%s%s%s%s',
          $parameters,
          $parameters != '' && $datas != '' ? self::LBR_CM : '',
          $datas,
          $datas != '' && $attributes != '' ? self::LBR_CM : '',
          $attributes
        );
        return $source;

      case 'customClass':
        $source = sprintf(
          '{ %s }',
          $attributes
        );
        return $source;

      default:
        $source = sprintf(
          'new %s (%s%s%s%s%s)',
          $config['class'],
          $parameters != '' ? self::LBR_SB_L.$parameters.self::LBR_SB_R : '',
          $parameters != '' && $datas != '' ? self::LBR_CM : '',
          $datas,
          $datas != '' && $attributes != '' ? self::LBR_CM : '',
          $attributes
        );
        return $source;
    }
  
  }

  /**
   * add sources for css and js to html head
   *
   */
  public function load()
  {
    $response = sfContext::getInstance()->getResponse();

    // add javascript sources for adapter
    $adapters = sfConfig::get('sf_extjs2_adapters', array());
    
    if ($this->options['adapter']) {
        foreach ($adapters[$this->options['adapter']] as $file)
        {
            $response->addJavascript(sfConfig::get('sf_extjs2_js_dir').$file, 'first');
        }
    }

    // add javascript sources for ext all
    //$response->addJavascript(sfConfig::get('sf_extjs2_js_dir').'ext-all.js', 'first');
    
    if (array_key_exists('js', $this->addons))
    {
      foreach ($this->addons['js'] as $jsAddon)
      {
        $response->addJavascript($jsAddon, 'first');
      }
    }

    // add css sources for ext all
    //$response->addStylesheet(sfConfig::get('sf_extjs2_css_dir').'ext-all.css', 'first');

    // add css sources for theme
    $themes = sfConfig::get('sf_extjs2_themes', array());

    if ($this->options['theme']) {
        foreach ($themes[$this->options['theme']] as $file)
        {
            $response->addStylesheet(sfConfig::get('sf_extjs2_css_dir').$file, 'first');
        }
    }
    
    if (array_key_exists('css', $this->addons))
    {
      foreach ($this->addons['css'] as $cssAddon)
      {
        $response->addStylesheet($cssAddon, 'first');
      }
    }
  }

  /**
   * writes opening tag for javascript
   *
   * @return string source
   */
  public function begin()
  {
    $source  = self::LBR;
    $source .= sprintf("<script type='text/javascript'>%s", self::LBR);
    $source .= self::_comment(sprintf("%s// sfExtjs2Helper: %s%s", self::LBR, sfConfig::get('sf_extjs2_version'), self::LBR));
    $source .= sprintf("Ext.BLANK_IMAGE_URL = '%s'%s", sfConfig::get('sf_extjs2_spacer'), self::LBR_SM);
  
    echo $source;
  }

  /**
   * writes closing tag for javascript
   *   * 
   * @param  string source
   * @return Javascript source
   */
  public function end($source = '')
  {
    $source  = sprintf("%s%s%s", self::LBR, $source, $source != '' ? self::LBR : '');
    $source .= sprintf("</script>%s", self::LBR);

    echo $source;
  }

  /**
   * writes opening class tag
   *
   * @param string namespace
   * @param string classname
   * @param string extend
   * @param array attributes
   * @return string source
   */
  public function beginClass($namespace = null, $classname = null, $extend = null, $attributes = array())
  {
    $source = '';
  
    // write namespace directive
    // prevent double output of namespace directive
    if ($this->namespace !== $namespace)
    {
      $this->namespace = $namespace;
      $source .= self::_comment(sprintf("%s// namespace: %s%s", self::LBR, $namespace, self::LBR));
      $source .= sprintf("Ext.namespace('%s')%s", $namespace, self::LBR_SM);
    }
  
    // write class tag
    $source .= self::_comment(sprintf("%s// class: %s.%s%s", self::LBR, $namespace, $classname, self::LBR));
    $source .= sprintf("%s.%s = Ext.extend(%s, { %s", $namespace, $classname, $extend, self::LBR);
  
    // write attributes
    $source .= self::_build_attributes($attributes);
  
    echo $source;
  }

  /**
   * writes closing class tag
   *
   * @return Javascript source
   */
  public function endClass()
  {
    $source  = '';
    $source .= sprintf("})%s%s", self::LBR_SM, self::LBR_SM);

    echo $source;
  }

  /**
   * writes begining application tag
   *
   * @param attributes['name']
   * @param attributes['private']
   * @param attributes['public']
   * @return string source
   */
   public function beginApplication($attributes = array())
   {
     // private attributes
     $sourcePrivate = '';
     if (array_key_exists('private', $attributes))
     {
       foreach ($attributes['private'] as $key => $value)
       {
         $sourcePrivate .= sprintf("%svar %s = %s;", self::LBR, $key, self::_quote($key, $value));
       }
     }

     // public attributes
     $sourcePublic = '';
     if (array_key_exists('public', $attributes))
     {
       // write attributes
       $sourcePublic .= self::_build_attributes($attributes['public']);
     }

     // write application syntax
     $source  = '';
     $source .= self::_comment(sprintf("%s// application: %s%s", self::LBR, $attributes['name'], self::LBR));
     $source .= sprintf(
       'var %s = function () { %s%sreturn {%s %s %s',
       $attributes['name'],
       $sourcePrivate,
       $sourcePrivate != '' ? self::LBR : '',
       self::LBR,
       $sourcePublic,
       $sourcePublic != '' ? self::LBR : ''
     );

     echo $source;
   }

  /**
   * writes closing application tag
   *
   * @return source
   */
  public function endApplication()
  {
    $source  = '';
    $source .= sprintf("%s}}()%s", self::LBR, self::LBR_SM);