From 4def5cca8aeb85390c0f82c9445ee228ac40a7f3 Mon Sep 17 00:00:00 2001
From: wei <>
Date: Mon, 18 Sep 2006 23:38:21 +0000
Subject: Add CommandLine quickstart doc.
---
demos/quickstart/protected/controls/TopicList.tpl | 1 +
.../pages/GettingStarted/CommandLine.page | 105 +++++++++++++++++++++
.../protected/pages/GettingStarted/HelloWorld.page | 8 ++
3 files changed, 114 insertions(+)
create mode 100644 demos/quickstart/protected/pages/GettingStarted/CommandLine.page
(limited to 'demos/quickstart/protected')
diff --git a/demos/quickstart/protected/controls/TopicList.tpl b/demos/quickstart/protected/controls/TopicList.tpl
index 1302338d..677a727e 100644
--- a/demos/quickstart/protected/controls/TopicList.tpl
+++ b/demos/quickstart/protected/controls/TopicList.tpl
@@ -7,6 +7,7 @@
+Command Line Tool
+The optional prado-cli.php PHP script file in the framework
+directory provides command line tools to perform various tendious taks in Prado.
+The prado-cli.php can be used to create Prado project skeletons, create
+initial test fixtures, and access to an interactive PHP shell.
+
+Requirements
+
+To use the command line tool, you need to use your command prompt, command console
+or terminal. In addition, PHP must be able to execute PHP scripts from
+the command line.
+
+
+Usage
+
+If you type php path/to/framework/prado-cli.php, you should see
+the following information. Alternatively, if you are not on Windows,
+you may try to change the prado-cli.php into an executable
+and execute it as a script
+
+Command line tools for Prado 3.0.5.
+usage: php prado-cli.php action [optional]
+example: php prado-cli.php -c mysite
+
+actions:
+ -c
+ Creates a Prado project skeleton for the given .
+
+ -t
+ Create test fixtures in the given .
+
+ shell [directory]
+ Runs a PHP interactive interpreter. Initializes the Prado
+ application in the given [directory].
+
+
+The <parameter> are required parameters and [optional]
+are optional parameters.
+
+Creating a new Prado project skeleton
+
+To create a Prado project skeleton, do the following:
+
+ - Change to the directory where you want to create the project skeleton.
+ - Type, php ../prado/framework/prado-cli.php -c helloworld, where
+ hellowworld is the directory name that you want to create the project skeleton files.
+ - Type, php ../prado/framework/prado-cli.php -t helloworld to create
+ the test fixtures for the helloworld project.
+
+
+Interactive Shell
+
+The interactive shell allows you to evaluate PHP statements from te command line.
+The prado-cli.php script can be used to start the shell and load an existing
+Prado project. For example, let us load the blog demo project. Assume that your
+command line is in the prado distribution directory and you type.
+
+
+
+$: php framework/prado-cli.php shell demos/blog
+
+The output should be
+
+Command line tools for Prado 3.0.5.
+** Loaded Prado appplication in directory "demos\blog\protected".
+PHP-Shell - Version 0.3.1
+(c) 2006, Jan Kneschke
+
+>> use '?' to open the inline help
+
+>>
+
+Then we will get an instance of the Prado blog application, and from
+that instance we want an instance of the 'data' module.
+
+
+>> $app = Prado::getApplication();
+
+>> $db = $app->getModule('data');
+
+Lastly, we want to use the data module to query for a post with ID=1.
+
+>> $db->queryPostByID(1)
+
+There should not be any errors and you should see the following.
+
+PostRecord#1
+(
+ [ID] => 1
+ [AuthorID] => 1
+ [AuthorName] => 'Prado User'
+ [CreateTime] => 1148819691
+ [ModifyTime] => 0
+ [Title] => 'Welcome to Prado Weblog'
+ [Content] => 'Congratulations! You have successfully installed Prado Blog --
+ a PRADO-driven weblog system. A default administrator account has been created.
+ Please login with admin/prado and update your password as soon as possib
+le.'
+ [Status] => 0
+ [CommentCount] => 0
+)
+
+
+
\ No newline at end of file
diff --git a/demos/quickstart/protected/pages/GettingStarted/HelloWorld.page b/demos/quickstart/protected/pages/GettingStarted/HelloWorld.page
index 780c92b9..97d4f72d 100644
--- a/demos/quickstart/protected/pages/GettingStarted/HelloWorld.page
+++ b/demos/quickstart/protected/pages/GettingStarted/HelloWorld.page
@@ -27,6 +27,14 @@ where each directory is explained as follows. Note, the above directory structur