[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Phpgroupware-cvs] [18553] rename js class to make phpgw::__[get|set]()
|
From: |
Dave Hall |
|
Subject: |
[Phpgroupware-cvs] [18553] rename js class to make phpgw::__[get|set]() work more efficiently |
|
Date: |
Sun, 01 Jun 2008 00:58:37 +0000 |
Revision: 18553
http://svn.sv.gnu.org/viewvc/?view=rev&root=phpgroupware&revision=18553
Author: skwashd
Date: 2008-06-01 00:58:36 +0000 (Sun, 01 Jun 2008)
Log Message:
-----------
rename js class to make phpgw::__[get|set]() work more efficiently
Added Paths:
-----------
trunk/phpgwapi/inc/class.js.inc.php
Removed Paths:
-------------
trunk/phpgwapi/inc/class.javascript.inc.php
Deleted: trunk/phpgwapi/inc/class.javascript.inc.php
===================================================================
--- trunk/phpgwapi/inc/class.javascript.inc.php 2008-06-01 00:57:20 UTC (rev
18552)
+++ trunk/phpgwapi/inc/class.javascript.inc.php 2008-06-01 00:58:36 UTC (rev
18553)
@@ -1,242 +0,0 @@
-<?php
- /**
- * Javascript support class
- * @author Dave Hall <address@hidden>
- * @copyright Portions Copyright (C) 2003,2004 Free Software Foundation,
Inc http://www.fsf.org/
- * @license http://www.fsf.org/licenses/gpl.html GNU General Public
License
- * @package phpgwapi
- * @subpackage gui
- * @version $Id$
- * @link http://docs.phpgroupware.org/wiki/classJavaScript
- */
-
- /**
- * phpGroupWare javascript support class
- *
- * Only instanstiate this class using:
- * <code>
- * if(address@hidden($GLOBALS['phpgw']->js))
- * {
- * $GLOBALS['phpgw']->js = createObject('phpgwapi.javascript');
- * }
- * </code>
- *
- * This way a theme can see if this is a defined object and include the
data,
- * while the is_object() wrapper prevents whiping out existing data held
in
- * this instance variables, primarily the $files variable.
- *
- * Note: The package arguement is the subdirectory of js - all js should
live in subdirectories
- *
- * @package phpgwapi
- * @subpackage gui
- * @uses template
- */
- class javascript
- {
- /**
- * @var array elements to be used for the window.on* events
- */
- var $win_events = array
- (
- 'load' => array(),
- 'unload' => array()
- );
-
- /**
- * @var array list of validated files to be included in the head
section of a page
- */
- var $files = array();
-
- /**
- * @var object used for holding an instance of the Template class
- */
- var $t;
-
- /**
- * Constructor
- *
- * Initialize the instance variables
- */
- function javascript()
- {
- $this->validate_file('core', 'base');
- }
-
- /**
- * Set a window.on?? event
- *
- * @param string $event the name of the event
- * @param string $code the code to be called
- */
- function add_event($event, $code)
- {
- if ( !isset($this->win_events[$event]) )
- {
- $this->win_events[$event] = array();
- }
- $this->win_events[$event][] = $code;
- }
-
- /**
- * Returns the javascript required for displaying a popup
message box
- *
- * @param string $msg the message to be displayed to user
- * @returns string the javascript to be used for displaying the
message
- */
- function get_alert($msg)
- {
- return 'return alert("'.lang($msg).'");';
- }
-
- /**
- * Returns the javascript required for displaying a confirmation
message box
- *
- * @param string $msg the message to be displayed to user
- * @returns string the javascript to be used for displaying the
message
- */
- function get_confirm($msg)
- {
- return 'return confirm("'.lang($msg).'");';
- }
-
- /**
- * Used for generating the list of external js files to be
included in the head of a page
- *
- * NOTE: This method should only be called by the template class.
- * The validation is done when the file is added so we don't
have to worry now
- *
- * @returns string the html needed for importing the js into a
page
- */
- function get_script_links()
- {
- $links = '';
- if( is_array($this->files) && count($this->files) )
- {
- $links = "<!--JS Imports from phpGW javascript
class -->\n";
- foreach($this->files as $app => $packages)
- {
- if( is_array($packages) &&
count($packages) )
- {
- foreach($packages as $pkg =>
$files)
- {
- if( is_array($files) &&
count($files) )
- {
- foreach($files
as $file => $ignored)
- {
- //echo
"file:
{$GLOBALS['phpgw_info']['server']['webserver_url']}/{$app}/js/{$pkg}/{$file}.js
<br>";
- $links
.= '<script type="text/javascript" '
- .
"src=\"{$GLOBALS['phpgw_info']['server']['webserver_url']}/{$app}/js/{$pkg}/{$file}.js\">"
- .
"</script>\n";
- }
- }
- }
- }
- }
- }
- return $links;
- }
-
- /**
- * @deprecated
- */
- function get_body_attribs()
- {
- return '';
- }
-
-
- /**
- * Creates the javascript for handling window.on* events
- *
- * @returns string the attributes to be used
- */
- function get_win_on_events()
- {
- $ret_str = "\n// start phpGW javascript class imported
window.on* event handlers\n";
- foreach ( $this->win_events as $win_event => $actions )
- {
- if ( is_array($actions) && count($actions) )
- {
- $ret_str .= "window.on{$win_event} =
function()\n{\n";
- foreach ( $actions as $action )
- {
- $ret_str .= "\t$action\n";
- }
- $ret_str .= "}\n";
- }
- }
- $ret_str .= "\n// end phpGW javascript class imported
window.on* event handlers\n\n";
- return $ret_str;
- }
-
- /**
- * Sets an onLoad action for a page
- *
- * @deprecated
- * @param string javascript to be used
- */
- function set_onload($code)
- {
- $this->win_events['load'][] = $code;
- }
-
- /**
- * Sets an onUnload action for a page
- *
- * @deprecated
- * @param string javascript to be used
- */
- function set_onunload($code)
- {
- $this->events['unload'][] = $code;
- }
-
- /**
- * DO NOT USE - NOT SURE IF I AM GOING TO USE IT - ALSO IT NEEDS
SOME CHANGES!!!!
- * Used for removing a file or package of files to be included
in the head section of a page
- *
- * @param string $app application to use
- * @param string $package the name of the package to be removed
- * @param string $file the name of a file in the package to be
removed - if ommitted package is removed
- */
- function unset_script_link($app, $package, $file=False)
- {
- /* THIS DOES NOTHING ATM :P
- if($file !== False)
- {
- unset($this->files[$app][$package][$file]);
- }
- else
- {
- unset($this->files[$app][$package]);
- }
- */
- }
-
- /**
- * Checks to make sure a valid package and file name is provided
- *
- * @param string $package package to be included
- * @param string $file file to be included - no ".js" on the end
- * @param string $app application directory to search - default
= phpgwapi
- * @returns bool was the file found?
- */
- function validate_file($package, $file, $app='phpgwapi')
- {
- if(is_readable(PHPGW_INCLUDE_ROOT .
"/$app/js/$package/$file.js"))
- {
- $this->files[$app][$package][$file] = True;
- return True;
- }
- elseif($app != 'phpgwapi')
- {
- if(is_readable(PHPGW_INCLUDE_ROOT .
"/phpgwapi/js/$package/$file.js"))
- {
-
$this->files['phpgwapi'][$package][$file] = True;
- return True;
- }
- return False;
- }
- }
- }
-?>
Copied: trunk/phpgwapi/inc/class.js.inc.php (from rev 18497,
trunk/phpgwapi/inc/class.javascript.inc.php)
===================================================================
--- trunk/phpgwapi/inc/class.js.inc.php (rev 0)
+++ trunk/phpgwapi/inc/class.js.inc.php 2008-06-01 00:58:36 UTC (rev 18553)
@@ -0,0 +1,241 @@
+<?php
+ /**
+ * Javascript support class
+ *
+ * @author Dave Hall <address@hidden>
+ * @copyright Copyright (C) 2003-2008 Free Software Foundation, Inc
http://www.fsf.org/
+ * @license http://www.fsf.org/licenses/gpl.html GNU General Public
License
+ * @package phpgroupware
+ * @subpackage phpgwapi
+ * @version $Id$
+ */
+
+ /*
+ This program is free software: you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+ /**
+ * phpGroupWare javascript support class
+ *
+ * Don't instanstiate this class
+ *
+ * Simply use a reference to
+ * $GLOBALS['phpgw']->js
+ *
+ * Lke so
+ *
+ * $js =& $GLOBALS['phpgw']->js;
+ *
+ * This way a theme can see if this is a defined object and include the
data,
+ * while the is_object() wrapper prevents whiping out existing data held
in
+ * this instance variables, primarily the $files variable.
+ *
+ * Note: The package arguement is the subdirectory of js - all js should
live in subdirectories
+ *
+ * @package phpgroupware
+ * @subpackage phpgwapi
+ * @category gui
+ */
+ class phpgwapi_js
+ {
+ /**
+ * @var array elements to be used for the window.on* events
+ */
+ protected $win_events = array
+ (
+ 'load' => array(),
+ 'unload' => array()
+ );
+
+ /**
+ * @var array list of validated files to be included in the head
section of a page
+ */
+ protected $files = array();
+
+ /**
+ * Constructor
+ */
+ public function __construct()
+ {
+ $this->validate_file('core', 'base');
+ }
+
+ /**
+ * Set a window.on?? event
+ *
+ * @param string $event the name of the event
+ * @param string $code the code to be called
+ */
+ public function add_event($event, $code)
+ {
+ if ( !isset($this->win_events[$event]) )
+ {
+ $this->win_events[$event] = array();
+ }
+ $this->win_events[$event][] = $code;
+ }
+
+ /**
+ * Returns the javascript required for displaying a popup
message box
+ *
+ * @param string $msg the message to be displayed to user
+ * @returns string the javascript to be used for displaying the
message
+ */
+ public function get_alert($msg)
+ {
+ return 'return alert("'.lang($msg).'");';
+ }
+
+ /**
+ * Returns the javascript required for displaying a confirmation
message box
+ *
+ * @param string $msg the message to be displayed to user
+ * @returns string the javascript to be used for displaying the
message
+ */
+ public function get_confirm($msg)
+ {
+ return 'return confirm("'.lang($msg).'");';
+ }
+
+ /**
+ * Used for generating the list of external js files to be
included in the head of a page
+ *
+ * NOTE: This method should only be called by the template class.
+ * The validation is done when the file is added so we don't
have to worry now
+ *
+ * @returns string the html needed for importing the js into a
page
+ */
+ public function get_script_links()
+ {
+ $links = '';
+ if( is_array($this->files) && count($this->files) )
+ {
+ $links = "<!--JS Imports from phpGW javascript
class -->\n";
+ foreach($this->files as $app => $packages)
+ {
+ if( is_array($packages) &&
count($packages) )
+ {
+ foreach($packages as $pkg =>
$files)
+ {
+ if( is_array($files) &&
count($files) )
+ {
+ foreach($files
as $file => $ignored)
+ {
+ //echo
"file:
{$GLOBALS['phpgw_info']['server']['webserver_url']}/{$app}/js/{$pkg}/{$file}.js
<br>";
+ $links
.= '<script type="text/javascript" '
+ .
"src=\"{$GLOBALS['phpgw_info']['server']['webserver_url']}/{$app}/js/{$pkg}/{$file}.js\">"
+ .
"</script>\n";
+ }
+ }
+ }
+ }
+ }
+ }
+ return $links;
+ }
+
+ /**
+ * @deprecated
+ */
+ public function get_body_attribs()
+ {
+ return '';
+ }
+
+
+ /**
+ * Creates the javascript for handling window.on* events
+ *
+ * @returns string the attributes to be used
+ */
+ public function get_win_on_events()
+ {
+ $ret_str = "\n// start phpGW javascript class imported
window.on* event handlers\n";
+ foreach ( $this->win_events as $win_event => $actions )
+ {
+ if ( is_array($actions) && count($actions) )
+ {
+ $ret_str .= "window.on{$win_event} =
function()\n{\n";
+ foreach ( $actions as $action )
+ {
+ $ret_str .= "\t$action\n";
+ }
+ $ret_str .= "}\n";
+ }
+ }
+ $ret_str .= "\n// end phpGW javascript class imported
window.on* event handlers\n\n";
+ return $ret_str;
+ }
+
+ /**
+ * Sets an onLoad action for a page
+ *
+ * @deprecated
+ * @param string javascript to be used
+ */
+ public function set_onload($code)
+ {
+ $this->win_events['load'][] = $code;
+ }
+
+ /**
+ * Sets an onUnload action for a page
+ *
+ * @deprecated
+ * @param string javascript to be used
+ */
+ public function set_onunload($code)
+ {
+ $this->events['unload'][] = $code;
+ }
+
+ /**
+ * DO NOT USE - NOT SURE IF I AM GOING TO USE IT - ALSO IT NEEDS
SOME CHANGES!!!!
+ * Used for removing a file or package of files to be included
in the head section of a page
+ *
+ * @param string $app application to use
+ * @param string $package the name of the package to be removed
+ * @param string $file the name of a file in the package to be
removed - if ommitted package is removed
+ */
+ public function unset_script_link($app, $package, $file=False)
+ {
+ // THIS DOES NOTHING ATM :P
+ }
+
+ /**
+ * Checks to make sure a valid package and file name is provided
+ *
+ * @param string $package package to be included
+ * @param string $file file to be included - no ".js" on the end
+ * @param string $app application directory to search - default
= phpgwapi
+ * @returns bool was the file found?
+ */
+ public function validate_file($package, $file, $app='phpgwapi')
+ {
+ if(is_readable(PHPGW_INCLUDE_ROOT .
"/$app/js/$package/$file.js"))
+ {
+ $this->files[$app][$package][$file] = True;
+ return True;
+ }
+ elseif($app != 'phpgwapi')
+ {
+ if(is_readable(PHPGW_INCLUDE_ROOT .
"/phpgwapi/js/$package/$file.js"))
+ {
+
$this->files['phpgwapi'][$package][$file] = True;
+ return True;
+ }
+ return False;
+ }
+ }
+ }
| [Prev in Thread] |
Current Thread |
[Next in Thread] |
- [Phpgroupware-cvs] [18553] rename js class to make phpgw::__[get|set]() work more efficiently,
Dave Hall <=