From c7d41e5bea4a5f96979a08da9cc9f79355edfe70 Mon Sep 17 00:00:00 2001 From: wei <> Date: Sun, 16 Jul 2006 06:19:36 +0000 Subject: Update Time Tracker demo. --- .../protected/pages/Docs/TopicList.tpl | 2 +- .../protected/pages/Docs/WritingUnitTest.page | 43 ++++-- demos/time-tracker/protected/pages/Docs/config.xml | 12 +- demos/time-tracker/protected/pages/Docs/db.png | Bin 26879 -> 26521 bytes .../protected/pages/TimeTracker/Login.page | 38 +++++ .../protected/pages/TimeTracker/Login.php | 53 +++++++ .../protected/pages/TimeTracker/Logout.page | 0 .../protected/pages/TimeTracker/Logout.php | 34 +++++ .../protected/pages/TimeTracker/MainLayout.php | 7 + .../protected/pages/TimeTracker/MainLayout.tpl | 40 +++++ .../protected/pages/TimeTracker/SiteMap.php | 8 + .../protected/pages/TimeTracker/SiteMap.tpl | 43 ++++++ .../protected/pages/TimeTracker/UserCreate.page | 65 ++++++++ .../protected/pages/TimeTracker/UserCreate.php | 78 ++++++++++ .../protected/pages/TimeTracker/UserList.page | 3 + .../protected/pages/TimeTracker/config.xml | 24 +++ demos/time-tracker/protected/pages/Welcome.page | 168 +++++++++++++++++++++ 17 files changed, 598 insertions(+), 20 deletions(-) create mode 100644 demos/time-tracker/protected/pages/TimeTracker/Login.page create mode 100644 demos/time-tracker/protected/pages/TimeTracker/Login.php create mode 100644 demos/time-tracker/protected/pages/TimeTracker/Logout.page create mode 100644 demos/time-tracker/protected/pages/TimeTracker/Logout.php create mode 100644 demos/time-tracker/protected/pages/TimeTracker/MainLayout.php create mode 100644 demos/time-tracker/protected/pages/TimeTracker/MainLayout.tpl create mode 100644 demos/time-tracker/protected/pages/TimeTracker/SiteMap.php create mode 100644 demos/time-tracker/protected/pages/TimeTracker/SiteMap.tpl create mode 100644 demos/time-tracker/protected/pages/TimeTracker/UserCreate.page create mode 100644 demos/time-tracker/protected/pages/TimeTracker/UserCreate.php create mode 100644 demos/time-tracker/protected/pages/TimeTracker/UserList.page create mode 100644 demos/time-tracker/protected/pages/TimeTracker/config.xml create mode 100644 demos/time-tracker/protected/pages/Welcome.page (limited to 'demos/time-tracker/protected/pages') diff --git a/demos/time-tracker/protected/pages/Docs/TopicList.tpl b/demos/time-tracker/protected/pages/Docs/TopicList.tpl index 5fa2adb5..53243578 100644 --- a/demos/time-tracker/protected/pages/Docs/TopicList.tpl +++ b/demos/time-tracker/protected/pages/Docs/TopicList.tpl @@ -14,7 +14,7 @@

Testing Business Code

Create Business Code
Database Design
Using SQLMap Data Mapper
User Class and Exceptions
More Tests

Writing a Unit Test

Before we begin to write our business logic and code, we shall +proceed with the path of test driven development (TDD), or at least take +some part of that process.

Unit testing is a useful tool when we want to start to test our individual business logic classes. - The tests/unit directory will be used to hold the unit test cases and tests/functional directory -to hold the function test cases. + The tests/unit directory will be used to hold the unit test + cases and tests/functional directory + to hold the function test cases.

Write a unit test case

We will start be writing a very simple unit test case.

We will start be writing a very simple unit test case. Notice +that we are writing the test case first.

<?php class ProjectTestCase extends UnitTestCase @@ -29,14 +35,16 @@ directory.

Figure 1: Unit test runner

Clicking on the ProjectTestCase.php like, you should see +

Clicking on the ProjectTestCase.php link, you should see

Figure 2: Unit test failure

Smallest step to make the test pass.

Obviously, we need create the class Project, so lets define the class.

Since we only wrote the test case and nothing else we expected +that the test case will fail at some point. Obviously, we need create +a class Project, so lets define the Project class.

