From 654a9cae43358c7eecf3b522e9876aa7815e2453 Mon Sep 17 00:00:00 2001 From: Fabio Bas Date: Mon, 7 Dec 2015 15:57:51 +0100 Subject: Move urls from pradosoft.com to github's project page; drop unmaintained quickstart tutorial translations --- .../protected/pages/Tutorial/AjaxChat.page | 2 +- .../pages/Tutorial/CurrencyConverter.page | 8 +- .../protected/pages/Tutorial/fr/AjaxChat.page | 755 --------------------- .../pages/Tutorial/fr/CurrencyConverter.page | 404 ----------- .../protected/pages/Tutorial/fr/chat1.png | Bin 10533 -> 0 bytes .../protected/pages/Tutorial/fr/chat2.png | Bin 13409 -> 0 bytes .../protected/pages/Tutorial/fr/example1.png | Bin 11139 -> 0 bytes .../protected/pages/Tutorial/fr/example2.png | Bin 13842 -> 0 bytes .../protected/pages/Tutorial/id/AddressBook.page | 8 - .../protected/pages/Tutorial/id/AjaxChat.page | 685 ------------------- .../pages/Tutorial/id/CurrencyConverter.page | 349 ---------- .../protected/pages/Tutorial/id/chat1.png | Bin 10533 -> 0 bytes .../protected/pages/Tutorial/id/chat2.png | Bin 13409 -> 0 bytes .../protected/pages/Tutorial/id/example1.png | Bin 11139 -> 0 bytes .../protected/pages/Tutorial/id/example2.png | Bin 13842 -> 0 bytes 15 files changed, 5 insertions(+), 2206 deletions(-) delete mode 100755 demos/quickstart/protected/pages/Tutorial/fr/AjaxChat.page delete mode 100755 demos/quickstart/protected/pages/Tutorial/fr/CurrencyConverter.page delete mode 100755 demos/quickstart/protected/pages/Tutorial/fr/chat1.png delete mode 100755 demos/quickstart/protected/pages/Tutorial/fr/chat2.png delete mode 100755 demos/quickstart/protected/pages/Tutorial/fr/example1.png delete mode 100755 demos/quickstart/protected/pages/Tutorial/fr/example2.png delete mode 100755 demos/quickstart/protected/pages/Tutorial/id/AddressBook.page delete mode 100755 demos/quickstart/protected/pages/Tutorial/id/AjaxChat.page delete mode 100755 demos/quickstart/protected/pages/Tutorial/id/CurrencyConverter.page delete mode 100755 demos/quickstart/protected/pages/Tutorial/id/chat1.png delete mode 100755 demos/quickstart/protected/pages/Tutorial/id/chat2.png delete mode 100755 demos/quickstart/protected/pages/Tutorial/id/example1.png delete mode 100755 demos/quickstart/protected/pages/Tutorial/id/example2.png (limited to 'demos/quickstart/protected/pages/Tutorial') diff --git a/demos/quickstart/protected/pages/Tutorial/AjaxChat.page b/demos/quickstart/protected/pages/Tutorial/AjaxChat.page index 92118720..40e283dd 100755 --- a/demos/quickstart/protected/pages/Tutorial/AjaxChat.page +++ b/demos/quickstart/protected/pages/Tutorial/AjaxChat.page @@ -22,7 +22,7 @@ that asks the user to enter their nickname and the main application chat page. You can try the application locally or at - Pradosoft.com. + Prado website. The main application chat page is shown bellow.

class="figure" />

diff --git a/demos/quickstart/protected/pages/Tutorial/CurrencyConverter.page b/demos/quickstart/protected/pages/Tutorial/CurrencyConverter.page index 1abd68b9..0beeaaf4 100755 --- a/demos/quickstart/protected/pages/Tutorial/CurrencyConverter.page +++ b/demos/quickstart/protected/pages/Tutorial/CurrencyConverter.page @@ -10,15 +10,15 @@ a dollar amount to an other currency, given the rate of that currency relative to the dollar. The completed application is shown bellow.

class="figure" /> - You can try the application locally or at - Pradosoft.com. + You can try the application locally or at the + Prado website. Notice that the application still functions exactly the same if javascript is not available on the user's browser.

Downloading and Installing Prado

To install Prado, simply download the latest version of Prado from - http://www.pradosoft.com +

To install Prado, simply download the latest version of Prado from the + Prado project website and unzip the file to a directory not accessible by your web server (you may unzip it to a directory accessible by the web server if you wish to see the demos and test). For further detailed installation, see the diff --git a/demos/quickstart/protected/pages/Tutorial/fr/AjaxChat.page b/demos/quickstart/protected/pages/Tutorial/fr/AjaxChat.page deleted file mode 100755 index 568e920f..00000000 --- a/demos/quickstart/protected/pages/Tutorial/fr/AjaxChat.page +++ /dev/null @@ -1,755 +0,0 @@ - -

Building an AJAX Chat Application

This tutorial introduces the Prado web application framework's - ActiveRecord - and Active Controls to build a Chat - web application. It is assumed that you - are familiar with PHP and you have access to a web server that is able to serve PHP5 scripts. - This basic chat application will utilize the following ideas/components in Prado. -

Building a custom User Manager class.
Authenticating and adding a new user to the database.
Using ActiveRecord to interact with the database.
Using Active Controls and callbacks to implement the user interface.
Separating application logic and application flow.

- -

In this tutorial you will build an AJAX Chat web application that allows - multiple users to communicate through their web browser. - The application consists of two pages: a login page - that asks the user to enter their nickname and the main application chat - page. - You can try the application locally or at - Pradosoft.com. - The main application chat page is shown bellow. - class="figure" /> -

- -

Download, Install and Create a New Application

The download and installation steps are similar to those in - the Currency converter tutorial. - To create the application, we run from the command line the following. - See the Command Line Tool - for more details. - -php prado/framework/prado-cli.php -c chat - -

- -

The above command creates the necessary directory structure and minimal - files (including "index.php" and "Home.page") to run a Prado web application. - Now you can point your browser's URL to the web server to serve up - the index.php script in the chat directory. - You should see the message "Welcome to Prado!" -

- -

Authentication and Authorization

The first task for this application is to ensure that each user - of the chat application is assigned with a unique (chosen by the user) - username. To achieve this, we can secure the main chat application - page to deny access to anonymous users. First, let us create the Login - page with the following code. We save the Login.php and Login.page - in the chat/protected/pages/ directory (there should be a Home.page - file created by the command line tool). -

- -<?php -class Login extends TPage -{ -} - - - - - - Prado Chat Demo Login - - -<com:TForm> - -

- Please enter your name: -

- <com:TLabel ForControl="username" Text="Username:" /> - <com:TTextBox ID="username" MaxLength="20" /> - <com:TRequiredFieldValidator - ControlToValidate="username" - Display="Dynamic" - ErrorMessage="Please provide a username." /> -

- -</com:TForm> - - - -

The login page contains - a , - a , - a - and a . The resulting - page looks like the following (after applying some a style sheet). - class="figure" /> - If you click on the Login button without entering any - text in the username textbox, an error message is displayed. This is - due to the - requiring the user to enter some text in the textbox before proceeding. -

Securing the `Home` page

Now we wish that if the user is trying to access the main application -page, Home.page, before they have logged in, the user is presented with -the Login.page first. We add a chat/protected/application.xml configuration -file to import some classes that we shall use later. - - - - - - - - - - - -Next, we add a chat/protected/pages/config.xml configuration file to -secure the pages directory. - - - - - - - - - - - - - - -We setup the authentication using the default classes as explained in the -authentication/authorization quickstart. -In the authorization definition, we allow anonymous users to access the -Login page (anonymous users is specified by the ? question mark). -We allow any users with role equal to "normal" (to be defined later) -to access all the pages, that is, the Login and Home pages. -Lastly, we deny all users without any roles to access any page. The authorization -rules are executed on first match basis. -

- -

If you now try to access the Home page by pointing your browser -to the index.php you will be redirected to the Login page. -

- -

Active Record for `chat_users` table

The -class only provides a read-only list of users. We need to be able to add or -login new users dynamically. So we need to create our own user manager class. -First, we shall setup a database with a chat_users table and create an ActiveRecord -that can work with the chat_users table with ease. For the demo, we -use sqlite as our database for ease of distributing the demo. The demo -can be extended to use other databases such as MySQL or Postgres SQL easily. -We define the chat_users table as follows. - -CREATE TABLE chat_users -( - username VARCHAR(20) NOT NULL PRIMARY KEY, - last_activity INTEGER NOT NULL DEFAULT "0" -); - -Next we define the corresponding ChatUserRecord class and save it as -chat/protected/App_Code/ChatUserRecord.php (you need to create the -App_Code directory as well). We also save the sqlite database file -as App_Code/chat.db. - -class ChatUserRecord extends TActiveRecord -{ - const TABLE='chat_users'; - - public $username; - public $last_activity; - - public static function finder($className=__CLASS__) - { - return parent::finder($className); - } -} - -Before using the ChatUserRecord class we to configure a default -database connection for ActiveRecord to function. In the chat/protected/application.xml -we import classes from the App_Code directory and add an -ActiveRecord configuration module. - - - - - - - - - - - - - - - -

- -

Custom User Manager class

To implement a custom user manager module class we just need -to extends the TModule class and implement the IUserManager -interface. The getGuestName(), getUser() and validateUser() -methods are required by the IUserManager interface. -We save the custom user manager class as App_Code/ChatUserManager.php. -

