mirror/php-e107
1
0
Fork 0
mirror of https://github.com/e107inc/e107.git synced 2025-07-31 11:50:30 +02:00
Code Issues Releases Wiki Activity

Fixed PHP docs.

Browse Source
This commit is contained in:
Lóna Lore
2016-03-03 12:15:01 +01:00
parent 4d0cdfc0ba
commit 80cf7652a9
1 changed files with 10 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
e107_handlers/e_ajax_class.php
View File

@@ -37,7 +37,9 @@
* $ajax = e107::ajax(); * $ajax = e107::ajax();
* *
* $commands = array(); * $commands = array();
* // Remove 'disabled' attribute from the content of '#object-1' on the page. * // Merge array into e107.settings javascript object.
* $commands[] = $ajax->commandSettings(array('foo' => 'bar'));
* // Remove 'disabled' attribute from the '#object-1' element.
* $commands[] = $ajax->commandInvoke('#object-1', 'removeAttr', array('disabled')); * $commands[] = $ajax->commandInvoke('#object-1', 'removeAttr', array('disabled'));
* // Insert HTML content into the '#object-1' element. * // Insert HTML content into the '#object-1' element.
* $commands[] = $ajax->commandInsert('#object-1', 'html', 'some html content'); * $commands[] = $ajax->commandInsert('#object-1', 'html', 'some html content');
@@ -118,7 +120,7 @@ class e_ajax_class
* The message string to display to the user. * The message string to display to the user.
* *
* @return array * @return array
* An array suitable for use with the e107::ajax->render() function. * An array suitable for use with the e107::ajax()->render() function.
*/ */
public function commandAlert($text) public function commandAlert($text)
{ {
@@ -142,7 +144,7 @@ class e_ajax_class
* The data to use with the jQuery method. * The data to use with the jQuery method.
* *
* @return array * @return array
* An array suitable for use with the e107::ajax->render() function. * An array suitable for use with the e107::ajax()->render() function.
*/ */
public function commandInsert($target, $method, $html) public function commandInsert($target, $method, $html)
{ {
@@ -165,7 +167,7 @@ class e_ajax_class
* A jQuery selector string. * A jQuery selector string.
* *
* @return array * @return array
* An array suitable for use with the e107::ajax->render() function. * An array suitable for use with the e107::ajax()->render() function.
* *
* @see http://docs.jquery.com/Manipulation/remove#expr * @see http://docs.jquery.com/Manipulation/remove#expr
*/ */
@@ -189,7 +191,7 @@ class e_ajax_class
* An array of key/value pairs to set in the CSS for the target. * An array of key/value pairs to set in the CSS for the target.
* *
* @return array * @return array
* An array suitable for use with the e107::ajax->render() function. * An array suitable for use with the e107::ajax()->render() function.
* *
* @see http://docs.jquery.com/CSS/css#properties * @see http://docs.jquery.com/CSS/css#properties
*/ */
@@ -214,7 +216,7 @@ class e_ajax_class
* array. * array.
* *
* @return array * @return array
* An array suitable for use with the e107::ajax->render() function. * An array suitable for use with the e107::ajax()->render() function.
*/ */
public function commandSettings($settings) public function commandSettings($settings)
{ {
@@ -239,7 +241,7 @@ class e_ajax_class
* The value of the data. Not just limited to strings can be any format. * The value of the data. Not just limited to strings can be any format.
* *
* @return array * @return array
* An array suitable for use with the e107::ajax->render() function. * An array suitable for use with the e107::ajax()->render() function.
* *
* @see http://docs.jquery.com/Core/data#namevalue * @see http://docs.jquery.com/Core/data#namevalue
*/ */
@@ -269,7 +271,7 @@ class e_ajax_class
* (optional) A list of arguments to the jQuery $method, if any. * (optional) A list of arguments to the jQuery $method, if any.
* *
* @return array * @return array
* An array suitable for use with the e107::ajax->render() function. * An array suitable for use with the e107::ajax()->render() function.
*/ */
public function commandInvoke($target, $method, array $arguments = array()) public function commandInvoke($target, $method, array $arguments = array())
{ {