<?php class Project @@ -44,15 +52,11 @@ class Project } ?> -

Save the above code as time-tracker/protected/pages/APP_CODE/Project.php. - Where the APP_CODE directory will contain most of your business logic code for the Time Tracker application.

We also need to add the following line in our test case so as to include the Project class file when running the tests.

- -

-The statement Prado::using('Application.APP_CODE.Project') basically -loads the Project.php class file. It assumes that a class name Project has filename Project.php. -For futher details regarding Prado::using can be found in Prado Namespaces documentation. -

We save the above code as time-tracker/protected/pages/APP_CODE/Project.php. + Where the APP_CODE directory will contain most of the business logic code + for the Time Tracker application.

Now, we also need to add the following line in our test case so as to +include the Project class file when running the tests.

<?php @@ -63,11 +67,20 @@ class ProjectTestCase extends UnitTestCase } ?> + +

Info: +The statement Prado::using('Application.APP_CODE.Project') basically +loads the Project.php class file. It assumes that a class name Project has filename Project.php. +For futher details regarding Prado::using can be found in Prado Namespaces documentation. +

Run the unit test runner again, we see that the test has passed.

Figure 3: Unit test success

-Later on, we shall write more test cases. See the SimpleTest documentation for detailed tutorial on writing test cases.

+Later on, we shall write more test cases. See the +SimpleTest documentation +for detailed tutorial on writing test cases.

- - - - + + + + +

Time Tracker Website Login

+ + +

+ * @version $Revision: $ $16/07/2006: $ + * @package Demos + * @since 3.1 + */ +class Login extends TPage +{ + /** + * Validates the username and password. + * @param TControl custom validator that created the event. + * @param TServerValidateEventParameter validation parameters. + */ + public function validateUser($sender, $param) + { + $authManager=$this->Application->getModule('auth'); + if(!$authManager->login($this->username->Text,$this->password->Text)) + $param->IsValid=false;; + } + + /** + * Redirect to the requested page if login is successful. + * @param TControl button control that created the event. + * @param TEventParameter event parameters. + */ + public function doLogin($sender, $param) + { + if($this->Page->IsValid) + { + $auth = $this->Application->getModule('auth'); + $this->Response->redirect($auth->getReturnUrl()); + } + } +} + +?> \ No newline at end of file diff --git a/demos/time-tracker/protected/pages/TimeTracker/Logout.page b/demos/time-tracker/protected/pages/TimeTracker/Logout.page new file mode 100644 index 00000000..e69de29b diff --git a/demos/time-tracker/protected/pages/TimeTracker/Logout.php b/demos/time-tracker/protected/pages/TimeTracker/Logout.php new file mode 100644 index 00000000..08fdfaf6 --- /dev/null +++ b/demos/time-tracker/protected/pages/TimeTracker/Logout.php @@ -0,0 +1,34 @@ + + * @link http://www.pradosoft.com/ + * @copyright Copyright © 2005-2006 PradoSoft + * @license http://www.pradosoft.com/license/ + * @version $Revision: $ $16/07/2006: $ + * @package Demos + */ + +/** + * Logout page class. + * + * @author Wei Zhuo + * @version $Revision: $ $16/07/2006: $ + * @package Demos + * @since 3.1 + */ +class Logout extends TPage +{ + /** + * Logs out the current user and redirect to default page. + */ + function onLoad($param) + { + $this->Application->getModule('auth')->logout(); + $url = $this->Service->constructUrl($this->Service->DefaultPage); + $this->Response->redirect($url); + } +} + +?> \ No newline at end of file diff --git a/demos/time-tracker/protected/pages/TimeTracker/MainLayout.php b/demos/time-tracker/protected/pages/TimeTracker/MainLayout.php new file mode 100644 index 00000000..253d6c03 --- /dev/null +++ b/demos/time-tracker/protected/pages/TimeTracker/MainLayout.php @@ -0,0 +1,7 @@ + \ No newline at end of file diff --git a/demos/time-tracker/protected/pages/TimeTracker/MainLayout.tpl b/demos/time-tracker/protected/pages/TimeTracker/MainLayout.tpl new file mode 100644 index 00000000..2d8bad44 --- /dev/null +++ b/demos/time-tracker/protected/pages/TimeTracker/MainLayout.tpl @@ -0,0 +1,40 @@ + + + + + + + +