- -class ChatUserManager extends TModule implements IUserManager -{ - public function getGuestName() - { - return 'Guest'; - } - - public function getUser($username=null) - { - $user=new TUser($this); - $user->setIsGuest(true); - if($username !== null && $this->usernameExists($username)) - { - $user->setIsGuest(false); - $user->setName($username); - $user->setRoles(array('normal')); - } - return $user; - } - - public function addNewUser($username) - { - $user = new ChatUserRecord(); - $user->username = $username; - $user->save(); - } - - public function usernameExists($username) - { - $finder = ChatUserRecord::finder(); - $record = $finder->findByUsername($username); - return $record instanceof ChatUserRecord; - } - - public function validateUser($username,$password) - { - return $this->usernameExists($username); - } -} - -

-The getGuestName() -method simply returns the name for a guest user and is not used in our application. -The getUser() method returns a TUser object if the username -exists in the database, the TUser object is set with role of "normal" -that corresponds to the <authorization> rules defined in our -config.xml file.

- -

The addNewUser() and usernameExists() -method uses the ActiveRecord corresponding to the chat_users table to -add a new user and to check if a username already exists, respectively. -

- -

The next thing to do is change the config.xml configuration to use -our new custom user manager class. We simply change the <module> -configuration with id="users".

- - - - -

Authentication

To perform authentication, we just want the user to enter a unique -username. We add a - -for validate the uniqueness of the username and add an OnClick event handler -for the login button.

