summaryrefslogtreecommitdiffstats
path: root/lib/class/ajax.class.php
blob: 8843cc4d3567b140c30dd044939fbe39d2105d75 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
<?php
/*

 Copyright (c) 2001 - 2007 Ampache.org
 All rights reserved.

 This program is free software; you can redistribute it and/or
 modify it under the terms of the GNU General Public License v2
 as published by the Free Software Foundation.

 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, write to the Free Software
 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.

*/

/**
 * Ajax class
 * This class is specifically for setuping/printing out ajax related
 * elements onto a page it takes care of the observing and all that raz-a-ma-taz
 */
class Ajax { 

	/**
	 * constructor
	 * This is what is called when the class is loaded
	 */
	public function __construct() { 

		// Rien a faire

	} // constructor

	/**
	 * observe
	 * This returns a string with the correct and full ajax 'observe' stuff from prototype
	 */
	public static function observe($source,$method,$action) { 

                $non_quoted = array('document','window');

                if (in_array($source,$non_quoted)) {
                        $source_txt = $source;
                }
                else {
                        $source_txt = "'$source'";
                }

                $observe	= "\n <script type=\"text/javascript\"><!--\n";
                $observe	.= "\tEvent.observe($source_txt,'$method',function(){" . $action . ";});\n";
                $observe	.= "--></script>\n";

		return $observe; 

	} // observe

	/**
	 * action
	 * This takes the action, the source and the post (if passed) and generated the full
	 * ajax link
	 */
	public static function action($action,$source,$post='') { 

		$url = Config::get('ajax_url') . $action; 

                $non_quoted = array('document','window');

                if (in_array($source,$non_quoted)) {
                        $source_txt = $source;
                }
                else {
                        $source_txt = "'$source'";
                }

		if ($post) { 
			$ajax_string = "ajaxPost('$url','$post',$source_txt)"; 
		}
		else { 
			$ajax_string = "ajaxPut('$url',$source_txt)"; 
		} 
	
		return $ajax_string; 

	} // action

	/**
	 * button
	 * This prints out an img of the specified icon with the specified alt text
	 * and then sets up the required ajax for it
	 */
	public static function button($action,$icon,$alt,$source='',$post='') { 

		// Get the correct action
		$ajax_string = self::action($action,$source,$post); 

		$string = get_user_icon($icon,$alt,$source); 

		$string .= self::observe($source,'click',$ajax_string); 

                return $string;

	} // button

	/**
	 * text
	 * This prints out the specified text as a link and setups the required
	 * ajax for the link so it works correctly
	 */
	public static function text($action,$text,$source,$post='',$span_class='') { 

		// Format the string we wanna use
		$ajax_string = self::action($action,$source,$post); 

		// If they passed a span class
		if ($span_class) { 
			$class_txt = ' class="' . $span_class . '"'; 
		} 

		// If we pass a source put it in the ID
		$string = "<span id=\"$source\" $class_txt>$text</span>\n"; 

		$string .= self::observe($source,'click',$ajax_string); 

		return $string; 

	} // text

	/**
	 * run
	 * This runs the specified action no questions asked
	 */
	public static function run($action) { 

		echo "<script type=\"text/javascript\"><!--\n"; 
		echo "$action"; 
		echo "\n--></script>"; 

	} // run

} // end Ajax class
?>