+ My Company + Time Tracker + +

+ +

Help

Implementation Guide

+ +User->getIsGuest() %> /> + +

+ +

+ + + + + \ No newline at end of file diff --git a/demos/time-tracker/protected/pages/TimeTracker/SiteMap.php b/demos/time-tracker/protected/pages/TimeTracker/SiteMap.php new file mode 100644 index 00000000..0b71eb68 --- /dev/null +++ b/demos/time-tracker/protected/pages/TimeTracker/SiteMap.php @@ -0,0 +1,8 @@ + \ No newline at end of file diff --git a/demos/time-tracker/protected/pages/TimeTracker/SiteMap.tpl b/demos/time-tracker/protected/pages/TimeTracker/SiteMap.tpl new file mode 100644 index 00000000..48187b52 --- /dev/null +++ b/demos/time-tracker/protected/pages/TimeTracker/SiteMap.tpl @@ -0,0 +1,43 @@ + +

Log +
Reports +
- Project Reports
- Resources Report
+
+ Projects +
- Create New Project
- List Projects
+
+ Adminstration +
- Create New User
- List Users
+

+ + Event.OnLoad(function() + { + menuitems = $$(".menuitem"); + menuitems.each(function(el) + { + Event.observe(el, "mouseover", function(ev) + { + menuitems.each(function(item) + { + Element.removeClassName(item.parentNode, "active"); + }); + Element.addClassName(Event.element(ev).parentNode, "active"); + }); + }); + }); + + \ No newline at end of file diff --git a/demos/time-tracker/protected/pages/TimeTracker/UserCreate.page b/demos/time-tracker/protected/pages/TimeTracker/UserCreate.page new file mode 100644 index 00000000..fda7ba9b --- /dev/null +++ b/demos/time-tracker/protected/pages/TimeTracker/UserCreate.page @@ -0,0 +1,65 @@ + +

Create New User

+ + + + \ No newline at end of file diff --git a/demos/time-tracker/protected/pages/TimeTracker/UserCreate.php b/demos/time-tracker/protected/pages/TimeTracker/UserCreate.php new file mode 100644 index 00000000..b337bfca --- /dev/null +++ b/demos/time-tracker/protected/pages/TimeTracker/UserCreate.php @@ -0,0 +1,78 @@ + + * @link http://www.pradosoft.com/ + * @copyright Copyright © 2005-2006 PradoSoft + * @license http://www.pradosoft.com/license/ + * @version $Revision: $ $16/07/2006: $ + * @package Demos + */ + +/** + * Create new user page class. Validate that the usernames are unique + * and set the new user credentials as the current application credentials. + * + * @author Wei Zhuo + * @version $Revision: $ $16/07/2006: $ + * @package Demos + * @since 3.1 + */ +class UserCreate extends TPage +{ + /** + * Verify that the username is not taken. + * @param TControl custom validator that created the event. + * @param TServerValidateEventParameter validation parameters. + */ + public function checkUsername($sender, $param) + { + $userDao = $this->Application->Modules['daos']->getDao('UserDao'); + $user = $userDao->getUserByName($this->username->Text); + if(!is_null($user)) + { + $param->IsValid = false; + $sender->ErrorMessage = + "The user name is already taken, try '{$user->Name}01'"; + } + } + + /** + * Create a new user if all data entered are valid. + * The default user roles are obtained from "config.xml". The new user + * details is saved to the database and the new credentials are used as the + * application user. The user is redirected to the requested page. + * @param TControl button control that created the event. + * @param TEventParameter event parameters. + */ + public function createNewUser($sender, $param) + { + if($this->IsValid) + { + $newUser = new TimeTrackerUser($this->User->Manager); + $newUser->EmailAddress = $this->email->Text; + $newUser->Name = $this->username->Text; + $newUser->IsGuest = false; + $newUser->Roles = $this->Application->Parameters['NewUserRoles']; + + //save the user + $userDao = $this->Application->Modules['daos']->getDao('UserDao'); + $userDao->addNewUser($newUser, $this->password->Text); + + //update the user + $auth = $this->Application->getModule('auth'); + $auth->updateSessionUser($newUser); + $this->Application->User = $newUser; + + //return to requested page + $this->Response->redirect($auth->getReturnUrl()); + + //goto default page. + //$url = $this->Service->constructUrl($this->Service->DefaultPage); + //$this->Response->redirect($url); + } + } +} + +?> \ No newline at end of file diff --git a/demos/time-tracker/protected/pages/TimeTracker/UserList.page b/demos/time-tracker/protected/pages/TimeTracker/UserList.page new file mode 100644 index 00000000..48b2bbc7 --- /dev/null +++ b/demos/time-tracker/protected/pages/TimeTracker/UserList.page @@ -0,0 +1,3 @@ + +

