aboutsummaryrefslogtreecommitdiff
path: root/tests/TestBaseApi.php
diff options
context:
space:
mode:
authorcweiske <cweiske@b3834d28-1941-0410-a4f8-b48e95affb8f>2010-09-28 22:10:53 +0000
committercweiske <cweiske@b3834d28-1941-0410-a4f8-b48e95affb8f>2010-09-28 22:10:53 +0000
commit6b3f1d476ea0d1be46b3e4a7df6983320865303b (patch)
treebebc9e1fd54e143ea58b19bb8d05d02bb84aa94c /tests/TestBaseApi.php
parentb9256b14377251e6303d6abbe3cd7e7edc2583a4 (diff)
downloadsemanticscuttle-6b3f1d476ea0d1be46b3e4a7df6983320865303b.tar.gz
semanticscuttle-6b3f1d476ea0d1be46b3e4a7df6983320865303b.tar.bz2
update docblocks
git-svn-id: https://semanticscuttle.svn.sourceforge.net/svnroot/semanticscuttle/trunk@766 b3834d28-1941-0410-a4f8-b48e95affb8f
Diffstat (limited to 'tests/TestBaseApi.php')
-rw-r--r--tests/TestBaseApi.php21
1 files changed, 19 insertions, 2 deletions
diff --git a/tests/TestBaseApi.php b/tests/TestBaseApi.php
index 645ead9..eb1457f 100644
--- a/tests/TestBaseApi.php
+++ b/tests/TestBaseApi.php
@@ -29,6 +29,16 @@ class TestBaseApi extends TestBase
protected $url;
protected $urlPart = null;
+ /**
+ * @var SemanticScuttle_Service_User
+ */
+ protected $us;
+
+ /**
+ * @var SemanticScuttle_Service_Bookmark
+ */
+ protected $bs;
+
protected function setUp()
@@ -52,11 +62,14 @@ class TestBaseApi extends TestBase
/**
- * Gets a HTTP request object
+ * Gets a HTTP request object.
+ * Uses $this->url plus $urlSuffix as request URL.
*
* @param string $urlSuffix Suffix for the URL
*
* @return HTTP_Request2 HTTP request object
+ *
+ * @uses $url
*/
protected function getRequest($urlSuffix = null)
{
@@ -71,13 +84,17 @@ class TestBaseApi extends TestBase
/**
- * Gets a HTTP request object
+ * Creates a user and a HTTP request object and prepares
+ * the request object with authentication details, so that
+ * the user is logged in.
*
* @param string $urlSuffix Suffix for the URL
* @param mixed $auth If user authentication is needed (true/false)
* or array with username and password
*
* @return array(HTTP_Request2, integer) HTTP request object and user id
+ *
+ * @uses getRequest()
*/
protected function getAuthRequest($urlSuffix = null, $auth = true)
{