- -<com:TCustomValidator - ControlToValidate="username" - Display="Dynamic" - OnServerValidate="checkUsername" - ErrorMessage="The username is already taken." /> - -... - -<com:TButton Text="Login" OnClick="createNewUser" /> - -In the Login.php file, we add the following 2 methods. - -function checkUsername($sender, $param) -{ - $manager = $this->Application->Modules['users']; - if($manager->usernameExists($this->username->Text)) - $param->IsValid = false; -} - -function createNewUser($sender, $param) -{ - if($this->Page->IsValid) - { - $manager = $this->Application->Modules['users']; - $manager->addNewUser($this->username->Text); - - //do manual login - $user = $manager->getUser($this->username->Text); - $auth = $this->Application->Modules['auth']; - $auth->updateSessionUser($user); - $this->Application->User = $user; - - $url = $this->Service->constructUrl($this->Service->DefaultPage); - $this->Response->redirect($url); - } -} - -The checkUserName() method uses the ChatUserManager class -(recall that in the config.xml configuration we set the -ID of the custom user manager class as "users") to validate the username -is not taken. -

-In the createNewUser method, when the validation passes (that is, -when the user name is not taken) we add a new user. Afterward we perform -a manual login process:

First we obtain a TUser instance from -our custom user manager class using the $manager->getUser(...) method.
Using the TAuthManager we set/update the user object in the - current session data.
Then we set/update the Application's user instance with our - new user object.

-Finally, we redirect the client to the default Home page. -

- -

Default Values for ActiveRecord

If you try to perform a login now, you will receive an error message like -"Property 'ChatUserRecord::$last_activity' must not be null as defined -by column 'last_activity' in table 'chat_users'.". This means that the $last_activity -property value was null when we tried to insert a new record. We need to either -define a default value in the corresponding column in the table and allow null values or set the default -value in the ChatUserRecord class. We shall demonstrate the later by -altering the ChatUserRecord with the addition of a set getter/setter -methods for the last_activity property. - - -private $_last_activity; - -public function getLast_Activity() -{ - if($this->_last_activity === null) - $this->_last_activity = time(); - return $this->_last_activity; -} - -public function setLast_Activity($value) -{ - $this->_last_activity = $value; -} - -Notice that we renamed $last_activity to $_last_activity (note -the underscore after the dollar sign). -

- -

Main Chat Application

Now we are ready to build the main chat application. We use a simple -layout that consist of one panel holding the chat messages, one panel -to hold the users list, a textarea for the user to enter the text message -and a button to send the message. - - - - - Prado Chat Demo - - - -<com:TForm> -

Prado Chat Demo

- <com:TPlaceHolder ID="messageList" /> -

- <com:TPlaceHolder ID="userList" /> -

- <com:TActiveTextBox ID="userinput" - Columns="40" Rows="2" TextMode="MultiLine" /> - <com:TActiveButton ID="sendButton" CssClass="send-button" - Text="Send" /> -

-</com:TForm> - - - -We added two Active Control components: a - -and a -. -We also added a - -that will be very useful for understanding how the Active Controls work. -

- -

Exploring the Active Controls

We should have some fun before we proceeding with setting up the chat buffering. We want -to see how we can update the current page when we receive a message. First, we add -an OnClick event handler for the Send button. - - -<com:TActiveButton ID="sendButton" CssClass="send-button" - Text="Send" OnClick="processMessage"/> - -And the corresponding event handler method in the Home.php class (we -need to create this new file too). - -class Home extends TPage -{ - function processMessage($sender, $param) - { - echo $this->userinput->Text; - } -} - -If you now type something in the main application textbox and click the send button -you should see whatever you have typed echoed in the TJavascriptLogger console. -

- -

To append or add some content to the message list panel, we need to use -some methods in the - -class which is available through the CallbackClient property of the -current TPage object. For example, we do can do - -function processMessage($sender, $param) -{ - $this->CallbackClient->appendContent("messages", $this->userinput->Text); -} - -This is one way to update some part of the existing page during a callback (AJAX style events) -and will be the primary way we will use to implement the chat application. -

- -

Active Record for `chat_buffer` table

To send a message to all the connected users we need to buffer or store -the message for each user. We can use the database to buffer the messages. The -chat_buffer table is defined as follows. - -CREATE TABLE chat_buffer -( - id INTEGER PRIMARY KEY, - for_user VARCHAR(20) NOT NULL, - from_user VARCHAR(20) NOT NULL, - message TEXT NOT NULL, - created_on INTEGER NOT NULL DEFAULT "0" -); - -The corresponding ChatBufferRecord class is saved as -App_Code/ChatBufferRecord.php. - - -class ChatBufferRecord extends TActiveRecord -{ - const TABLE='chat_buffer'; - - public $id; - public $for_user; - public $from_user; - public $message; - private $_created_on; - - public function getCreated_On() - { - if($this->_created_on === null) - $this->_created_on = time(); - return $this->_created_on; - } - - public function setCreated_On($value) - { - $this->_created_on = $value; - } - - public static function finder($className=__CLASS__) - { - return parent::finder($className); - } -} - -

- -

Chat Application Logic

We finally arrive at the guts of the chat application logic. First, we -need to save a received message into the chat buffer for all the -current users. We add this logic in the ChatBufferRecord class. - - -public function saveMessage() -{ - foreach(ChatUserRecord::finder()->findAll() as $user) - { - $message = new self; - $message->for_user = $user->username; - $message->from_user = $this->from_user; - $message->message = $this->message; - $message->save(); - if($user->username == $this->from_user) - { - $user->last_activity = time(); //update the last activity; - $user->save(); - } - } -} - -We first find all the current users using the ChatUserRecord finder -methods. Then we duplicate the message and save it into the database. In addition, -we update the message sender's last activity timestamp. The above piece of code -demonstrates the simplicity and succinctness of using ActiveRecords for simple database designs. -

- -

The next piece of the logic is to retrieve the users' messages from the buffer. -We simply load all the messages for a particular username and format that message -appropriately (remember to escape the output to prevent Cross-Site Scripting attacks). -After we load the messages, we delete those loaded messages and any older -messages that may have been left in the buffer. -

- -public function getUserMessages($user) -{ - $content = ''; - foreach($this->findAll('for_user = ?', $user) as $message) - $content .= $this->formatMessage($message); - $this->deleteAll('for_user = ? OR created_on < ?', - $user, time() - 300); //5 min inactivity - return $content; -} - -protected function formatMessage($message) -{ - $user = htmlspecialchars($message->from_user); - $content = htmlspecialchars($message->message); - return "

{$user}:" - ." {$content}

"; -} - - -To retrieve a list of current users (formatted), we add this logic to the -ChatUserRecord class. We delete any users that may have been inactive -for awhile. - -public function getUserList() -{ - $this->deleteAll('last_activity < ?', time()-300); //5 min inactivity - $content = '

'.htmlspecialchars($user->username).'

'; - return $content; -} - - -

Note: -For simplicity -we formatted the messages in these Active Record classes. For large applications, -these message formatting tasks should be done using Prado components (e.g. using -a TRepeater in the template or a custom component). -

- -

Putting It Together

Now comes to put the application flow together. In the Home.php we update -the Send buttons OnClick event handler to use the application -logic we just implemented. - -function processMessage($sender, $param) -{ - if(strlen($this->userinput->Text) > 0) - { - $record = new ChatBufferRecord(); - $record->message = $this->userinput->Text; - $record->from_user = $this->Application->User->Name; - $record->saveMessage(); - - $this->userinput->Text = ''; - $messages = $record->getUserMessages($this->Application->User->Name); - $this->CallbackClient->appendContent("messages", $messages); - $this->CallbackClient->focus($this->userinput); - } -} - -We simply save the message to the chat buffer and then ask for all the messages -for the current user and update the client side message list using a callback -response (AJAX style). -

- -

At this point the application is actually already functional, just not very -user friendly. If you open two different browsers, you should be able to communicate -between the two users whenever the Send button is clicked. -

- -

The next part is perhaps the more tricker and fiddly than the other tasks. We -need to improve the user experience. First, we want a list of current users -as well. So we add the following method to Home.php, we can call -this method when ever some callback event is raised, e.g. when the Send -button is clicked. - -protected function refreshUserList() -{ - $lastUpdate = $this->getViewState('userList',''); - $users = ChatUserRecord::finder()->getUserList(); - if($lastUpdate != $users) - { - $this->CallbackClient->update('users', $users); - $this->setViewstate('userList', $users); - } -} - -

- -

Actually, we want to periodically update the messages and user list as new -users join in and new message may arrive from other users. So we need to refresh -the message list as well.

- -function processMessage($sender, $param) -{ - ... - $this->refreshUserList(); - $this->refreshMessageList(); - ... -} - -protected function refreshMessageList() -{ - //refresh the message list - $finder = ChatBufferRecord::finder(); - $content = $finder->getUserMessages($this->Application->User->Name); - if(strlen($content) > 0) - { - $anchor = (string)time(); - $content .= " "; - $this->CallbackClient->appendContent("messages", $content); - $this->CallbackClient->focus($anchor); - } -} - -The anchor using time() as ID for a focus point is so that when the -message list on the client side gets very long, the focus method will -scroll the message list to the latest message (well, it works in most browsers). -

- -

Next, we need to redirect the user back to the login page if the user has -been inactive for some time, say about 5 mins, we can add this check to any stage -of the page life-cycle. Lets add it to the onLoad() stage. - -public function onLoad($param) -{ - $username = $this->Application->User->Name; - if(!$this->Application->Modules['users']->usernameExists($username)) - { - $auth = $this->Application->Modules['auth']; - $auth->logout(); - - //redirect to login page. - $this->Response->Redirect($this->Service->ConstructUrl($auth->LoginPage)); - } -} - -

- -

Improving User Experience

The last few details are to periodically check for new messages and -refresh the user list. We can accomplish this by polling the server using a - -control. We add a TTimeTriggeredCallback to the Home.page -and call the refresh handler method defined in Home.php. -We set the polling interval to 2 seconds. - -<com:TTimeTriggeredCallback OnCallback="refresh" - Interval="2" StartTimerOnLoad="true" /> - - -function refresh($sender, $param) -{ - $this->refreshUserList(); - $this->refreshMessageList(); -} - -

- -

The final piece requires us to use some javascript. We want that when the -user type some text in the textarea and press the Enter key, we want it -to send the message without clicking on the Send button. We add to the -Home.page some javascript. - - -<com:TClientScript> -Event.observe($("<%= $this->userinput->ClientID %>"), "keypress", function(ev) -{ - if(Event.keyCode(ev) == Event.KEY_RETURN) - { - if(Event.element(ev).value.length > 0) - new Prado.Callback("<%= $this->sendButton->UniqueID %>"); - Event.stop(ev); - } -}); -</com:TClientScript> - -Details regarding the javascript can be explored in the -Introduction to Javascript section of the quickstart. -

- -

This completes the tutorial on making a basic chat web application using -the Prado framework. Hope you have enjoyed it. -

- - diff --git a/demos/quickstart/protected/pages/Tutorial/fr/CurrencyConverter.page b/demos/quickstart/protected/pages/Tutorial/fr/CurrencyConverter.page deleted file mode 100755 index 6b8c7bc3..00000000 --- a/demos/quickstart/protected/pages/Tutorial/fr/CurrencyConverter.page +++ /dev/null @@ -1,404 +0,0 @@ - -

Building a Simple Currency Converter

This tutorial introduces the Prado web application framework and teaches - you how to build a simple web application in a few simple steps. This - tutorial assumes that you are familiar with PHP and you have access - to a web server that is able to serve PHP5 scripts. -

- -

In this tutorial you will build a simple web application that converts - a dollar amount to an other currency, given the rate of that currency - relative to the dollar. The completed application is shown bellow. - class="figure" /> - You can try the application locally or at - Pradosoft.com. - Notice that the application still functions exactly the same if javascript - is not available on the user's browser. -

- -

Downloading and Installing Prado

To install Prado, simply download the latest version of Prado from - http://www.pradosoft.com - and unzip the file to a directory not accessible by your web server - (you may unzip it to a directory accessible by the web server if you wish - to see the demos and test). For further detailed installation, see the - Quickstart Installation guide. -

- -

Creating a new Prado web Application

The quickest and simplest way to create a new Prado web application is - to use the command tool prado-cli.php found in the framework - directory of the Prado distribution. We create a new application by running - the following command in your - command prompt or console. The command creates a new directory named - currency-converter in your current working directory. - You may need to change to the appropriate directory - first. - See the Command Line Tool - for more details. -

- -php prado/framework/prado-cli.php -c currency-converter - - -

The above command creates the necessary directory structure and minimal - files (including "index.php" and "Home.page") to run a Prado web application. - Now you can point your browser's url to the web server to serve up - the index.php script in the currency-converter directory. - You should see the message "Welcome to Prado!" -

- -

Creating the Currency Converter User Interface

We start by editing the Home.page file found in the - currency-converter/protected/pages/ directory. Files ending - with ".page" are page templates that contains HTML and Prado controls. - We simply add two textboxes, three labels and one button as follows. -

- -<com:TForm> -

- Currency Converter -

- <com:TLabel ForControl="currencyRate" Text="Exchange Rate per $1:" /> - <com:TTextBox ID="currencyRate" /> -

- <com:TLabel ForControl="dollars" Text="Dollars to Convert:" /> - <com:TTextBox ID="dollars" /> -

- Amount in Other Currency: - <com:TLabel ID="total" CssClass="result" /> -

- <com:TButton Text="Convert" /> -

-</com:TForm> - -

- If you refresh the page, you should see something similar to the following figure. - It may not look very pretty or orderly, but we shall change that later using CSS. - class="figure" /> -

- -

- The first component we add is a - - that basically corresponds to the HTML <form> element. - In Prado, only one TForm element is allowed per page. -

- -

The next two pair of component we add is the - - and - - that basically defines a label and a textbox for the user of the application - to enter the currency exchange rate. - The ForControl property value determines which component - that the label is for. This allows the user of the application to click - on the label to focus on the field (a good thing). You could have used - a plain HTML <label> element to do the same thing, but - you would have to find the correct ID of the textbox (or - <input> in HTML) as Prado components may/will render the - ID value differently in the HTML output. -

- -

The next pair of components are similar and defines the textbox - to hold the dollar value to be converted. - The TLabel with ID value "total" defines a simple label. - Notice that the ForControl property is absent. This means that this - label is simply a simple label which we are going to use to display the - converted total amount. -

- -

The final component is a - - that the user will click to calculate the results. The Text - property sets the button label. -

- -

Implementing Currency Conversion

- -

If you tried clicking on the "Convert" button then the page will refresh - and does not do anything else. For the button to do some work, we need - to add a "Home.php" to where "Home.page" is. The Home class - should extends the - , the default base - class for all Prado pages. -

- -<?php -class Home extends TPage -{ - -} - -

- Prado uses PHP's __autoload method to load classes. The convention - is to use the class name with ".php" extension as filename. -

- -

So far there is nothing interesting about Prado, we just declared some - "web components" in some template file named Home.page and created - a "Home.php" file with a Home class. The more interesting - bits are in Prado's event-driven architecture as we shall see next. -

- -

We want that when the user click on the "Convert" button, we take the - values in the textbox, do some calculation and present the user with - the converted total. To handle the user clicking of the "Convert" button - we simply add an OnClick property to the "Convert" button in - the "Home.page" template and add a corresponding event handler method - in the "Home.php". -

- -<com:TButton Text="Convert" OnClick="convert_clicked" /> - -

- The value of the OnClick, "convert_clicked", will be the method - name in the "Home.php" that will called when the user clicks on the - "Convert" button. -

- -class Home extends TPage -{ - public function convert_clicked($sender, $param) - { - $rate = floatval($this->currencyRate->Text); - $dollars = floatval($this->dollars->Text); - $this->total->Text = $rate * $dollars; - } -} - -

- If you run the application in your web browser, enter some values and click - the "Convert" button then you should see that calculated value displayed next - to the "Amount in Other Currency" label. -

- -

In the "convert_clicked" method the first parameter, $sender, - corresponds to the object that raised the event, in this case, - the "Convert" button. The second parameter, $param contains - any additional data that the $sender object may wish to have added. -

- -

We shall now examine, the three lines that implements the simply currency - conversion in the "convert_clicked" method. -

- -$rate = floatval($this->currencyRate->Text); - -

- The statement $this->currencyRate corresponds to the - TTextBox component with ID value "currencyRate" in the - "Home.page" template. The Text property of the TTextBox - contains the value that the user entered. So, we obtain this - value by $this->currencyRate->Text which we convert the - value to a float value. -

- -$dollars = floatval($this->dollars->Text); - -

- The next line does a similar things, it takes the user value from - the TTextBox with ID value "dollars and converts it to - a float value. -

- -

The third line calculates the new amount and set this value in the - Text property of the TLabel with ID="total". - Thus, we display the new amount to the user in the label. -

- -$this->total->Text = $rate * $dollars; - - -

Adding Validation

The way we convert the user entered value to float ensures that the - total amount is always a number. So the user is free to enter what - ever they like, they could even enter letters. The user's experience - in using the application can be improved by adding validators - to inform the user of the allowed values in the currency rate and the - amount to be calcuated. -

- -

For the currency rate, we should ensure that

the user enters a value,
the currency rate is a valid number,
the currency rate is positive.

- To ensure 1 we add one - . To ensure 2 and 3, we add one - . We may add these validators any where within - the "Home.page" template. Further details regarding these validator and other - validators can be found in the - Validation Controls page. -

- -<com:TRequiredFieldValidator - ControlToValidate="currencyRate" - ErrorMessage="Please enter a currency rate." /> -<com:TCompareValidator - ControlToValidate="currencyRate" - DataType="Float" - ValueToCompare="0" - Operator="GreaterThan" - ErrorMessage="Please enter a positive currency rate." /> - - -

For the amount to be calculated, we should ensure that

the user enters a value,
the value is a valid number (not including any currency or dollar signs).

- To ensure 1 we just add another TRequiredFieldValidator, for 2 - we could use a - . For simplicity we only allow the user to enter - a number for the amount they wish to convert. -

- -<com:TRequiredFieldValidator - ControlToValidate="dollars" - ErrorMessage="Please enter the amount you wish to calculate." /> -<com:TDataTypeValidator - ControlToValidate="dollars" - DataType="Float" - ErrorMessage="Please enter a number." /> - -

- -

Now if you try to enter some invalid data in the application or left out - any of the fields the validators will be activated and present the user - with error messages. Notice that the error messages are presented - without reloading the page. Prado's validators by default validates - using both javascript and server side. The server side validation - is always performed. For the server side, we - should skip the calculation if the validators are not satisfied. This can - done as follows. -

- -public function convert_clicked($sender, $param) -{ - if($this->Page->IsValid) - { - $rate = floatval($this->currencyRate->Text); - $dollars = floatval($this->dollars->Text); - $this->total->Text = $rate * $dollars; - } -} - - -

Improve User Experience With Active Controls

In this simple application we may further improve the user experience - by increasing the responsiveness of the application. One way to achieve - a faster response is calculate and present the results without reloading - the whole page. -

- -

We can replace the TButton with the Active Control counter part, - , - that can trigger a server side click event without reloading the page. - In addition, we can change the "totals" TLabel with the - Active Control counter part, - , such that the server side can update the browser without - reloading the page. -

- -

- Amount in Other Currency: - <com:TActiveLabel ID="total" CssClass="result" /> -

- <com:TActiveButton Text="Convert" OnClick="convert_clicked" /> -

- -

- The server side logic remains the same, we just need to import the - Active Controls name space as they are not included by default. We - add the following line to the begin of "Home.php". -

- -Prado::using('System.Web.UI.ActiveControls.*'); - - -

If you try the application now, you may notice that the page no longer - needs to reload to calculate and display the converted total amount. - However, since there is not page reload, there is no indication or not obvious - that by clicking on the "Convert" button any has happened. - We can further refine the user experience by change the text of "total" label - to "calculating..." when the user clicks on the "Convert" button. The text of - the "total" label will still be updated with the new calculate amount as before. -

- -

To indicate that the calculation is in progress, we can change the text - of the "total" label as follows. We add a ClientSide.OnLoading property - to the "Convert" button (since this button is responsible for requesting - the calculation). -

- -<com:TActiveButton Text="Convert" OnClick="convert_clicked" > - <prop:ClientSide.OnLoading> - $('<%= $this->total->ClientID %>').innerHTML = "calculating..." - </prop:ClientSide.OnLoading> -</com:TActiveButton> - - -

The ClientSide.OnLoading and various - accept a javascript block as their content or value. - The javascript code $('...') is a javascript function that is - equivalent to document.getElementById('...') that takes a string - with the ID of an HTML element. Since Prado renders its components's IDs, we need - to use the rendered ID of the "total" label, that is, $this->total->ClientID. We place this bit of code within a <%= %> to obtain the rendered HTML ID for the "total" label. The rest of the - javascript code innerHTML = "calculating..." simply changes - the content of the "total" label. -

- -

Adding Final Touches

So far we have built a simple currency converter web application with - little attention of the looks and feel. Now we can add a stylesheet - to improve the overall appearance of the application. We can simply - add the stylesheet inline with the template code or we may create - a "theme". -

- -

To create and use a theme with Prado applications, we simply create a new - directory "themes/Basic" in the currency-converter directory. - You may need to create the themes directory first. Any - directory within the themes are considered as a theme with the - name of the theme being the directory name. See the - Themes and Skins for further details. -

- -

We simply create a CSS file named "common.css" and save it in the - themes/Basic directory. Then we add the following code - to the beginning of "Home.page" (we add a little more HTML as well). -

- -<%@ Theme="Basic" %> - - -<com:THead Title="Currency Converter" /> - - -

- The first line <%@ Theme="Basic" %> defines the - theme to be used for this page. The - - corresponds to the HTML <head> element. In addition - to display the Title property by the THead, all CSS - files in the themes/Basic directory are also rendered/linked - for the current page. Our final currency converter web application - looks like the following. - class="figure" /> - This completes introduction tutorial to the Prado web application framework. -

- diff --git a/demos/quickstart/protected/pages/Tutorial/fr/chat1.png b/demos/quickstart/protected/pages/Tutorial/fr/chat1.png deleted file mode 100755 index 8288b496..00000000 Binary files a/demos/quickstart/protected/pages/Tutorial/fr/chat1.png and /dev/null differ diff --git a/demos/quickstart/protected/pages/Tutorial/fr/chat2.png b/demos/quickstart/protected/pages/Tutorial/fr/chat2.png deleted file mode 100755 index 97cbc51d..00000000 Binary files a/demos/quickstart/protected/pages/Tutorial/fr/chat2.png and /dev/null differ diff --git a/demos/quickstart/protected/pages/Tutorial/fr/example1.png b/demos/quickstart/protected/pages/Tutorial/fr/example1.png deleted file mode 100755 index 0c7da7ba..00000000 Binary files a/demos/quickstart/protected/pages/Tutorial/fr/example1.png and /dev/null differ diff --git a/demos/quickstart/protected/pages/Tutorial/fr/example2.png b/demos/quickstart/protected/pages/Tutorial/fr/example2.png deleted file mode 100755 index 1df56cfb..00000000 Binary files a/demos/quickstart/protected/pages/Tutorial/fr/example2.png and /dev/null differ diff --git a/demos/quickstart/protected/pages/Tutorial/id/AddressBook.page b/demos/quickstart/protected/pages/Tutorial/id/AddressBook.page deleted file mode 100755 index 3e930df1..00000000 --- a/demos/quickstart/protected/pages/Tutorial/id/AddressBook.page +++ /dev/null @@ -1,8 +0,0 @@ - -

Buku Alamat Sederhana

Tutorial ini memperkenalkan dasar penyambungan ke sebuah database - menggunakan ActiveRecord - dan menggunakan Kerangka Rekaman Aktif untuk secara cepat membangun sebuah buku alamat sederhana. -

- - \ No newline at end of file diff --git a/demos/quickstart/protected/pages/Tutorial/id/AjaxChat.page b/demos/quickstart/protected/pages/Tutorial/id/AjaxChat.page deleted file mode 100755 index 50759868..00000000 --- a/demos/quickstart/protected/pages/Tutorial/id/AjaxChat.page +++ /dev/null @@ -1,685 +0,0 @@ - -

Membangun Aplikasi Obrolan AJAX

- -

Tutorial ini memperkenalkan kerangka kerja aplikasi web Prado - ActiveRecord - dan Kontrol Aktif untuk membangun aplikasi web Chat. Diasumsikan bahwa Anda sudah terbiasa dengan PHP dan akan telah mengakses server web yang dapat melayani naskah PHP5. - Aplikasi chat dasar ini akan memanfaatkan ide/komponen berikut dalam Prado. -

Membangun kelas kustom Manajer Pengguna.
Mengotentikasi dan menambahkan pengguna ke database.
Menggunakan ActiveRecord untuk berinteraksi dengan database.
Menggunakan Kontrol Aktif dan callbacks untuk menerapkan antarmuka pengguna.
Memisahkan logika aplikasi dan alur aplikasi.

- -

Dalam tutorial ini Anda akan membangun sebuah aplikasi web Chat AJAX yang membolehkan - multipel pengguna untuk berkomunikasi melalui web browser mereka. - Aplikasi terdiri dari dua halaman: halaman masuk yang menanyakan pada - pengguna untuk memasukkan nama panggilannya dan halaman aplikasi chat utama. - Anda dapat mencoba aplikasi secara lokal atau di - Pradosoft.com. - Aplikasi chat utama ditampilkan di bawah ini. - class="figure" /> -

- -

Download, Instalasi dan Buat Aplikasi Baru

Langkah download dan instalasi mirip dengan - Tutorial pengubah kurs. - Untuk membuat aplikasi, kita menjalankan dari baris perintah berikut. - Lihat Piranti Baris Perintah - untuk lebih jelasnya. - -php prado/framework/prado-cli.php -c chat - -

- -

Perintah di atas membuat struktur direktori yang diperlukan dan file minimal (termasuk "index.php" dan "Home.page") untuk menjalankan aplikasi web Prado. - Sekarang Anda dapat mengarahkan URL browser Anda ke server web untuk melayani - naskah index.php dalam direktori chat. - Anda seharusnya melihat pesan "Welcome to Prado!" -

- -

Otentikasi dan Otorisasi

Tugas pertama untuk aplikasi ini adalah memastikan bahwa setiap pengguna - dari aplikasi chat memiliki nama pengguna (dipilih oleh pengguna) - unik. Untuk melaksanakan ini, kita akan mengamankan halaman aplikasi chat utama - untuk menolak akses bagai pengguna anonim. Pertama, mari kita membuat halaman Login - dengan kode berikut. Kita simpan Login.php dan Login.page - dalam direktori chat/protected/pages/ (di sana harus ada file Home.page - yang dibuat oleh piranti baris perintah). -

- -<?php -class Login extends TPage -{ -} - - - - - - Prado Chat Demo Login - - -<com:TForm> - -

- Please enter your name: -

- -</com:TForm> - - - -

Halaman login berisi - a , - a , - a - dan . Halaman yang dihasilkan terlihat seperti berikut (setelah menerapkan beberapa style sheet). - class="figure" /> - Jika Anda mengklik pada tombol Login tanpa memasukan teks - apapun dalam kotak teks nama pengguna, pesan kesalahan ditampilkan. Ini dikarenakan - memerlukan pengguna untuk memasukan beberapa teks dalam kotak teks sebelum melanjutkan. -

Mengamankan halaman `Home`

Sekarang kita menginginkan bahwa jika pengguna mencoba untuk mengakses halaman aplikasi utama, Home.page, sebelum masuk, pengguna diberi Login.page lebih dulu. Kita menambahkan file konfigurasi chat/protected/application.xml untuk mengimpor beberapa kelas yang harus kita pakai nanti. - - - - - - - - - - - -Selanjutnya, kita menambahkan file konfigurasi chat/protected/pages/config.xml guna mengamankan direktori pages. - - - - - - - - - - - - - - -Kita menyiapkan otentikasi menggunakan kelas standar seperti dijelaskan dalam -tutorial cepat otentikasi/otorisasi. -Dalam definisi otorisasi, kita membolehkan pengguna anonim untuk mengakses halaman Login (pengguna anonim dietapkan dengan the ? tanda tanya). -Kita membolehkan setiap pengguna dengan aturan yang sama dengan "normal" (didefinisikan nanti) untuk mengakses semua halaman, yakni halaman Login dan Home. -Terakhir, kita menolak semua pengguna tanpa aturan apapun untuk mengakses setiap halaman. Aturan otorisasi dijalankan pada basis sama pertama kali. -

- -

Jika Anda mencoba untuk mengakses halaman Home dengan mengarahkan browser Anda ke -index.php Anda akan dialihkan ke halaman Login. -

- -

Rekaman Aktif untuk tabel `chat_users`

Kelas -hanya menyediakan daftar pengguna hanya-baca. Kita perlu untuk bisa menambah atau memasukan pengguna baru secara dinamis. Maka kita perlu untuk membuat kelas manajer pengguna kita sendiri. -Pertama, kita menyiapkan database dengan tabel chat_users dan membuat sebuah ActiveRecord yang dapat bekerja pada tabel chat_users dengan mudah. Untuk demo, kita menggunakan sqlite sebagai database kita guna kemudahan menditribusikandemo. Demo dapat diperluas dengan mudah untuk memakai database lain seperti MySQL atau Postgres SQL. -Kita mendefinisikan tabel chat_users sebagai berikut. - -CREATE TABLE chat_users -( - username VARCHAR(20) NOT NULL PRIMARY KEY, - last_activity INTEGER NOT NULL DEFAULT "0" -); - -Selanjutnya kita mendefinisikan kelas ChatUserRecord dan menyimpannya sebagai chat/protected/App_Code/ChatUserRecord.php (Anda perlu untuk membuat direktori App_Code juga). Kita juga menyimpan file database sqlite sebagai App_Code/chat.db. - -class ChatUserRecord extends TActiveRecord -{ - const TABLE='chat_users'; - - public $username; - public $last_activity; - - public static function finder($className=__CLASS__) - { - return parent::finder($className); - } -} - -Sebelum menggunakan kelas ChatUserRecord kita perlu mengkonfigurasi koneksi database standar agar ActiveRecord berfungsi. Dalam chat/protected/application.xml -kita mengimpor kelas dari direktori App_Code dan menambahkan -modul konfigurasi ActiveRecord. - - - - - - - - - - - - - - - -

- -

Kelas Manajer Pengguna Kustom

Untuk menerapkan modul kelas kustom manajer pengguna kita cukup memperluas kelas TModule dan menerapkan antarmuka IUserManager. Metode getGuestName(), getUser() dan validateUser() diperlukan oleh antarmuka IUserManager. -Kita menyimpan kelas manajer pengguna kustom sebagai App_Code/ChatUserManager.php. -

-Metode getGuestName() -mengembalikan nama untuk pengguna tamu dan tidak dipakai dalam aplikasi kita. -Metode getUser() mengembalikan obyek TUser jika nama pengguna ada dalam database, obyek TUser disetel dengan aturan "normal" -yang terkait ke aturan <otorisasi> yang didefinisikan dalam file -config.xml kita.

- -

Metode addNewUser() dan usernameExists() -menggunakan ActiveRecord terkait dengan tabel chat_users masing-masing untuk menambah pengguna baru dan untuk memeriksa apakah nama pengguna sudah ada atau belum. -

- -

Hal berikutnya yang dilakukan adalah mengubah konfigurasi config.xml untuk menggunakan kelas manajer pengguna kustom baru kita. Kita cukup mengubah konfigurasi <module> -dengan id="users".

- - - - -

Otentikasi

Untuk melakukan otentikasi, kita menginginkan pengguna untuk memasukkan nama pengguna unik. Kita menambahkan - -untuk memvalidasi keunikan nama pengguna dan menambahkan pengendali event OnClick untuk tombol login.

- -<com:TCustomValidator - ControlToValidate="username" - Display="Dynamic" - OnServerValidate="checkUsername" - ErrorMessage="The username is already taken." /> - -... - -<com:TButton Text="Login" OnClick="createNewUser" /> - -Dalam file Login.php, kita menambahkan 2 metode berikut. - -function checkUsername($sender, $param) -{ - $manager = $this->Application->Modules['users']; - if($manager->usernameExists($this->username->Text)) - $param->IsValid = false; -} - -function createNewUser($sender, $param) -{ - if($this->Page->IsValid) - { - $manager = $this->Application->Modules['users']; - $manager->addNewUser($this->username->Text); - - //do manual login - $user = $manager->getUser($this->username->Text); - $auth = $this->Application->Modules['auth']; - $auth->updateSessionUser($user); - $this->Application->User = $user; - - $url = $this->Service->constructUrl($this->Service->DefaultPage); - $this->Response->redirect($url); - } -} - -Metode checkUserName() menggunakan kelas ChatUserManager -(ingat bahwa dalam konfigurasi config.xml kita menyetel ID dari kelas manajer pengguna kustom sebagai "users") untuk memvalidasi nama pengguna belum dipakai. -

-Dalam metode createNewUser, Ketika validasi lulus (yaitu ketika nama pengguna belum dipakai) kita menambahkan pengguna baru. Setelah itu kita melakukan proses login secara manual:

Pertama kita peroleh turunan TUser dari kelas manajer -pengguna kita menggunakan metode $manager->getUser(...).
Menggunakan TAuthManager kita menetapkan/memutakhirkan obyek pengguna dalam data sesi saat ini.
Kemudian kita menetapkan/memutakhirkan turunan APlikasi pengguna dengan obyek pengguna baru kita.

-Akhirnya, kita mengalihkan klien ke halaman standar Home. -

- -

Nilai Standar untuk ActiveRecord

Jika Anda mencoba untuk melakukan login sekarang, Anda akan menerima pesan kesalahan seperti -"Property 'ChatUserRecord::$last_activity' must not be null as defined -by column 'last_activity' in table 'chat_users'.". Ini berarti bahwa nilai properti $last_activity adalah null dalam kolom terkait pada tabel dan memboleh nilai null atau menetapkan nilai standar dalam kelas ChatUserRecord. Kita akan mendemonstrasikannya nanti dengan mengubah ChatUserRecord dengan tambahan dari metode setelan pengambil/pengetap untuk properti last_activity. - - -private $_last_activity; - -public function getLast_Activity() -{ - if($this->_last_activity === null) - $this->_last_activity = time(); - return $this->_last_activity; -} - -public function setLast_Activity($value) -{ - $this->_last_activity = $value; -} - -Catatan bahwa kita mengganti nama $last_activity menjadi $_last_activity (perhatikan garis bawah setelah tanda dolar). -

- -

Aplikasi Chat Utama

Sekarang kita siap untuk membangun aplikasi chat utama. Kita menggunakan tata letak sederhana yang terdiri dari satu panel yang menampung pesan chat, satu panel untuk menampung daftar pengguna, area teks untuk pengguna memasukan pesan teks dan tombol untuk mengirimkan pesan. - - - - - Prado Chat Demo - - - -<com:TForm> -

Prado Chat Demo

- <com:TPlaceHolder ID="messageList" /> -

- <com:TPlaceHolder ID="userList" /> -

- <com:TActiveTextBox ID="userinput" - Columns="40" Rows="2" TextMode="MultiLine" /> - <com:TActiveButton ID="sendButton" CssClass="send-button" - Text="Send" /> -

-</com:TForm> -<com:TJavascriptLogger /> - - - -Kita menambahkan dua komponen Kontrol Aktif: a - -dan -. -Kita juga menambahkan - -yang akan sangat berguna untuk mengerti bagaimana Kontrol Aktif bekerja. -

- -

Menjelajah Kontrol Aktif

Kita sudah mempunyai beberapa kesenangan sebelum kita melanjutkan dengan penyiapan bufer chat. Kita ingin melihat bagaimana kita dapat memutakhirkan halaman saat ini ketika kita menerima sebuah pesan. Pertama, kita menambahkan sebuah tombol -OnClick event handler for the Send. - - -<com:TActiveButton ID="sendButton" CssClass="send-button" - Text="Send" OnClick="processMessage"/> - -Dan metode pengendali event terkait dalam kelas Home.php (kita perlu untuk membuat file baru ini juga). - -class Home extends TPage -{ - function processMessage($sender, $param) - { - echo $this->userinput->Text; - } -} - -Jika Anda sekarang mengetikan sesuatu dalam kotak teks aplikasi utama dan mengklik tombol kirim, Anda seharusnya melihat apapun yang Anda ketikan muncul dalam konsol TJavascriptLogger. -

- -

Untuk menambah atau menambahkan beberapa konten ke panel daftar pesan, kita perlu memakai beberapa metode dalam kelas - -yang tersedia melalui properti CallbackClient property dari obyek TPage saat ini. Sebagai contoh, kita kita dapat melakukan - -function processMessage($sender, $param) -{ - $this->CallbackClient->appendContent("messages", $this->userinput->Text); -} - -Ini adalah satu cara untuk memutakhirkan beberapa bagian dari halaman yang sudah ada selama callback (AJAX style event) dan akan menjadi cara utama yang akan kita gunakan untuk menerapkan aplikasi chat. -

- -

Rekaman Aktif untuk tabel `chat_buffer`

Untuk mengirimkan pesan ke seluruh pengguna yang tersambung kita memerlukan bufer atau menyimpan pesan untuk setiap pengguna. Kita dapat menggunakan database untuk membufer pesan. Tabel -chat_buffer didefinisikan sebagai berikut. - -CREATE TABLE chat_buffer -( - id INTEGER PRIMARY KEY, - for_user VARCHAR(20) NOT NULL, - from_user VARCHAR(20) NOT NULL, - message TEXT NOT NULL, - created_on INTEGER NOT NULL DEFAULT "0" -); - -Kelas ChatBufferRecord terkait disimpan sebagai -App_Code/ChatBufferRecord.php. - - -class ChatBufferRecord extends TActiveRecord -{ - const TABLE='chat_buffer'; - - public $id; - public $for_user; - public $from_user; - public $message; - private $_created_on; - - public function getCreated_On() - { - if($this->_created_on === null) - $this->_created_on = time(); - return $this->_created_on; - } - - public function setCreated_On($value) - { - $this->_created_on = $value; - } - - public static function finder($className=__CLASS__) - { - return parent::finder($className); - } -} - -

- -

Logika Aplikasi Chat

Akhirnya kita tiba di kanal logika aplikasi chat. Pertama, kita perlu menyimpan pesan yang diterima ke dalam bufer chat untuk semua pengguna saat ini. Kita menambahkan logika ini dalam kelas ChatBufferRecord. - - -public function saveMessage() -{ - foreach(ChatUserRecord::finder()->findAll() as $user) - { - $message = new self; - $message->for_user = $user->username; - $message->from_user = $this->from_user; - $message->message = $this->message; - $message->save(); - if($user->username == $this->from_user) - { - $user->last_activity = time(); //update the last activity; - $user->save(); - } - } -} - -Terlebih dahulu kita mencari semua pengguna saat ini menggunkan metode penemu ChatUserRecord. Kemudian kita gandakan pesan dan menyompannya ke dalam database. Sebagai tambahan, kita mutakhirkan cap waktu aktivitas terakhir pengirim pesan. Kode di atas memperlihatkan kesederhanaan dan keringkasan dari penggunaan ActiveRecords untuk desain database sederhana. -

- -

Logika berikutnya adalah untuk mengambil pesan pengguna dari bufer. -Kita cukup mengambil semua pesan untuk nama pengguna tertentu dan membentuk pesan itu secar benar (ingat untuk meng-escape output guna menghindari serangan Penaskahan Situs-Silang). -Setelah kita ambil pesan, kita hapus pesan yang diambil dan pesan lainnya yang lebih lama yang mungkin tertinggal dalam bufer. -

{$user}:" - ." {$content}

"; -} - - -Untuk mengambil daftar dari pengguna saat ini (terformat), kita menambahkan logika kelas ini -ChatUserRecord. Kita menghapus setiap pengguna yang sudah tidak aktif untuk beberapa waktu. - -public function getUserList() -{ - $this->deleteAll('last_activity < ?', time()-300); //5 min inactivity - $content = '

'.htmlspecialchars($user->username).'

'; - return $content; -} - - -

Catatan: -Untuk kemudahan kita membentuk pesan dalam kelas Rekaman Aktif. Untuk aplikasi besar, tugas pembentukan pesan ini harus dilakukan menggunakan komponen Prado (contohnya menggunakan TRepeater dalam template atau komponen kustom). -

- -

Menyatukan Semuanya

Sekarang waktunya untuk menyatukan alur aplikasi secara keseluruhan. Dalam Home.php kita memutakhirkan tombol Send pengendali event OnClick untuk menggunakan logika aplikasi yang baru saja kita implementasikan. - -function processMessage($sender, $param) -{ - if(strlen($this->userinput->Text) > 0) - { - $record = new ChatBufferRecord(); - $record->message = $this->userinput->Text; - $record->from_user = $this->Application->User->Name; - $record->saveMessage(); - - $this->userinput->Text = ''; - $messages = $record->getUserMessages($this->Application->User->Name); - $this->CallbackClient->appendContent("messages", $messages); - $this->CallbackClient->focus($this->userinput); - } -} - -Kita cukup menyimpan pesan ke bufer chat dan kemudian meminta semua pesan untuk pengguna saat ini dan memutakhirkan pesan sisi klien menggunakan respon callback -(gaya AJAX). -

- -

Pada titik ini aplikasi sebenarnya sudah berfungsi, cuma tidak bersahabat. Jika Anda membuka dua browser berbeda, Anda seharusnya bisa berkomunikasi diantara dua pengguna kapan saja tombol Send diklik. -

- -

Bagian berikutnya barangkali lebih rumit dan mengakali daripada tugas lainnya. Kita perlu untuk meningkatkan pengalaman pengguna. Pertama, kita menginginkan daftar pengguna saat ini juga. Maka kita menambahkan metode berikut ke Home.php, kita dapat memanggil metode ini kapan saja beberapa event callback dimunculkan, misalnya saat tombol Send diklik. - -protected function refreshUserList() -{ - $lastUpdate = $this->getViewState('userList',''); - $users = ChatUserRecord::finder()->getUserList(); - if($lastUpdate != $users) - { - $this->CallbackClient->update('users', $users); - $this->setViewstate('userList', $users); - } -} - -

- -

Sebenarnya, kita menginginkan untuk secara -periodik memutakhirkan pesan dan daftar pengguna saat pengguna baru bergabung -dan pesan baru yang datang dari pengguna lainnya. Maka kita perlu untuk menyegarkan -daftar pesan juga.

- -function processMessage($sender, $param) -{ - ... - $this->refreshUserList(); - $this->refreshMessageList(); - ... -} - -protected function refreshMessageList() -{ - //refresh the message list - $finder = ChatBufferRecord::finder(); - $content = $finder->getUserMessages($this->Application->User->Name); - if(strlen($content) > 0) - { - $anchor = (string)time(); - $content .= " "; - $this->CallbackClient->appendContent("messages", $content); - $this->CallbackClient->focus($anchor); - } -} - -Jangkar menggunakan time() sebagai ID untuk titik fokus agar saat daftar -pesan pada sisi klien diperoleh sangat lama, metode fokus akan menggulung daftar -pesan ke pesan terbaru (ini bekerja baik pada umumnya browser). -

- -

Selanjutnya, kita perlu mengalihkan pengguna -kembali ke halaman login jika pengguna tidak aktif untuk beberapa waktum -katakanlah 5 menit, kita menambahkan pemeriksaan ini ke setiap tahap dari masa hidup -halaman. Mari menambahkannya ke tahapan onLoad(). - -public function onLoad($param) -{ - $username = $this->Application->User->Name; - if(!$this->Application->Modules['users']->usernameExists($username)) - { - $auth = $this->Application->Modules['auth']; - $auth->logout(); - - //redirect to login page. - $this->Response->Redirect($this->Service->ConstructUrl($auth->LoginPage)); - } -} - -

- -

Memperbaiki Pengalaman Pengguna

Beberapa rincian terakhir secara periodeik memeriksa -pesan baru dan menyegarkan daftar pengguna. Kita bisa melakukan ini dengan menanyakan -server menggunakan kontrol -. -Kita menambahkan tt>TTimeTriggeredCallback ke Home.page dan memanggil -metode pengendali refresh yang didefinisikan dalam Home.php. -Kita setel interval pertanyaan menjadi 2 detik. - -<com:TTimeTriggeredCallback OnCallback="refresh" - Interval="2" StartTimerOnLoad="true" /> - - -function refresh($sender, $param) -{ - $this->refreshUserList(); - $this->refreshMessageList(); -} - -

- -

Langkah terakhir memerlukan kita untuk menggunakan beberapa javascript. Kita menginginkan bahwa saat pengguna mengetikan beberapa teks dalam area teks dan menekan tombol Enter, kita menginginkannya untuk mengirimkan pesan tanpa mengklik tombol Send. Kita menambahkan beberapa javascript ke -Home.page. - - -<com:TClientScript> -Event.observe($("<%= $this->userinput->ClientID %>"), "keypress", function(ev) -{ - if(Event.keyCode(ev) == Event.KEY_RETURN) - { - if(Event.element(ev).value.length > 0) - new Prado.Callback("<%= $this->sendButton->UniqueID %>"); - Event.stop(ev); - } -}); -</com:TClientScript> - -Rincian sehubungan dengan javascript bisa dilihat dalam seksi -Pengenalan Javascript pada tutorial cepat. -

- -

Ini melengkapi tutorial untuk membuat aplikasi chat web menggunakan kerangka kerja Prado. Diharapkan Anda menikmatinya. -

- - diff --git a/demos/quickstart/protected/pages/Tutorial/id/CurrencyConverter.page b/demos/quickstart/protected/pages/Tutorial/id/CurrencyConverter.page deleted file mode 100755 index c1eae035..00000000 --- a/demos/quickstart/protected/pages/Tutorial/id/CurrencyConverter.page +++ /dev/null @@ -1,349 +0,0 @@ - -

Membangun Pengubah Kurs Sederhana

Tutorial ini memperkenalkan kerangka kerja aplikasi web Prado dan mengajarkan Anda bagaimana untuk - membangun aplikasi web sederhana dalam beberapa langkah sederhana. Tutorial - ini menganggap bahwa Anda terbiasa dengan PHP dan Anda telah mengakses - server web yang dapat melayani naskah PHP5. -

- -

Dalam tutorial ini Anda akan membangun aplikasi web sederhana yang mengubah - nilai dolar ke kurs lain, nilai kurs yang disediakan untuk kurs tersebut relatif terhadap dolar. Aplikasi lengkap ditampilkan di bawah ini. - class="figure" /> - Anda dapat mencoba aplikasi secara lokal atau di - Pradosoft.com. - Catatan bahwa aplikasi masih berfungsi sama persis apabila javascript tidak tersedia pada browser pengguna. -

- -

Men-download dan Menginstalasi Prado

Untuk menginstalasi Prado, cukup download versi terbaru Prado dari - http://www.pradosoft.com - dan uraikan file ke sebuah direktori yang tidak dapat diakses oleh server web Anda (Anda dapat menguraikannya ke sebuah direktori yang dapat diakses oleh server web jika Anda ingin melihat demo dan pengujian). Untuk instalasi lebih rinci, lihat bimbingan - Instalasi Cepat. -

- -

Membuat Aplikasi web Prado baru

Cara tercepat dan termudah untuk membuat aplikasi web Prado baru adalah menggunakan piranti perintah prado-cli.php yang ditemukan dalam direktori framework - pada distribusi Prado. Kita membuat aplikasi baru dengan menjalankan perintah berikut dalam prompt perintah atau konsol Anda. Perintah membuat direktori baru bernama currency-converter dalam direktori kerja Anda saat ini. - Anda perlu mengubahnya ke direktori yang benar terlebih dahulu. - Lihat Piranti Baris Perintah - untuk lebih jelasnya. -

- -php prado/framework/prado-cli.php -c currency-converter - - -

Perintah di atas membuat struktur direktori yang diperlukan dan file minimal (termasuk "index.php" dan "Home.page") untuk menjalankan aplikasi Prado. - Sekarang Anda dapat mengarahkan url browser Anda ke server web untuk melayani naskah index.php dalam direktori currency-converter. - Seharusnya Anda melihat pesan "Welcome to Prado!" -

- -

Membuat Antarmuka Pengguna Pengubah Kurs

Kita mulai dengan mengedit file Home.page yang ditemukan dalam direktori currency-converter/protected/pages/. File yang berakhiran dengan ".page" adalah template halaman yang berisi HTML dan kontrol Prado. - Kita cukup menambah dua kotak teks, tiga label dan satu tombol seperti berikut. -

- -<com:TForm> -

- Currency Converter -

- <com:TLabel ForControl="currencyRate" Text="Exchange Rate per $1:" /> - <com:TTextBox ID="currencyRate" /> -

- <com:TLabel ForControl="dollars" Text="Dollars to Convert:" /> - <com:TTextBox ID="dollars" /> -

- Amount in Other Currency: - <com:TLabel ID="total" CssClass="result" /> -

- <com:TButton Text="Convert" /> -

-</com:TForm> - -

- Jika Anda menyegarkan halaman, Anda akan melihat sesuatu mirip dengan gambar berikut. - Ia mungkin terlihat tidak cukup bagus atau berurut, tapi kita akan mengubahnya nanti dengan menggunakan CSS. - class="figure" /> -

- -

- Komponen pertama yang kita tambahkan adalah - - yang pada dasarnya terkait ke elemen HTML <form>. - Dalam Prado, hanya satu elemen TForm dibolehkan per halaman. -

- -

Dua pasang komponen berikutnya yang kita tambahkan adalah - - dan - - yang pada dasarnya mendefinisikan sebuah label dan kotak teks bagi pengguna aplikasi - untuk memasukan nilai pertukaran kurs. - Nilai properti ForControl property menentukan komponen mana label - diperuntukan. Ini membolehkan pengguna aplikasi mengklik pada label - untuk memfokuskan pada field (hal yang baik). Anda mungkin telah menggunakan elemen - biasa HTML <label> untuk melakukan hal yang sama, tapi - Anda harus mencari ID yang benar pada kotak teks (atau - <input> dalam HTML) karena komponen Prado dapat/mungkin menyajikan - nilai ID secara berbeda dalam output HTML. -

- -

Pasangan komponen berikutnya adalah sama dan mendefinisikan - kotak teks guna menampung nilai dolar yang akan dikonversi. - TLabel dengan nilai ID "total" mendefinisikan label sederhana. - Catatan bahwa properti ForControl tidak ada. Ini berarti bahwa label ini - merupakan sebuah label yang akan dipakai untuk menampilkan jumlah total yang dikonversi. -

- -

Komponen terakhir adalah - - yang akan diklik oleh pengguna untuk menghitung hasil. Properti Text - menetapkan label tombol. -

- -

Mengimplementasikan Konversi Kurs

- -

Jika Anda mencoba mengklik pada tombol "Convert" kemudian halaman akan menyegarkan - dan tidak melakukan apapun. Agar tombol melakukan beberapa pekerjaan, kita perlu - menambahkan "Home.php" ke di mana "Home.page" berada. Kelas Home harus - memperluas , basis kelas standar untuk semua halaman Prado. -

- -<?php -class Home extends TPage -{ - -} - -

- Prado menggunakan metode PHP __autoload untuk mengambil kelas. Konvensi - adalah untuk menggunakan nama kelas dengan ekstensi ".php" sebagai nama file. -

- -

Sejauh ini tidak ada hal menarik mengenai Prado, kita hanya mendeklarasikan beberapa - "komponen web" dalam beberapa file template bernama Home.page dan membuat - sebuah file "Home.php" dengan kelas Home. Sedikit yang lebih menarik adalah - arsitektur kendali-event Prado seperti yang akan kita lihat nanti. -

- -

Kita menginginkan bahwa saat pengguna mengklik tombol "Convert", kita mengambil - nilai dalam kotak teks, melakukan beberapa perhitungan dan menyajikan kepada pengguna dengan - total nilai yang dikonversi. Untuk menangani pengguna mengklik pada tombo "Convert", - kita cukup menambahkan sebuah properti OnClick ke tombol "Convert" dalam - template "Home.page" dan menambahkan metode pengendali event terkait dalam "Home.php". -

- -<com:TButton Text="Convert" OnClick="convert_clicked" /> - -

- Nilai dari OnClick, "convert_clicked", akan menjadi nama metode - dalam "Home.php" yang akan dipanggil saat pengguna mengklik tombol "Convert". -

- Jika Anda menjalankan aplikasi dalam web browser Anda, masukkan beberapa nilai - dan klik tombol "Convert" kemudian Anda akan melihat nilai yang dihitung ditampilkan - di dekat label "Amount in Other Currency". -

- -

Dalam metode "convert_clicked" parameter pertama, $sender, - berhubungan dengan obyek yang memunculkan event, dalam hal ini, tombol - "Convert". Parameter kedua, $param berisi data tambahan lain - di mana obyek $sender yang ingin ditambahkan. -

- -

Sekarang kita akan memeriksa, tiga baris yang mengimplementasikan konversi - kurs sederhana dalam metode "convert_clicked". -

- -$rate = floatval($this->currencyRate->Text); - -

- Pernyataan $this->currencyRate berhubungan dengan komponen - TTextBox dengan nilai ID "currencyRate" dalam template - "Home.page". Properti Text dari TTextBox berisi - nilai yang dimasukan oleh pengguna. Maka kita memperoleh nilai ini dengan - $this->currencyRate->Text yang kita konversi nilainya ke nilai - pecahan. -

- -$dollars = floatval($this->dollars->Text); - -

- Baris berikutnya melakukan hal yang mirip, ia mengambil nilai pengguna - dari TTextBox dengan nilai ID "dollars dang mengubahnya - ke nilai pecahan. -

- -

Baris ketiga menghitung jumlah baru dan menyetel nilai ini dalam properti - Text dari TLabel dengan ID="total". - Selanjutnya, kita tampilkan jumlah baru ke pengguna dalam label. -

- -$this->total->Text = $rate * $dollars; - - -

Menambahkan Validasi

Cara kita mengubah nilai yang dimasukan oleh pengguna ke pecahan memastikan bahwa jumlah total selalu sebuah angka. Maka pengguna bebas untuk memasukan apapun yang mereka sukai, bahkan mereka dapat memasukan huruf. Pengalaman pengguna dalam pemakaian aplikasi dapat ditingkatkan dengan menambahkan validator untuk memberitahu pengguna atas nilai yang dibolehkan dalam kurs mata uang dan jumlah yang akan dihitung. -

- -

Untuk kurs mata uang, kita harus memastikan bahwa

pengguna memasukan sebuah nilai,
kurs mata uang adalah angka yang benar,
kurs mata uang adalah positif.

- Untuk memastikan poin 1 kita menambahkan satu - . Untuk memastikan poin 2 dan 3, kita menambahkan satu . Kita dapat menambahkan validator ini di mana saja di dalam template "Home.page". Perincian selanjutnya mengenai validator ini dan validator lainnya dapat ditemukan dalam halaman - Validation Controls. -

Untuk jumlah yang dihitung, kita harus memastikan bahwa

pengguna memasukan sebuah nilai,
nilai adalah angka yang benar (tidak menyertakan tanda kurs atau dolar).

- Untuk memastikan 1 kita cukup menambahkan TRequiredFieldValidator lainnya, untuk 2 - kita dapat menggunakan - . Untuk memudahkan kita hanya membolehkan pengguna untuk memasukan sebuah angka untuk jumlah yang ingin mereka ubah. -

- -

Sekarang jika Anda mencoba memasukan beberapa data tidak benar dalam aplikasi atau membiarkan field kosong - validators akan diaktifkan dan menyajikan pesan kesalahan kepada pengguna. Catatan bahwa pesan kesalahan disajikan tanpa mengambil ulang halaman. Validator Prado standarnya memvalidasi javascript dan di dalam server. Validasi di dalam server selalu dilakukan. Untuk sisi server, kita harus melewati perhitungan jika validator tidak memuaskan. Ini dapat dilakukan seperti berikut. -

Meningkatkan Pengalaman Pengguna Dengan Kontrol Aktif

- - - -

Dalam aplikasi sederhana selanjutnya kita dapat -memperbaiki pengalaman pengguna dengan meningkatkan tanggapan aplikasi. Satu cara untuk mencapai respon tercepat adalah menghitung dan menyajikan hasil tanpa mengambil ulang seluruh halaman. -

- -

Kita dapat mengganti TButton dengan pasangan Kontrol Aktif, - , - yang dapat memicu event klik di dalam server tanpa mengambil ulang halaman. - Sebagai tambahan, kita dapat mengubah "total" TLabel dengan pasangan Kontrol Aktif, - , dengan demikian di dalam server dapat memutakhirkan browser tanpa mengambil ulang halaman. -

- -

- Amount in Other Currency: - <com:TActiveLabel ID="total" CssClass="result" /> -

- <com:TActiveButton Text="Convert" OnClick="convert_clicked" /> -

- -

- Logika di dalam server tetap sama, kita hanya perlu mengimpor - ruang nama Kontrol Aktif karena secara standar tidak disertakan. Kita menambahkan baris berikut ke awal "Home.php". -

- -Prado::using('System.Web.UI.ActiveControls.*'); - - -

Jika Anda mencoba aplikasi sekarang, Anda akan melihat bahwa halaman tidak perlu lagi mengambil ulang untuk menghitung dan menampilkan jumlah total yang dikonversi. - Akan tetapi, karena di sana tidak ada pengambilan halaman ulang, tidak ada petunjuk atau tidak jelas bahwa dengan mengklik pada tombol "Convert" telah terjadi. - Selanjutnya kita bisa memperbaiki pengalaman pengguna dengan mengunah label teks "total" menjadi "calculating..." saat pengguna mengklik tombol "Convert". Label teks "total" masih dimutakhirkan dengan jumlah perhitungan baru seperti sebelumnya. -

- -

Untuk mengindikasikan bahwa perhitungan sedang berlangsung, kita dapat mengubah label teks "total" sebagai berikut. Kita menambahkan properti ClientSide.OnLoading ke tombol "Convert" (karena tombol ini bertanggung jawab terhadap permintaan perhitungan). -

ClientSide.OnLoading dan berbagai - menerima blok javascript sebagai konten atau nilainya. - Kode javascript $('...') adalah fungsi javascript sama dengan document.getElementById('...') yang mengambil string dengan ID dari elemen HTML. Karena Prado menyajikan ID komponennya, kita perlu menggunakan ID yang disajikan dari label "total", yakni $this->total->ClientID. Kita tempatkan sedikit kode ini ini di dalam <%= %> untuk memperoleh ID HTML yang disajikan untuk label "total". Kode javascript sisanya innerHTML = "calculating..." cukup mengubah konten label "total". -

- -

Menambahkan Sentuhan Akhir

Sejauh ini kita telah membangun aplikasi web pengubah kurs sederhana dengan sedikit perhatian terhadap penampilannya. Sekarang kita dapat menambahkan stylesheet guna meningkatkan penampilan secara keseluruhan aplikasi. Kita cukup menambahkan inline stylesheet dengan kode template atau kita membuat sebuah "tema". -

- -

Untuk membuat dan menggunakan tema dengan aplikasi Prado, kita membuat direktori baru "themes/Basic" dalam direktori currency-converter. - Anda mungkin perlu untuk membuat direktori themes lebih dahulu. Direktori apapun di dalam themes dianggap sebagai tema dengan nama temanya adalah nama direktori. Lihat - Tema dan Skin untuk lebih jelasnya. -

- -

Kita cukup dengan membuat file CSS bernama "common.css" dan menyimpannya dalam direktori - themes/Basic. Kemudian kita menambahkan kode berikut ke awal "Home.page" (kita menambahkan sedikit kode HTML juga). -

- -<%@ Theme="Basic" %> - - -<com:THead Title="Currency Converter" /> - - -

- Baris pertama <%@ Theme="Basic" %> mendefinisikan tema - yang dipakai untuk halaman ini. - - merujuk ke elemen HTML <head>. Sebagai tambahan terhadap - tampilan properti Title pada THead, semua file CSS - dalam direktori themes/Basic juga disajikan/dikaitkan untuk - halaman saat ini. Aplikasi web pengubah kurs final kita terlihat seperti - berikut. - class="figure" /> - Tutorial pengenalan lengkap terhadap kerangka kerja aplikasi web Prado. -

- diff --git a/demos/quickstart/protected/pages/Tutorial/id/chat1.png b/demos/quickstart/protected/pages/Tutorial/id/chat1.png deleted file mode 100755 index 8288b496..00000000 Binary files a/demos/quickstart/protected/pages/Tutorial/id/chat1.png and /dev/null differ diff --git a/demos/quickstart/protected/pages/Tutorial/id/chat2.png b/demos/quickstart/protected/pages/Tutorial/id/chat2.png deleted file mode 100755 index 97cbc51d..00000000 Binary files a/demos/quickstart/protected/pages/Tutorial/id/chat2.png and /dev/null differ diff --git a/demos/quickstart/protected/pages/Tutorial/id/example1.png b/demos/quickstart/protected/pages/Tutorial/id/example1.png deleted file mode 100755 index 0c7da7ba..00000000 Binary files a/demos/quickstart/protected/pages/Tutorial/id/example1.png and /dev/null differ diff --git a/demos/quickstart/protected/pages/Tutorial/id/example2.png b/demos/quickstart/protected/pages/Tutorial/id/example2.png deleted file mode 100755 index 1df56cfb..00000000 Binary files a/demos/quickstart/protected/pages/Tutorial/id/example2.png and /dev/null differ -- cgit v1.2.3

Downloading and Installing Prado

Building an AJAX Chat Application

Download, Install and Create a New Application

Authentication and Authorization

Prado Chat Demo Login

Securing the Home page

Active Record for chat_users table

Custom User Manager class

Authentication

Default Values for ActiveRecord

Main Chat Application

Prado Chat Demo

Exploring the Active Controls

Active Record for chat_buffer table

Chat Application Logic

Putting It Together

Improving User Experience

Building a Simple Currency Converter

Downloading and Installing Prado

Creating a new Prado web Application

Creating the Currency Converter User Interface

Implementing Currency Conversion

Adding Validation

Improve User Experience With Active Controls

Adding Final Touches

Buku Alamat Sederhana

Membangun Aplikasi Obrolan AJAX

Download, Instalasi dan Buat Aplikasi Baru

Otentikasi dan Otorisasi

Prado Chat Demo Login

Mengamankan halaman Home

Rekaman Aktif untuk tabel chat_users

Kelas Manajer Pengguna Kustom

Otentikasi

Nilai Standar untuk ActiveRecord

Aplikasi Chat Utama

Prado Chat Demo

Menjelajah Kontrol Aktif

Rekaman Aktif untuk tabel chat_buffer

Logika Aplikasi Chat

Menyatukan Semuanya

Memperbaiki Pengalaman Pengguna

Membangun Pengubah Kurs Sederhana

Men-download dan Menginstalasi Prado

Membuat Aplikasi web Prado baru

Membuat Antarmuka Pengguna Pengubah Kurs

Mengimplementasikan Konversi Kurs

Menambahkan Validasi

Meningkatkan Pengalaman Pengguna Dengan Kontrol Aktif

Menambahkan Sentuhan Akhir

Securing the `Home` page

Active Record for `chat_users` table

Active Record for `chat_buffer` table

Mengamankan halaman `Home`

Rekaman Aktif untuk tabel `chat_users`

Rekaman Aktif untuk tabel `chat_buffer`