List Users

+ \ No newline at end of file diff --git a/demos/time-tracker/protected/pages/TimeTracker/config.xml b/demos/time-tracker/protected/pages/TimeTracker/config.xml new file mode 100644 index 00000000..dac6465d --- /dev/null +++ b/demos/time-tracker/protected/pages/TimeTracker/config.xml @@ -0,0 +1,24 @@ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/demos/time-tracker/protected/pages/Welcome.page b/demos/time-tracker/protected/pages/Welcome.page new file mode 100644 index 00000000..65ada02d --- /dev/null +++ b/demos/time-tracker/protected/pages/Welcome.page @@ -0,0 +1,168 @@ + + + + Welcome + + + +

Time Tracker Starter Kit

+ Welcome to your new Time Tracker sample application. The key features are:

Projects. Define project information like due dates, hours to complete, + project resources, and more.
Track Time. Track time spent each day by category and project.
Reports. Generate progress and team resource reports across multiple projects.

+ The Time Tracker site is ready to run! No changes are needed.

+ +

Site Members and Roles

+ Your Time Tracker Web site allows visitors to register as members and then log in. + Members have specific privileges defined by roles such as administrator or guest. + Each Time Tracker Web site defines site-specific roles. + The following table describes what features are available to visitors in different roles.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Visitor	Privileges	Default Login
+ Not logged in	+ No privileges.
Logged in	+ No privileges. All members must be associated at least with the role Consultant.	N/A
Logged in as + Consultant	May log time entries only.	username: `consultant` + password: `consultant`
+ Logged in as + Project Manager	+ May additionally edit all projects and view reports.	username: `manager` + password: `manager`
+ Logged in as + Project Administrator	+ May additionally view the list of all users.	username: `admin` + password: `admin`

+ Be sure to create a user name for yourself and assign yourself to a role (such as administrator) that can manage the site.

+ Visitors can register by clicking the Create new user link on the home page. + New members are activated automatically, and are assigned to a role as specified in the application.xml file. + You can manage users (for example, assign them to a role) when login as administrator. + For details, see Appendix A.

+ +

Projects and Time Entries

To add a project and categories

Log in to the site as a member in the role Project Manager or Project Administrator.
Click the Projects tab and then click Create New Project.
Specify a project name, project manager, estimated complete date, estimated duration, and description.
Under Specify Project Members, select a resource. You must select at least one resource.
Click Save. A category pane is displayed on the right.
Specify a category name, category abbreviation, and duration.
Click Add. The new category is displayed in the categories list.
Repeat steps 6 and 7 to create additional categories.

Log a Time Entry

Log in to the site as a consultant (member in the role Consultant).
Click the Log tab.
Under Log your hours, choose a project and a category and fill in the day, hours, and description.
Make sure the correct consultant is selected in the Time Sheet For list.
Click Add Entry.

+ +

Reports

To create a project report

Log in to the site as a member in the role Project Manager or Project Administrator.
Click the Reports tab and then click Project Reports.
Under Select a project, choose one or more projects.
Click Generate Report.

To create a resource report

Log in to the site as a member in the role Project Manager or Project Administrator.
Click the Reports tab and then click Resources Report.
Select one or more projects, select one or more resources, and then specify a date range.
Click Generate Report.

+ +

+ + +

Appendix A - Manually Managing Members and Roles

+ Your Time Tracker Web site allows visitors to register as members. + Members have specific privileges defined by a role you assign to them. + A special administrative role has rights to perform all functions in the site.

+ To create a user (member):

+ To modify an existing member's role:

+ +

Appendix B - Publishing Your Site

+ When you are ready to share the Web site with others, you can copy it to your Web server. + You need to know the File Transfer Protocol (FTP) address of your server, and if required, the user name and password assigned to you.

+ + -- cgit v1.2.3