diff options
author | knut <> | 2007-05-30 23:27:00 +0000 |
---|---|---|
committer | knut <> | 2007-05-30 23:27:00 +0000 |
commit | c3a72002383cb3de9bdcff09214bb757b2bc5e46 (patch) | |
tree | 9c8c1fa0f4d83e38c46ba4485f849a2f5d218311 | |
parent | f71f9562d2ed0839f48bbf1bda7a80d0bc157778 (diff) |
fixing small typos in the API documentation
-rw-r--r-- | framework/Collections/TList.php | 4 | ||||
-rw-r--r-- | framework/Collections/TPagedList.php | 6 | ||||
-rw-r--r-- | framework/Collections/TQueue.php | 1 | ||||
-rw-r--r-- | framework/Collections/TStack.php | 2 | ||||
-rw-r--r-- | framework/PradoBase.php | 4 | ||||
-rw-r--r-- | framework/Security/TAuthManager.php | 2 | ||||
-rw-r--r-- | framework/Security/TAuthorizationRule.php | 2 | ||||
-rw-r--r-- | framework/Security/TUser.php | 2 | ||||
-rw-r--r-- | framework/TApplication.php | 4 | ||||
-rw-r--r-- | framework/TComponent.php | 4 | ||||
-rw-r--r-- | framework/Util/TDataFieldAccessor.php | 8 | ||||
-rw-r--r-- | framework/Util/TDateTimeStamp.php | 2 | ||||
-rw-r--r-- | framework/Util/TSimpleDateFormatter.php | 2 | ||||
-rw-r--r-- | framework/Util/TVarDumper.php | 2 | ||||
-rw-r--r-- | framework/Web/THttpRequest.php | 4 | ||||
-rw-r--r-- | framework/Web/THttpResponse.php | 2 | ||||
-rw-r--r-- | framework/Web/THttpResponseAdapter.php | 4 | ||||
-rw-r--r-- | framework/Web/THttpSession.php | 12 | ||||
-rw-r--r-- | framework/Web/TUrlMapping.php | 6 | ||||
-rw-r--r-- | framework/Web/UI/TClientScriptManager.php | 6 |
20 files changed, 40 insertions, 39 deletions
diff --git a/framework/Collections/TList.php b/framework/Collections/TList.php index e646e203..44255957 100644 --- a/framework/Collections/TList.php +++ b/framework/Collections/TList.php @@ -56,7 +56,7 @@ class TList extends TComponent implements IteratorAggregate,ArrayAccess,Countabl /**
* Constructor.
* Initializes the list with an array or an iterable object.
- * @param array|Iterator the intial data. Default is null, meaning no initialization.
+ * @param array|Iterator the initial data. Default is null, meaning no initialization.
* @param boolean whether the list is read-only
* @throws TInvalidDataTypeException If data is not null and neither an array nor an iterator.
*/
@@ -141,7 +141,7 @@ class TList extends TComponent implements IteratorAggregate,ArrayAccess,Countabl * Inserts an item at the specified position.
* Original item at the position and the next items
* will be moved one step towards the end.
- * @param integer the speicified position.
+ * @param integer the specified position.
* @param mixed new item
* @throws TInvalidDataValueException If the index specified exceeds the bound
* @throws TInvalidOperationException if the list is read-only
diff --git a/framework/Collections/TPagedList.php b/framework/Collections/TPagedList.php index e31dfe80..978abf05 100644 --- a/framework/Collections/TPagedList.php +++ b/framework/Collections/TPagedList.php @@ -76,7 +76,7 @@ class TPagedList extends TList /**
* Constructor.
- * @param array|Iterator the intial data. Default is null, meaning no initialization.
+ * @param array|Iterator the initial data. Default is null, meaning no initialization.
* @param boolean whether the list is read-only. Always true for paged list.
*/
public function __construct($data=null,$readOnly=false)
@@ -205,7 +205,7 @@ class TPagedList extends TList /**
* Switches to the next page.
- * @return integer|boolean the new page index, false if next page is not availabe.
+ * @return integer|boolean the new page index, false if next page is not available.
*/
public function nextPage()
{
@@ -214,7 +214,7 @@ class TPagedList extends TList /**
* Switches to the previous page.
- * @return integer|boolean the new page index, false if previous page is not availabe.
+ * @return integer|boolean the new page index, false if previous page is not available.
*/
public function previousPage()
{
diff --git a/framework/Collections/TQueue.php b/framework/Collections/TQueue.php index 025fa6d0..8f0b1ebb 100644 --- a/framework/Collections/TQueue.php +++ b/framework/Collections/TQueue.php @@ -27,6 +27,7 @@ * </code>
*
* @author Qiang Xue <qiang.xue@gmail.com>
+ * @author Knut Urdalen <knut.urdalen@gmail.com>
* @version $Id$
* @package System.Collections
* @since 3.1
diff --git a/framework/Collections/TStack.php b/framework/Collections/TStack.php index 66f69f6c..1f18d60c 100644 --- a/framework/Collections/TStack.php +++ b/framework/Collections/TStack.php @@ -47,7 +47,7 @@ class TStack extends TComponent implements IteratorAggregate,Countable /**
* Constructor.
* Initializes the stack with an array or an iterable object.
- * @param array|Iterator the intial data. Default is null, meaning no initialization.
+ * @param array|Iterator the initial data. Default is null, meaning no initialization.
* @throws TInvalidDataTypeException If data is not null and neither an array nor an iterator.
*/
public function __construct($data=null)
diff --git a/framework/PradoBase.php b/framework/PradoBase.php index 7f15ab81..f8d8ec81 100644 --- a/framework/PradoBase.php +++ b/framework/PradoBase.php @@ -216,8 +216,8 @@ class PradoBase * For example, 'TButton', 'System.Web.UI.WebControls.TButton' are both
* valid component type.
* This method can also pass parameters to component constructors.
- * All paramters passed to this method except the first one (the component type)
- * will be supplied as component constructor paramters.
+ * All parameters passed to this method except the first one (the component type)
+ * will be supplied as component constructor parameters.
* @param string component type
* @return TComponent component instance of the specified type
* @throws TInvalidDataValueException if the component type is unknown
diff --git a/framework/Security/TAuthManager.php b/framework/Security/TAuthManager.php index 548e9522..e578f0c9 100644 --- a/framework/Security/TAuthManager.php +++ b/framework/Security/TAuthManager.php @@ -91,7 +91,7 @@ class TAuthManager extends TModule }
/**
- * @param string|IUserManager the user manager module ID or the user mananger object
+ * @param string|IUserManager the user manager module ID or the user manager object
* @throws TInvalidOperationException if the module has been initialized or the user manager object is not IUserManager
*/
public function setUserManager($provider)
diff --git a/framework/Security/TAuthorizationRule.php b/framework/Security/TAuthorizationRule.php index 99684de0..c5c9f23c 100644 --- a/framework/Security/TAuthorizationRule.php +++ b/framework/Security/TAuthorizationRule.php @@ -205,7 +205,7 @@ class TAuthorizationRuleCollection extends TList * Inserts an item at the specified position.
* This overrides the parent implementation by performing additional
* operations for each newly added TAuthorizationRule object.
- * @param integer the speicified position.
+ * @param integer the specified position.
* @param mixed new item
* @throws TInvalidDataTypeException if the item to be inserted is not a TAuthorizationRule object.
*/
diff --git a/framework/Security/TUser.php b/framework/Security/TUser.php index 5077114b..95458003 100644 --- a/framework/Security/TUser.php +++ b/framework/Security/TUser.php @@ -18,7 +18,7 @@ Prado::using('System.Security.IUserManager'); /**
* TUser class
*
- * TUser implements basic user functionality for a prado application.
+ * TUser implements basic user functionality for a Prado application.
* To get the name of the user, use {@link getName Name} property.
* The property {@link getIsGuest IsGuest} tells if the user a guest/anonymous user.
* To obtain or test the roles that the user is in, use property
diff --git a/framework/TApplication.php b/framework/TApplication.php index 2601e408..3e50d53d 100644 --- a/framework/TApplication.php +++ b/framework/TApplication.php @@ -678,7 +678,7 @@ class TApplication extends TComponent } /** - * @return TErrorHandler the error hanlder module + * @return TErrorHandler the error handler module */ public function getErrorHandler() { @@ -691,7 +691,7 @@ class TApplication extends TComponent } /** - * @param TErrorHandler the error hanlder module + * @param TErrorHandler the error handler module */ public function setErrorHandler(TErrorHandler $handler) { diff --git a/framework/TComponent.php b/framework/TComponent.php index 79732290..edf72af6 100644 --- a/framework/TComponent.php +++ b/framework/TComponent.php @@ -431,7 +431,7 @@ class TComponent * When this method is invoked, the component's properties have been initialized.
* The default implementation of this method will invoke
* the potential parent component's {@link addParsedObject}.
- * This method can be overriden.
+ * This method can be overridden.
* @param TComponent potential parent of this control
* @see addParsedObject
*/
@@ -443,7 +443,7 @@ class TComponent /**
* Processes an object that is created during parsing template.
* The object can be either a component or a static text string.
- * This method can be overriden to customize the handling of newly created objects in template.
+ * This method can be overridden to customize the handling of newly created objects in template.
* Only framework developers and control developers should use this method.
* @param string|TComponent text string or component parsed and instantiated in template
* @see createdOnTemplate
diff --git a/framework/Util/TDataFieldAccessor.php b/framework/Util/TDataFieldAccessor.php index 159ec950..b5c65044 100644 --- a/framework/Util/TDataFieldAccessor.php +++ b/framework/Util/TDataFieldAccessor.php @@ -19,9 +19,9 @@ * and the corresponding element value is returned;
* - If the data is a TMap or TList object, then the field is treated as a key
* into the map or list, and the corresponding value is returned.
- * - If the data is an object, the field is treated as a property or subproperty
+ * - If the data is an object, the field is treated as a property or sub-property
* defined with getter methods. For example, if the object has a method called
- * getMyValue(), then field 'MyValue' will retrive the result of this method call.
+ * getMyValue(), then field 'MyValue' will retrieve the result of this method call.
* If getMyValue() returns an object which contains a method getMySubValue(),
* then field 'MyValue.MySubValue' will return that method call result.
*
@@ -38,9 +38,9 @@ class TDataFieldAccessor * and the corresponding element value is returned;
* - If the data is a TMap or TList object, then the field is treated as a key
* into the map or list, and the corresponding value is returned.
- * - If the data is an object, the field is treated as a property or subproperty
+ * - If the data is an object, the field is treated as a property or sub-property
* defined with getter methods. For example, if the object has a method called
- * getMyValue(), then field 'MyValue' will retrive the result of this method call.
+ * getMyValue(), then field 'MyValue' will retrieve the result of this method call.
* If getMyValue() returns an object which contains a method getMySubValue(),
* then field 'MyValue.MySubValue' will return that method call result.
* @param mixed data containing the field value, can be an array, TMap, TList or object.
diff --git a/framework/Util/TDateTimeStamp.php b/framework/Util/TDateTimeStamp.php index 230d97d2..2b406cc9 100644 --- a/framework/Util/TDateTimeStamp.php +++ b/framework/Util/TDateTimeStamp.php @@ -200,7 +200,7 @@ class TDateTimeStamp * Low-level function that returns the getdate() array. We have a special
* $fast flag, which if set to true, will return fewer array values,
* and is much faster as it does not calculate dow, etc.
- * @param float orginal date
+ * @param float original date
* @param boolean false to compute the day of the week, default is true
* @param boolean true to calculate the GMT dates
* @return array an array with date info.
diff --git a/framework/Util/TSimpleDateFormatter.php b/framework/Util/TSimpleDateFormatter.php index 50ca0097..7eac630e 100644 --- a/framework/Util/TSimpleDateFormatter.php +++ b/framework/Util/TSimpleDateFormatter.php @@ -351,7 +351,7 @@ class TSimpleDateFormatter * @param int starting position
* @param int minimum integer length
* @param int maximum integer length
- * @return string integer portition of the string, null otherwise
+ * @return string integer portion of the string, null otherwise
*/
private function getInteger($str,$i,$minlength,$maxlength)
{
diff --git a/framework/Util/TVarDumper.php b/framework/Util/TVarDumper.php index e16309c3..72591355 100644 --- a/framework/Util/TVarDumper.php +++ b/framework/Util/TVarDumper.php @@ -15,7 +15,7 @@ *
* TVarDumper is intended to replace the buggy PHP function var_dump and print_r.
* It can correctly identify the recursively referenced objects in a complex
- * object structure. It also has a recurisve depth control to avoid indefinite
+ * object structure. It also has a recursive depth control to avoid indefinite
* recursive display of some peculiar variables.
*
* TVarDumper can be used as follows,
diff --git a/framework/Web/THttpRequest.php b/framework/Web/THttpRequest.php index 7b4ed9b3..6ae95ab3 100644 --- a/framework/Web/THttpRequest.php +++ b/framework/Web/THttpRequest.php @@ -563,7 +563,7 @@ class THttpRequest extends TApplicationComponent implements IteratorAggregate,Ar }
/**
- * Resolves the requested servie.
+ * Resolves the requested service.
* This method implements a URL-based service resolution.
* A URL in the format of /index.php?sp=serviceID.serviceParameter
* will be resolved with the serviceID and the serviceParameter.
@@ -815,7 +815,7 @@ class THttpCookieCollection extends TList * Inserts an item at the specified position.
* This overrides the parent implementation by performing additional
* operations for each newly added THttpCookie object.
- * @param integer the speicified position.
+ * @param integer the specified position.
* @param mixed new item
* @throws TInvalidDataTypeException if the item to be inserted is not a THttpCookie object.
*/
diff --git a/framework/Web/THttpResponse.php b/framework/Web/THttpResponse.php index 624b24be..d6469bea 100644 --- a/framework/Web/THttpResponse.php +++ b/framework/Web/THttpResponse.php @@ -491,7 +491,7 @@ class THttpResponse extends TModule implements ITextWriter }
/**
- * Create a new html writer intance.
+ * Create a new html writer instance.
* This method is used internally. Please use {@link createHtmlWriter} instead.
* @param string type of HTML writer to be created.
* @param ITextWriter text writer holding the contents.
diff --git a/framework/Web/THttpResponseAdapter.php b/framework/Web/THttpResponseAdapter.php index 8a1c86bb..a521bd21 100644 --- a/framework/Web/THttpResponseAdapter.php +++ b/framework/Web/THttpResponseAdapter.php @@ -13,8 +13,8 @@ /** * THttpResponseAdapter class. * - * THttpResponseAdapter allows the base http response class to change behaviour - * without change the class hierachy. + * THttpResponseAdapter allows the base http response class to change behavior + * without change the class hierarchy. * * @author Wei Zhuo <weizhuo[at]gmail[dot]com> * @version $Id$ diff --git a/framework/Web/THttpSession.php b/framework/Web/THttpSession.php index 233cd5d2..b9faea74 100644 --- a/framework/Web/THttpSession.php +++ b/framework/Web/THttpSession.php @@ -400,7 +400,7 @@ class THttpSession extends TApplicationComponent implements IteratorAggregate,Ar /**
* Session open handler.
- * This method should be overriden if {@link setUseCustomStorage UseCustomStorage} is set true.
+ * This method should be overridden if {@link setUseCustomStorage UseCustomStorage} is set true.
* @param string session save path
* @param string session name
* @return boolean whether session is opened successfully
@@ -412,7 +412,7 @@ class THttpSession extends TApplicationComponent implements IteratorAggregate,Ar /**
* Session close handler.
- * This method should be overriden if {@link setUseCustomStorage UseCustomStorage} is set true.
+ * This method should be overridden if {@link setUseCustomStorage UseCustomStorage} is set true.
* @return boolean whether session is closed successfully
*/
public function _close()
@@ -422,7 +422,7 @@ class THttpSession extends TApplicationComponent implements IteratorAggregate,Ar /**
* Session read handler.
- * This method should be overriden if {@link setUseCustomStorage UseCustomStorage} is set true.
+ * This method should be overridden if {@link setUseCustomStorage UseCustomStorage} is set true.
* @param string session ID
* @return string the session data
*/
@@ -433,7 +433,7 @@ class THttpSession extends TApplicationComponent implements IteratorAggregate,Ar /**
* Session write handler.
- * This method should be overriden if {@link setUseCustomStorage UseCustomStorage} is set true.
+ * This method should be overridden if {@link setUseCustomStorage UseCustomStorage} is set true.
* @param string session ID
* @param string session data
* @return boolean whether session write is successful
@@ -445,7 +445,7 @@ class THttpSession extends TApplicationComponent implements IteratorAggregate,Ar /**
* Session destroy handler.
- * This method should be overriden if {@link setUseCustomStorage UseCustomStorage} is set true.
+ * This method should be overridden if {@link setUseCustomStorage UseCustomStorage} is set true.
* @param string session ID
* @return boolean whether session is destroyed successfully
*/
@@ -456,7 +456,7 @@ class THttpSession extends TApplicationComponent implements IteratorAggregate,Ar /**
* Session GC (garbage collection) handler.
- * This method should be overriden if {@link setUseCustomStorage UseCustomStorage} is set true.
+ * This method should be overridden if {@link setUseCustomStorage UseCustomStorage} is set true.
* @param integer the number of seconds after which data will be seen as 'garbage' and cleaned up.
* @return boolean whether session is GCed successfully
*/
diff --git a/framework/Web/TUrlMapping.php b/framework/Web/TUrlMapping.php index 33f01340..5c04ea8e 100644 --- a/framework/Web/TUrlMapping.php +++ b/framework/Web/TUrlMapping.php @@ -205,7 +205,7 @@ class TUrlMapping extends TUrlManager *
* The {@link setPattern Pattern} property takes an string expression with
* parameter names enclosed between a left brace '{' and a right brace '}'.
- * The pattens for each parameter can be set using {@link getParameters Parameters}
+ * The patterns for each parameter can be set using {@link getParameters Parameters}
* attribute collection. For example
* <code>
* <url ... pattern="articles/{year}/{month}/{day}"
@@ -301,7 +301,7 @@ class TUrlMappingPattern extends TComponent }
/**
- * Subsitutue the parameter key value pairs as named groupings
+ * Substitute the parameter key value pairs as named groupings
* in the regular expression matching pattern.
* @return string regular expression pattern with parameter subsitution
*/
@@ -330,7 +330,7 @@ class TUrlMappingPattern extends TComponent }
/**
- * @param string full regular expression mapping patern.
+ * @param string full regular expression mapping pattern.
*/
public function setRegularExpression($value)
{
diff --git a/framework/Web/UI/TClientScriptManager.php b/framework/Web/UI/TClientScriptManager.php index 4fded17b..817127f0 100644 --- a/framework/Web/UI/TClientScriptManager.php +++ b/framework/Web/UI/TClientScriptManager.php @@ -52,11 +52,11 @@ class TClientScriptManager extends TApplicationComponent */ private $_scriptFiles=array(); /** - * @var array javascript files to be renderd in page head section + * @var array javascript files to be rendered in page head section */ private $_headScriptFiles=array(); /** - * @var array javascript blocks to be renderd in page head section + * @var array javascript blocks to be rendered in page head section */ private $_headScripts=array(); /** @@ -99,7 +99,7 @@ class TClientScriptManager extends TApplicationComponent } /** - * Registers a prado javascript library to be loaded. + * Registers a Prado javascript library to be loaded. */ private function registerPradoScriptInternal($name) { |