Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/matomo-org/matomo.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authordiosmosis <benakamoorthi@fastmail.fm>2013-12-08 06:36:27 +0400
committerdiosmosis <benakamoorthi@fastmail.fm>2013-12-08 06:36:27 +0400
commit4cafa9e3c79051476c54ad81a3e73e7242e7775a (patch)
tree431054418bf63b5094e5c4be961ab420278d289e /core/ScheduledTask.php
parent87d676dbff31adb4c1cf389cd66511434ab925ab (diff)
Refs #4200 revised some of class/method docs.
Diffstat (limited to 'core/ScheduledTask.php')
-rw-r--r--core/ScheduledTask.php21
1 files changed, 10 insertions, 11 deletions
diff --git a/core/ScheduledTask.php b/core/ScheduledTask.php
index 705e606c76..7fedcfd747 100644
--- a/core/ScheduledTask.php
+++ b/core/ScheduledTask.php
@@ -15,7 +15,7 @@ use Exception;
use Piwik\ScheduledTime;
/**
- * Contains metadata describing a chunk of PHP code that should be executed at regular
+ * Contains metadata referencing PHP code that should be executed at regular
* intervals.
*
* See the {@link TaskScheduler} docs to learn more about scheduled tasks.
@@ -72,10 +72,9 @@ class ScheduledTask
/**
* Constructor.
*
- * @param mixed $objectInstance The object or class name for the class that contains the method to
- * regularly execute. Usually this will be a {@link Plugin} instance.
- * @param string $methodName The name of the method of `$objectInstance` that will be regularly
- * executed.
+ * @param mixed $objectInstance The object or class that contains the method to execute regularly.
+ * Usually this will be a {@link Plugin} instance.
+ * @param string $methodName The name of the method that will be regularly executed.
* @param mixed|null $methodParameter An optional parameter to pass to the method when executed.
* Must be convertible to string.
* @param ScheduledTime|null $scheduledTime A {@link ScheduledTime} instance that describes when the method
@@ -111,7 +110,7 @@ class ScheduledTask
}
/**
- * Returns the object instance on which the method should be executed. Returns a class
+ * Returns the object instance that contains the method to execute. Returns a class
* name if the method is static.
*
* @return mixed
@@ -122,7 +121,7 @@ class ScheduledTask
}
/**
- * Returns the class name that contains the method to execute regularly.
+ * Returns the name of the class that contains the method to execute.
*
* @return string
*/
@@ -132,7 +131,7 @@ class ScheduledTask
}
/**
- * Returns the method name that will be regularly executed.
+ * Returns the name of the method that will be executed.
*
* @return string
*/
@@ -142,7 +141,7 @@ class ScheduledTask
}
/**
- * Returns the a value that will be passed to the method when executed, or `null` if
+ * Returns the value that will be passed to the method when executed, or `null` if
* no value will be supplied.
*
* @return string|null
@@ -186,9 +185,9 @@ class ScheduledTask
/**
* Returns a unique name for this scheduled task. The name is stored in the DB and is used
- * to store when tasks were last executed. The name is created using:
+ * to store a task's previous execution time. The name is created using:
*
- * - the class name that contains the method to execute,
+ * - the name of the class that contains the method to execute,
* - the name of the method to regularly execute,
* - and the value that is passed to the executed task.
*