From dfb3960eaba21c29081a13dabf22534dad48e187 Mon Sep 17 00:00:00 2001 From: thomas Date: Sun, 13 Jun 2010 20:20:22 +0000 Subject: [PATCH] [MANUAL] English: - some manual fixes git-svn-id: http://framework.zend.com/svn/framework/standard/trunk@22432 44c647ce-9c0f-0410-b52a-842ac1e357ba --- .../manual/en/module_specs/Zend_Gdata_Photos.xml | 16 +++++----- .../en/module_specs/Zend_Gdata_Spreadsheets.xml | 36 +++++++++++----------- .../en/module_specs/Zend_Http_Client-Adapters.xml | 11 ++++--- .../manual/en/module_specs/Zend_Json-Basics.xml | 4 +-- .../en/module_specs/Zend_Layout-Advanced.xml | 4 +-- .../en/module_specs/Zend_Layout-QuickStart.xml | 4 +-- .../manual/en/module_specs/Zend_Log-Filters.xml | 2 +- 7 files changed, 39 insertions(+), 38 deletions(-) diff --git a/documentation/manual/en/module_specs/Zend_Gdata_Photos.xml b/documentation/manual/en/module_specs/Zend_Gdata_Photos.xml index c9b69e183..e0e9e9d4a 100644 --- a/documentation/manual/en/module_specs/Zend_Gdata_Photos.xml +++ b/documentation/manual/en/module_specs/Zend_Gdata_Photos.xml @@ -276,7 +276,7 @@ $service = new Zend_Gdata_Photos(); - A new UserQuery can be constructed as followed: + A new UserQuery can be constructed as followed: setUser("sample.user"); The service supports retrieving a user feed and list of the user's content. If the requested user is also the authenticated user, entries marked as - "hidden" will also be returned. + "hidden" will also be returned. The user feed can be accessed by passing the username to the - getUserFeed method: + getUserFeed() method: The album feed is accessed by constructing a query object and passing it to - getAlbumFeed: + getAlbumFeed(): Alternatively, the query object can be given an album name with - setAlbumName. Setting the album name is mutually exclusive with setting - the album id, and setting one will unset the other. + setAlbumName(). Setting the album name is mutually + exclusive with setting the album id, and setting one will unset the other. @@ -516,7 +516,7 @@ try { The photo feed is accessed by constructing a query object and passing it to - getPhotoFeed: + getPhotoFeed(): deleteTagEntry($tagEntry, true); An example of how to handle versioning during a deletion is shown by - deleteAlbumEntry: + deleteAlbumEntry(): You can get a list of spreadsheets for a particular user by using - the getSpreadsheetFeed method of the Spreadsheets + the getSpreadsheetFeed() method of the Spreadsheets service. The service will return a Zend_Gdata_Spreadsheets_SpreadsheetFeed object containing a list of spreadsheets associated with the authenticated @@ -73,7 +73,7 @@ $feed = $spreadsheetService->getWorksheetFeed($query); object feed represents the response from the server. Among other things, this feed contains a list of Zend_Gdata_Spreadsheets_WorksheetEntry - objects ($feed->entries), each of which represents a + objects ($feed->entries), each of which represents a single worksheet. @@ -128,7 +128,7 @@ $feed = $spreadsheetService->getWorksheetFeed($query); To retrieve a worksheet's list feed, use the - getListFeed method of the Spreadsheets service. + getListFeed() method of the Spreadsheets service. getListFeed($query); object $listfeed represents a response from the server. Among other things, this feed contains an array of Zend_Gdata_Spreadsheets_ListEntry objects - ($listFeed->entries), each of which represents + ($listFeed->entries), each of which represents a single row in a worksheet. Each Zend_Gdata_Spreadsheets_ListEntry contains an - array, custom, which contains the data for that + array, custom, which contains the data for that row. You can extract and display this array: @@ -161,7 +161,7 @@ foreach($rowData as $customEntry) { ]]> - An alternate version of this array, customByName, + An alternate version of this array, customByName, allows direct access to an entry's cells by name. This is convenient when trying to access a specific header: @@ -194,9 +194,9 @@ $listFeed = $spreadsheetService->getListFeed($query); Note that if you want to order (or reverse sort) by a particular column, rather than by position in the worksheet, - you can set the orderby value of the + you can set the orderby value of the Zend_Gdata_Spreadsheets_ListQuery object to - column:<the header of that column>. + column:<the header of that column>. @@ -205,12 +205,12 @@ $listFeed = $spreadsheetService->getListFeed($query); You can set a Zend_Gdata_Spreadsheets_ListQuery's - sq value to produce a feed with entries that meet + sq value to produce a feed with entries that meet the specified criteria. For example, suppose you have a worksheet containing personnel data, in which each row represents information about a single person. You wish to retrieve all rows in which the person's name is "John" and the person's age is over - 25. To do so, you would set sq as follows: + 25. To do so, you would set sq as follows: getListFeed($query); Rows can be added to a spreadsheet by using the - insertRow method of the Spreadsheet service. + insertRow() method of the Spreadsheet service. insertRow($rowData, Once a Zend_Gdata_Spreadsheets_ListEntry object is fetched, its rows can be updated by using the - updateRow method of the Spreadsheet service. + updateRow() method of the Spreadsheet service. updateRow($oldListEntry, Delete a Row - To delete a row, simply invoke deleteRow on the + To delete a row, simply invoke deleteRow() on the Zend_Gdata_Spreadsheets object with the existing entry to be deleted: @@ -288,7 +288,7 @@ $spreadsheetService->deleteRow($listEntry); ]]> - Alternatively, you can call the delete method of + Alternatively, you can call the delete() method of the entry itself: @@ -315,7 +315,7 @@ $listEntry->delete(); To retrieve a worksheet's cell feed, use the - getCellFeed method of the Spreadsheets service. + getCellFeed() method of the Spreadsheets service. getCellFeed($query); object $cellFeed represents a response from the server. Among other things, this feed contains an array of Zend_Gdata_Spreadsheets_CellEntry objects - ($cellFeed>entries), each of which represents + ($cellFeed>entries), each of which represents a single cell in a worksheet. You can display this information: @@ -371,7 +371,7 @@ $feed = $spreadsheetService->getCellsFeed($query); To modify the contents of a cell, call - updateCell with the row, column, + updateCell() with the row, column, and new value of the cell. @@ -386,7 +386,7 @@ $updatedCell = $spreadsheetService->updateCell($row, The new data is placed in the specified cell in the worksheet. If the specified cell contains data already, it will be - overwritten. Note: Use updateCell to change + overwritten. Note: Use updateCell() to change the data in a cell, even if the cell is empty. diff --git a/documentation/manual/en/module_specs/Zend_Http_Client-Adapters.xml b/documentation/manual/en/module_specs/Zend_Http_Client-Adapters.xml index 0ae25d0a3..dc33deb08 100644 --- a/documentation/manual/en/module_specs/Zend_Http_Client-Adapters.xml +++ b/documentation/manual/en/module_specs/Zend_Http_Client-Adapters.xml @@ -53,8 +53,8 @@ using the 'adapter' configuration option. When instantiating the client object, you can set the 'adapter' configuration option to a string containing the adapter's name (eg. 'Zend_Http_Client_Adapter_Socket') - or to a variable holding an adapter object (eg. - new Zend_Http_Client_Adapter_Test). You can also set the + or to a variable holding an adapter object (eg. + new Zend_Http_Client_Adapter_Test). You can also set the adapter later, using the Zend_Http_Client->setConfig() method. @@ -177,8 +177,9 @@ HTTPS SSL Stream Parameters - ssltransport, sslcert and sslpassphrase - are only relevant when connecting using HTTPS. + ssltransport, sslcert and + sslpassphrase are only relevant when connecting using + HTTPS. @@ -479,7 +480,7 @@ $client = new Zend_Http_Client($uri, $config); specifying the 'curloptions' key in the constructor of the adapter or by calling setCurlOption($name, $value). The $name key corresponds to the CURL_* constants of the cURL extension. You can - get access to the Curl handle by calling $adapter->getHandle(); + get access to the Curl handle by calling $adapter->getHandle(); diff --git a/documentation/manual/en/module_specs/Zend_Json-Basics.xml b/documentation/manual/en/module_specs/Zend_Json-Basics.xml index 3fcaa81e7..ccb64d9ca 100644 --- a/documentation/manual/en/module_specs/Zend_Json-Basics.xml +++ b/documentation/manual/en/module_specs/Zend_Json-Basics.xml @@ -38,8 +38,8 @@ if($debug) { Second optional argument of Zend_Json::prettyPrint() is an - option array. Option indent allows to set indentation string - by default - it's a single tab character. + option array. Option indent allows to set indentation string - by + default it's a single tab character. diff --git a/documentation/manual/en/module_specs/Zend_Layout-Advanced.xml b/documentation/manual/en/module_specs/Zend_Layout-Advanced.xml index 7a78ed1ba..0bed04e07 100644 --- a/documentation/manual/en/module_specs/Zend_Layout-Advanced.xml +++ b/documentation/manual/en/module_specs/Zend_Layout-Advanced.xml @@ -114,7 +114,7 @@ $layoutVars = $placeholders->placeholder('Zend_Layout')->getArrayCopy(); last action prior to exiting the dispatch loop. In most cases, the default plugin will be suitable, but should you desire to write your own, you can specify the name of the plugin class to load by - passing the pluginClass option to the + passing the pluginClass option to the startMvc() method. @@ -147,7 +147,7 @@ $layoutVars = $placeholders->placeholder('Zend_Layout')->getArrayCopy(); Should you feel the need to write custom functionality, simply write an action helper class extending Zend_Controller_Action_Helper_Abstract and pass the - class name as the helperClass option to the + class name as the helperClass option to the startMvc() method. Details of the implementation are up to you. diff --git a/documentation/manual/en/module_specs/Zend_Layout-QuickStart.xml b/documentation/manual/en/module_specs/Zend_Layout-QuickStart.xml index d07437fd4..177c6e6a7 100644 --- a/documentation/manual/en/module_specs/Zend_Layout-QuickStart.xml +++ b/documentation/manual/en/module_specs/Zend_Layout-QuickStart.xml @@ -107,7 +107,7 @@ and registers an action helper to allow access to the layout object from your action controllers. Additionally, you may at any time grab the layout instance from within a view script using the - layout view helper. + Layout view helper. @@ -150,7 +150,7 @@ class FooController extends Zend_Controller_Action In your view scripts, you can then access the layout object via the - layout view helper. This view helper is slightly + Layout view helper. This view helper is slightly different than others in that it takes no arguments, and returns an object instead of a string value. This allows you to immediately call methods on the layout object: diff --git a/documentation/manual/en/module_specs/Zend_Log-Filters.xml b/documentation/manual/en/module_specs/Zend_Log-Filters.xml index dcb77dea0..a88e23d84 100644 --- a/documentation/manual/en/module_specs/Zend_Log-Filters.xml +++ b/documentation/manual/en/module_specs/Zend_Log-Filters.xml @@ -42,7 +42,7 @@ $logger->emerg('Emergency message'); To filter only on a specific Writer instance, use the - addFilter method of that Writer: + addFilter() method of that Writer: