mirror/php-e107
1
0
Fork 0
mirror of https://github.com/e107inc/e107.git synced 2025-08-22 14:13:03 +02:00
Code Issues Releases Wiki Activity

JS Manager handler - almost ready, awaiting for theme.xml & plugin.xml required additions, admin header.php synchronized with the changes, e107::getJs() proxy method added, new js related preferences - Work in progress

Browse Source
This commit is contained in:
secretr
2009-09-29 17:40:56 +00:00
parent e9fd4e9127
commit 88d969fab3
6 changed files with 453 additions and 124 deletions
Download Patch File Download Diff File Expand all files Collapse all files

433
e107_handlers/js_manager.php
View File

@@ -7,14 +7,14 @@
* GNU General Public License (http://gnu.org).
*
* $Source: /cvs_backup/e107_0.8/e107_handlers/js_manager.php,v $
* $Revision: 1.1 $
* $Date: 2009-09-28 19:17:59 $
* $Revision: 1.2 $
* $Date: 2009-09-29 17:40:55 $
* $Author: secretr $
*
*/
global $pref, $eplug_admin, $THEME_JSLIB, $THEME_CORE_JSLIB;
class e_js_manager
class e_jsmanager
{
/**
* Core JS library files, loaded via e_jslib.php
@@ -30,6 +30,13 @@ class e_js_manager
*/
protected $_e_jslib_plugin = array();
/**
* Theme JS library files, loaded via e_jslib.php
*
* @var array
*/
protected $_e_jslib_theme = array();
/**
* JS files array - loaded in page header
*
@@ -72,12 +79,19 @@ class e_js_manager
* @var boolean
*/
protected $_in_admin = false;
/**
* Browser cache id
*
* @var integer
*/
protected $_cache_id = 0;
/**
* Singleton instance
* Allow class extends - override {@link getInstance()}
*
* @var e_js_manager
* @var e_jsmanager
*/
protected static $_instance = null;
@@ -104,54 +118,152 @@ class e_js_manager
/**
* Get singleton instance
*
* @return e_js_manager
* @return e_jsmanager
*/
public static function getInstance()
{
if(null == self::$_instance)
if(null === self::$_instance)
{
self::$_instance = new self();
self::$_instance->_init();
}
return self::$_instance;
}
/**
* Get and parse core preference values
* Get and parse core preference values (if available)
*
* @return void
*/
protected function _init()
{
$core_list = e107::getPref('e_jslib_core');
if(!$core_list)
// Try to auto-detect runtime location
$this->setInAdmin(defset('e_ADMIN_AREA', false));
// Try to load browser cache id from core preferences
$this->setCacheId(e107::getPref('e_jslib_browser_cache', 0));
// Load stored in preferences core lib paths ASAP
$core_libs = e107::getPref('e_jslib_core');
if(!$core_libs)
{
$core_list = array();
$core_libs = array();
}
$this->coreLib($core_libs);
// Load stored in preferences plugin lib paths ASAP
$plug_libs = e107::getPref('e_jslib_plugin');
if(!$plug_libs)
{
$plug_libs = array();
}
foreach ($plug_libs as $plugname => $lib_paths)
{
$this->pluginLib($plugname, $lib_paths);
}
// Load stored in preferences theme lib paths ASAP
// TODO - decide if THEME should directly use themeLib() or
// we store paths in 'e_jslib_theme' on theme installation only (theme.xml)!
$theme_libs = e107::getPref('e_jslib_theme');
if(!$theme_libs)
{
$theme_libs = array();
}
$this->themeLib($lib_paths);
}
/**
* Add Core JS library file(s) for inclusion from e_jslib routine
*
* @param string|array $file_path relative to e107_files/jslib/ folder or array in format path - runtime location
* @param string $runtime_location where should be JS used
* @return e_js_manager
* @param string|array $file_path relative to e107_files/jslib/ folder or array in format 'path - runtime location'
* @param string $runtime_location admin|front|all - where should be JS used
* @return e_jsmanager
*/
public function coreLib($file_path, $runtime_location = 'front')
protected function coreLib($file_path, $runtime_location = 'front')
{
$this->addJs('core', $file_path, $runtime_location);
return $this;
}
/**
* Add Core JS library file(s) for inclusion from e_jslib routine
* Add Plugin JS library file(s) for inclusion from e_jslib routine
*
* @param string $plugname
* @param string|array $file_path relative to e107_plugins/myplug/jslib/ folder or array in format path - runtime location
* @param string|array $file_path relative to e107_plugins/myplug/ folder or array in format 'path - runtime location'
* @param string $runtime_location admin|front|all - where should be JS used
* @return e_js_manager
* @return e_jsmanager
*/
public function pluginLib($plugname, $file_path, $runtime_location = 'front')
protected function pluginLib($plugname, $file_path, $runtime_location = 'front')
{
$this->addJs('plugin', array($plugname, $file_path), $runtime_location);
if(is_array($file_path))
{
foreach ($file_path as $fpath => $rlocation)
{
$this->addJs('plugin', $plugname.':'.$fpath, $rlocation);
}
return $this;
}
$this->addJs('plugin', $plugname.':'.$file_path, $runtime_location);
return $this;
}
/**
* Add Theme JS library file(s) for inclusion from e_jslib routine
*
* @param string|array $file_path relative to e107_themes/current_theme/ folder or array in format 'path - runtime location'
* @param string $runtime_location admin|front|all - where should be JS used
* @return e_jsmanager
*/
protected function themeLib($file_path, $runtime_location = 'front')
{
$this->addJs('theme', $file_path, $runtime_location);
return $this;
}
/**
* Add Core JS library file(s) for inclusion in site header or site footer (in this order) if not
* already loaded by e_jslib routine. This should avoid dependency problems.
* Extremely useful for shortcodes and menus.
*
* @param string $file_path relative to e107_files/jslib/ folder
* @param integer $zone 1-5 (see header.php)
* @return e_jsmanager
*/
public function requireCoreLib($file_path, $zone = 2)
{
if(is_array($file_path))
{
foreach ($file_path as $fpath => $z)
{
$this->tryHeaderFile('{e_FILE}jslib/'.trim($fpath, '/'), $z);
}
return $this;
}
$this->tryHeaderFile('{e_FILE}jslib/'.trim($file_path, '/'), $zone);
return $this;
}
/**
* Add Plugin JS library file(s) for inclusion in site header if not
* already loaded by e_jslib routine. This should avoid dependency problems.
*
* @param string $plugname
* @param string $file_path relative to e107_plugins/myplug/ folder
* @param integer $zone 1-5 (see header.php)
* @return e_jsmanager
*/
public function requirePluginLib($plugname, $file_path, $zone = 5)
{
if(is_array($file_path))
{
foreach ($file_path as $fpath => $z)
{
$this->tryHeaderFile('{e_PLUGIN}'.$plugname.'/'.trim($fpath, '/'), $z);
}
return $this;
}
$this->tryHeaderFile('{e_PLUGIN}'.$plugname.'/'.trim($file_path, '/'), $zone);
return $this;
}
@@ -160,7 +272,7 @@ class e_js_manager
*
* @param string|array $file_path path shortcodes usage is prefered
* @param integer $zone 1-5 (see header.php)
* @return e_js_manager
* @return e_jsmanager
*/
public function headerFile($file_path, $zone = 5)
{
@@ -168,25 +280,45 @@ class e_js_manager
return $this;
}
/**
* Add JS file(s) for inclusion in site header if possible, else
* use {@link footerFile()}
*
* @param string|array $file_path path shortcodes usage is prefered
* @param integer $zone 1-5 (see header.php and footer.php)
* @return e_jsmanager
*/
public function tryHeaderFile($file_path, $zone = 5)
{
if(!defined('HEADER_INIT'))
{
$this->headerFile($file_path, $zone);
return $this;
}
$this->footerFile($file_path, $zone);
return $this;
}
/**
* Add JS file(s) for inclusion in site footer
*
* @param string|array $file_path path shortcodes usage is prefered
* @return e_js_manager
* @param integer $priority 1-5 (see footer.php)
* @return e_jsmanager
*/
public function footerFile($file_path)
public function footerFile($file_path, $priority = 5)
{
$this->addJs('footer', $file_path);
$this->addJs('footer', $file_path, $priority);
return $this;
}
/**
* Add JS file(s) for inclusion in site header
*
* @param string|array $js_content path shortcodes usage is prefered
* @param string|array $js_content
* @param integer $zone 1-5 (see header.php)
* @return e_js_manager
* @return e_jsmanager
*/
public function headerInline($js_content, $zone = 5)
{
@@ -194,37 +326,65 @@ class e_js_manager
return $this;
}
/**
* Add JS file(s) for inclusion in site header if possible, else
* use {@link footerFile()}
*
* @param string $js_content
* @param integer $zone 1-5 (see header.php and footer.php)
* @return e_jsmanager
*/
public function tryHeaderInline($js_content, $zone = 5)
{
if(!defined('HEADER_INIT'))
{
$this->headerInline($js_content, $zone);
return $this;
}
$this->footerInline($js_content, $zone);
return $this;
}
/**
* Add JS file(s) for inclusion in site footer
*
* @param string|array $js_content path shortcodes usage is prefered
* @return e_js_manager
* @param integer $priority 1-5 (see footer.php)
* @return e_jsmanager
*/
public function footerInline($js_content)
public function footerInline($js_content, $priority = 5)
{
$this->addJs('footer_inline', $js_content);
$this->addJs('footer_inline', $js_content, $priority);
return $this;
}
/**
* Require JS file(s). Access could be changed to private soon so don't use this
* directly. Use corresponding proxy methods instead
* Require JS file(s). Used by corresponding public proxy methods.
*
* @see requirePluginLib()
* @see requireCoreLib()
* @see themeLib()
* @see pluginLib()
* @see coreLib()
* @see headerFile()
* @see footerFile()
* @see headerInline()
* @see footerInline()
* @param string $type core|plugin - jslib.php, header|footer|header_inline|footer_inline - runtime
* @param string|array $file_path
* @param string|integer $runtime_location admin|front|all (jslib), 0-5 (runtime inclusion)
* @return
*/
public function addJs($type, $file_path, $runtime_location = '')
protected function addJs($type, $file_path, $runtime_location = '')
{
if(empty($file_path))
{
return $this;
}
if(is_array($file_path))
{
foreach ($file_path as $fp => $loc)
{
$this->requireLib($type, $fp, $loc);
$this->addJs($type, $fp, $loc);
}
return $this;
}
@@ -239,10 +399,16 @@ class e_js_manager
break;
case 'plugin':
$file_path = '{e_PLUGIN}jslib/'.$file_path[0].'/'.trim($file_path[1], '/');
$file_path = explode(':', $file_path);
$file_path = '{e_PLUGIN}'.$file_path[0].'/'.trim($file_path[1], '/');
$registry = &$this->_e_jslib_plugin;
break;
case 'theme':
$file_path = '{e_THEME}'.$this->getCurrentTheme().'/'.trim($file_path, '/');
$registry = &$this->_e_jslib_theme;
break;
case 'header':
$file_path = $tp->createConstants($file_path, 4);
$zone = intval($runtime_location);
@@ -259,30 +425,41 @@ class e_js_manager
break;
case 'footer':
$file_path = $tp->createConstants($file_path, 4);
$registry = &$this->_runtime_footer_src;
$runtime = true;
break;
case 'header_inline':
$file_path = $tp->createConstants($file_path, 4);
$zone = intval($runtime_location);
if($zone > 5 || $zone < 1)
{
$zone = 5;
}
if(!isset($this->_runtime_header_src[$zone]))
if(!isset($this->_runtime_footer[$zone]))
{
$this->_runtime_header_src[$zone] = array();
$this->_runtime_footer[$zone] = array();
}
$registry = &$this->_runtime_header_src[$zone];
$registry = &$this->_runtime_footer[$zone];
$runtime = true;
break;
case 'header_inline':
$zone = intval($runtime_location);
if($zone > 5 || $zone < 1)
{
$zone = 5;
}
//$this->_js_all[] = $file_path;
$this->_runtime_header_src[$zone][] = $file_path;
return $this;
break;
break;
case 'footer_inline':
$file_path = $tp->createConstants($file_path, 4);
$registry = &$this->_runtime_footer;
$runtime = true;
$zone = intval($runtime_location);
if($zone > 5 || $zone < 1)
{
$zone = 5;
}
//$this->_js_all[] = $file_path;
$this->_runtime_footer_src[$zone][] = $file_path;
return $this;
break;
default:
@@ -294,6 +471,7 @@ class e_js_manager
{
return $this;
}
$this->_js_all[] = $file_path;
$registry[] = $file_path;
@@ -303,44 +481,90 @@ class e_js_manager
/**
* Render registered JS
*
* @param string $what core|plugin|header|footer|header_inline|footer_inline
* @param integer $zone 1-5 - only needed when in 'header' and 'header_inline' render mode
* @return
* @param string $mod core|plugin|theme|header|footer|header_inline|footer_inline
* @param integer $zone 1-5 - only used when in 'header','footer','header_inline' and 'footer_inline' render mod
* @param boolean $external exrernal file calls, only used when NOT in 'header_inline' and 'footer_inline' render mod
* @param boolean $return
* @return string JS content - only if $return is true
*/
public function renderJs($what, $zone = 5)
public function renderJs($mod, $zone, $external = true, $return = false)
{
switch($what)
if($return)
{
ob_start();
}
switch($mod)
{
case 'core':
$this->renderFile($this->_e_jslib_core);
$this->renderFile($this->_e_jslib_core, $external, 'Core libraries');
$this->_e_jslib_core = array();
break;
case 'plugin':
$this->renderFile($this->_e_jslib_plugin);
foreach($this->_e_jslib_plugin as $plugname => $paths)
{
$this->renderFile($paths, $external, $plugname.' libraries');
}
$this->_e_jslib_plugin = array();
break;
case 'theme':
$this->renderFile($this->_e_jslib_theme, $external, 'Theme libraries');
$this->_e_jslib_theme = array();
break;
case 'header':
$this->renderFile(varsettrue($this->_runtime_header[$zone], array()));
$this->renderFile(varsettrue($this->_runtime_header[$zone], array()), $external, 'Header JS include - zone #'.$zone);
unset($this->_runtime_header[$zone]);
break;
case 'footer':
$this->renderInline($this->_runtime_footer);
$this->_runtime_footer = array();
if(true === $zone)
{
ksort($this->_runtime_footer, SORT_NUMERIC);
foreach ($this->_runtime_footer as $priority => $path_array)
{
$this->renderFile($path_array, $external, 'Footer JS include - priority #'.$priority);
}
$this->_runtime_footer = array();
}
else
{
$this->renderFile(varsettrue($this->_runtime_footer[$zone], array()), $external, 'Footer JS include - priority #'.$zone);
unset($this->_runtime_footer[$zone]);
}
break;
case 'header_inline':
$this->renderInline(varsettrue($this->_runtime_header_src[$zone], array()));
$this->renderInline(varsettrue($this->_runtime_header_src[$zone], array()), 'Header JS - zone #'.$zone);
unset($this->_runtime_header_src[$zone]);
break;
case 'footer_inline':
$this->renderInline($this->_runtime_footer_src);
$this->_runtime_footer_src = array();
if(true === $zone)
{
ksort($this->_runtime_footer_src, SORT_NUMERIC);
foreach ($this->_runtime_footer_src as $priority => $src_array)
{
$this->renderInline($src_array, 'Footer JS - priority #'.$priority);
}
$this->_runtime_footer_src = array();
}
else
{
$this->renderInline(varsettrue($this->_runtime_footer_src[$zone], array()), 'Footer JS - priority #'.$zone);
unset($this->_runtime_footer_src[$zone]);
}
break;
}
if($return)
{
$ret = ob_get_contents();
ob_end_clean();
return $ret;
}
}
/**
@@ -348,47 +572,73 @@ class e_js_manager
* TODO - option to output <script src='$path'>
*
* @param array $file_path_array
* @return
* @param boolean $external if true - external file calls, else get file contents
* @param string $label added as comment if non-empty
* @return void
*/
public function renderFile($file_path_array)
public function renderFile($file_path_array, $external = false, $label = '')
{
if(empty($file_path_array))
{
return '';
}
$tp = e107::getParser();
echo "\n\n";
echo "\n";
if($external && $label) //TODO - print comments only if site debug is on
{
echo "<!-- [JSManager] ".$label." -->\n";
}
foreach ($file_path_array as $path)
{
if (substr($path, - 4) == '.php')
{
include_once($tp->replaceConstants($text, ''));
echo "\n\n";
if($external)
{
echo '<script type="text/javascript" src="'.$tp->replaceConstants($path, 'abs').'?external=1&amp;cacheid='.$this->getCacheId().'"></script>';
echo "\n";
continue;
}
include_once($tp->replaceConstants($path, ''));
echo "\n";
}
else
{
echo file_get_contents($tp->replaceConstants($text, ''));
echo "\n\n";
if($external)
{
echo '<script type="text/javascript" src="'.$tp->replaceConstants($path, 'abs').'?'.$this->getCacheId().'"></script>';
echo "\n";
continue;
}
echo file_get_contents($tp->replaceConstants($path, ''));
echo "\n";
}
}
}
/**
* Render JS source array
* @param object $js_content_array
* @return
*
* @param array $js_content_array
* @param string $label added as comment if non-empty
* @return void
*/
public function renderInline($js_content_array)
public function renderInline($js_content_array, $label = '')
{
if(empty($js_content_array))
{
return '';
}
echo "\n\n";
echo '<script type="text/javascript">';
foreach ($file_path_array as $js_content)
echo "\n";
if($label) //TODO - print comments only if site debug is on
{
echo $js_content;
echo "\n\n";
echo "<!-- [JSManager] ".$label." -->\n";
}
echo '<script type="text/javascript">';
echo "\n//<![CDATA[\n";
echo implode("\n\n", $js_content_array);
echo "\n//]]>\n";
echo '</script>';
echo "\n\n";
echo "\n";
}
/**
@@ -406,7 +656,7 @@ class e_js_manager
* Set current script location
*
* @param object $is true - back-end, false - front-end
* @return e_js_manager
* @return e_jsmanager
*/
public function setInAdmin($is)
{
@@ -424,5 +674,34 @@ class e_js_manager
return ($this->isInAdmin() ? 'admin' : 'front');
}
/**
* Get current theme name
*
* @return string
*/
public function getCurrentTheme()
{
return ($this->isInAdmin() ? e107::getPref('admintheme') : e107::getPref('sitetheme'));
}
/**
* Get browser cache id
*
* @return integer
*/
public function getCacheId()
{
return $this->_cache_id;
}
/**
* Set browser cache id
*
* @return e_jsmanager
*/
public function setCacheId($cacheid)
{
$this->_cache_id = $cacheid;
return $this;
}
}