summaryrefslogtreecommitdiff
path: root/modules/php
diff options
context:
space:
mode:
authorwebchick <webchick@24967.no-reply.drupal.org>2012-01-21 10:25:51 -0800
committerwebchick <webchick@24967.no-reply.drupal.org>2012-01-21 10:25:51 -0800
commit283523192421f0708c01f7fa08d5814442c757a5 (patch)
treea9fc2de7103295d5849aea2df757b8f11739cd87 /modules/php
parent138745688bcbed1a20b301ed616e5ed0796ecb5e (diff)
downloadbrdo-283523192421f0708c01f7fa08d5814442c757a5.tar.gz
brdo-283523192421f0708c01f7fa08d5814442c757a5.tar.bz2
Revert "Issue #1367000 by chris.leversuch, oriol_e9g, David_Rothstein: Clean up API docs for php module."
Sorry, we're over thresholds atm. Hopefully can commit this soon. This reverts commit 4303ae6e48e140696e1a9c923bcdf913fa63c88d.
Diffstat (limited to 'modules/php')
-rw-r--r--modules/php/php.module25
-rw-r--r--modules/php/php.test8
2 files changed, 13 insertions, 20 deletions
diff --git a/modules/php/php.module b/modules/php/php.module
index a30c607b5..37bf9a1f3 100644
--- a/modules/php/php.module
+++ b/modules/php/php.module
@@ -36,29 +36,23 @@ function php_permission() {
}
/**
- * Evaluates a string of PHP code.
+ * Evaluate a string of PHP code.
*
- * This is a wrapper around PHP's eval(). It uses output buffering to capture
- * both returned and printed text. Unlike eval(), we require code to be
- * surrounded by <?php ?> tags; in other words, we evaluate the code as if it
- * were a stand-alone PHP file.
+ * This is a wrapper around PHP's eval(). It uses output buffering to capture both
+ * returned and printed text. Unlike eval(), we require code to be surrounded by
+ * <?php ?> tags; in other words, we evaluate the code as if it were a stand-alone
+ * PHP file.
*
* Using this wrapper also ensures that the PHP code which is evaluated can not
* overwrite any variables in the calling code, unlike a regular eval() call.
*
- * This function is also used as an implementation of
- * hook_filter_FILTER_process().
- *
* @param $code
* The code to evaluate.
- *
* @return
- * A string containing the printed output of the code, followed by the
- * returned output of the code.
+ * A string containing the printed output of the code, followed by the returned
+ * output of the code.
*
* @ingroup php_wrappers
- *
- * @see php_filter_info()
*/
function php_eval($code) {
global $theme_path, $theme_info, $conf;
@@ -88,9 +82,7 @@ function php_eval($code) {
}
/**
- * Implements hook_filter_FILTER_tips().
- *
- * @see php_filter_info()
+ * Tips callback for php filter.
*/
function _php_filter_tips($filter, $format, $long = FALSE) {
global $base_url;
@@ -145,3 +137,4 @@ function php_filter_info() {
);
return $filters;
}
+
diff --git a/modules/php/php.test b/modules/php/php.test
index 50fb55283..8ead2ac02 100644
--- a/modules/php/php.test
+++ b/modules/php/php.test
@@ -6,7 +6,7 @@
*/
/**
- * Defines a base PHP test case class.
+ * Base PHP test case class.
*/
class PHPTestCase extends DrupalWebTestCase {
protected $php_code_format;
@@ -38,7 +38,7 @@ class PHPTestCase extends DrupalWebTestCase {
}
/**
- * Creates a test node with PHP code in the body.
+ * Create a test node with PHP code in the body.
*
* @return stdObject Node object.
*/
@@ -60,7 +60,7 @@ class PHPFilterTestCase extends PHPTestCase {
}
/**
- * Makes sure that the PHP filter evaluates PHP code when used.
+ * Make sure that the PHP filter evaluates PHP code when used.
*/
function testPHPFilter() {
// Log in as a user with permission to use the PHP code text format.
@@ -101,7 +101,7 @@ class PHPAccessTestCase extends PHPTestCase {
}
/**
- * Makes sure that the user can't use the PHP filter when not given access.
+ * Make sure that user can't use the PHP filter when not given access.
*/
function testNoPrivileges() {
// Create node with PHP filter enabled.