Difference between revisions of "6CS028 Workshop - Web Frameworks"

From mi-linux
Jump to navigationJump to search
 
(62 intermediate revisions by 2 users not shown)
Line 1: Line 1:
[[Main Page]] >> [[6CC001|Advanced Web Technologies]] >> [[6CC001 - Workbook|Workbook]] >> Week 02
+
[[Main Page]] >> [[6CS028|Advanced Web Development]] >> [[6CS028 - Workbook|Workbook]] >> Week 03
  
Consider using a PHP framework for your assessment. Here are some popular ones:
+
== PHP Web Frameworks and databases ==
  
==Summary of findings==
+
=== CodeIgniter ===
  
*<span style="color:#00C600">CodeIgniter</span>: Possibly the easiest one the learn first (flexible, no command line)
+
This week, go through the following steps of the tutorial:
*<span style="color:#00C600">Yii</span>: A bit more tricky as you need to run a few commands (to create an app, to use scaffolding)
+
* [https://codeigniter.com/user_guide/tutorial/news_section.html News Section]
*<span style="color:#00C600">CakePHP</span>: Quite simple to install (no command line required), but might be a bit more difficult to learn (I can't get mod rewrite to work at the moment)
+
* [https://codeigniter.com/user_guide/tutorial/create_news_items.html Create News Items]
*<span style="color:#FFC601">Symfony</span>: Difficult to set-up (see my notes) and seems to be using a lot of RAM on the server :/
 
*<span style="color:#FF0000">Laravel</span>: Cannot currently be installed on mi-linux (see notes)
 
*<span style="color:#FF0000">Zend</span>: I can't get this to work on mi-linux
 
  
==Command line==
+
Then read the following sections of the documentation, to consolidate the above:
 +
* [https://codeigniter.com/user_guide/database/index.html Working With Databases]
  
Some of the frameworks expect you to type commands, using the command line. Don't let it put you off, unless you know absolutely NOTHING about Linux commands.
+
=== Laravel ===
  
From Windows simply start "Putty", installed in the all the labs, and [http://www.chiark.greenend.org.uk/~sgtatham/putty/ free to download] from home.
+
This week, read the following sections of the documentation:
 +
* [https://laravel.com/docs/10.x/database Database]
  
When starting Putty simply type "mi-linux.wlv.ac.uk" in the "host name" box, and press "enter". Then log in using your normal details.
+
And work through the remaining sections of the Bootcamp tutorial:
 
+
* [https://bootcamp.laravel.com/inertia/editing-chirps Editing Chirps]
===Useful commands===
+
* [https://bootcamp.laravel.com/inertia/deleting-chirps Deleting Chirps]
 
+
* [https://bootcamp.laravel.com/inertia/notifications-and-events Notifications & Events]
To make a whole folder + sub-folders readable and executable by all:
 
<pre>
 
chmod 755 codeigniter/ -R
 
</pre>
 
 
 
To remove a whole folder (WARNING - CANNOT BE UNDONE)
 
<pre>
 
rm codeigniter/ -R
 
</pre>
 
 
 
==CodeIgniter ==
 
 
 
I tested version 2.1.4:
 
*[http://ellislab.com/codeigniter Framework's homepage]
 
 
 
First install CodeIgniter using this tutorial:
 
*[http://ellislab.com/codeigniter/user-guide/installation/index.html Installation Instructions]
 
 
 
If successfully installed you should see this page:
 
*[http://mi-linux.wlv.ac.uk/~in9352/codeigniter/ http://mi-linux.wlv.ac.uk/~in9352/codeigniter/]
 
 
 
Note: replace "in9352" with your student number and "codeigniter" with the folder name in which you have installed the framework.
 
 
 
Then work through the first few tutorials:
 
*[http://ellislab.com/codeigniter/user-guide/tutorial/static_pages.html Static pages]
 
*[http://ellislab.com/codeigniter/user-guide/tutorial/news_section.html News section]
 
*[http://ellislab.com/codeigniter/user-guide/tutorial/create_news_items.html Create news items]
 
 
 
Nothing too complicated in the tutorials above, however I would recommend that you skip the "Routing" section for now, as it make the format of the URL more confusing. Stick to the standard format for now:
 
 
 
<pre>
 
[your-site-url]index.php/controller/method
 
</pre>
 
 
 
So far example:
 
 
 
<pre>
 
http://mi-linux.wlv.ac.uk/~in9352/codeigniter/index.php/pages/view
 
</pre>
 
 
 
===Link to external CSS, JS, Images etc===
 
 
 
Make sure your base URL is populated in your config.php file, so for example for me:
 
 
 
<pre>
 
$config['base_url']='http://mi-linux.wlv.ac.uk/~in9352/codeigniter/';
 
</pre>
 
 
 
And then in your view use the URL helper:
 
 
 
<pre>
 
<?$this->load->helper('url');?>
 
<html>
 
<head>
 
  <title><?php echo $title ?> - CodeIgniter 2 Tutorial</title>
 
  <link rel="stylesheet" type="text/css" href="<?=base_url("css/style.css")?>">
 
</head>
 
<body>
 
  <h1>CodeIgniter 2 Tutorial</h1>
 
<p>
 
<img src="<?=base_url("funnycat.jpg")?>">
 
</p> 
 
</pre>
 
 
 
==Yii==
 
 
 
I tested version 1.1.14:
 
*[http://www.yiiframework.com/ Yii homepage]
 
 
 
Note: you may want to download the .zip archive from the [http://www.yiiframework.com/download/ downloads] section, it's easier to work with on Windows.
 
 
 
You can start here:
 
*[http://www.yiiframework.com/doc/guide/1.1/en/quickstart.installation Getting started tutorial]
 
 
 
Ignore the "Apache and Nginx configurations" step for now and go straight to the "Creating First Yii Application" step.
 
 
 
'''Create first app'''
 
 
 
The tutorial tells you to create your first project by running the following command (see above for more on how to run commands):
 
 
 
<pre>
 
% YiiRoot/framework/yiic webapp WebRoot/myapp
 
</pre>
 
 
 
The above worked for me, but one student tells me he is getting a "permission denied" error, which might mean you are not allowed to run bash commands. Not to worry, the script above also comes as a PHP script, so you can run this instead:
 
 
 
<pre>
 
php YiiRoot/framework/yiic.php webapp WebRoot/myapp
 
</pre>
 
 
 
Obviously in both cases you need to specify the paths as per your folders.
 
 
 
When browsing to your newly created application you might get the odd error message telling you to make certain folders writable (e.g. myapp/protected/runtime)
 
 
 
'''Mysql Database'''
 
 
 
By default Yii is set up to access an SQLite database. If you want to use Mysql you will need to edit the protected/config/main.php file, uncomment the following block and add your usual Mysql connection details:
 
 
 
<pre>
 
'db'=>array(
 
'connectionString' => 'mysql:host=localhost;dbname=XXX',
 
'emulatePrepare' => true,
 
'username' => 'XXX',
 
'password' => 'XXX',
 
'charset' => 'utf8',
 
),
 
</pre>
 
 
 
===Gii===
 
 
 
Gii is a new tool that allows you to generate code from the database (aka Scaffolding in the lecture slides). You enable it by uncommenting the following block in the protected/config/main.php file.
 
 
 
<pre>
 
'gii'=>array(
 
'class'=>'system.gii.GiiModule',
 
'password'=>'1234',
 
// If removed, Gii defaults to localhost only. Edit carefully to taste.
 
'ipFilters'=>array('134.220.251.99','::1'),
 
),
 
</pre>
 
 
 
Note: you need to specify your own password. Also I've had to put my IP address in the last field, or else the page was telling me I wasn't allowed in! On Windows you can get your IP address by opening a command line window and typing the command "ipconfig".
 
 
 
Other than that this seems to work quite well :) Obviously Gii can only create the php files if you make the folders writable (e.g. to generate a model class, you need to make the protected/models folder writable!)
 
 
 
==CakePHP==
 
 
 
I tested version 2.4.5
 
 
 
*[http://cakephp.org/ CakePHP homepage]
 
*[http://book.cakephp.org/2.0/en/getting-started.html Getting started tutorial]
 
 
 
===mod_rewrite===
 
 
 
IMPORTANT: I can't get MOD REWRITE to work at the moment, so my clean URL doesn't work:
 
*[http://mi-linux.wlv.ac.uk/~in9352/cakephp/posts/index http://mi-linux.wlv.ac.uk/~in9352/cakephp/posts/index]
 
 
 
Instead I have to use the full URL, which is not great:
 
*[http://mi-linux.wlv.ac.uk/~in9352/cakephp/app/webroot/index.php/posts/index http://mi-linux.wlv.ac.uk/~in9352/cakephp/app/webroot/index.php/posts/index]
 
 
 
I'll update you if I get it working :)
 
 
 
===Cache===
 
 
 
If you are getting the following error message:
 
 
 
''Warning: _cake_core_ cache was unable to write 'cake_dev_en-gb' to File cache in /studhome/staff/acad/in9352/public_html/cake/lib/Cake/Cache/Cache.php on line 309''
 
 
 
You need to make the "app/tmp" folder (and all its sub-folders) '''writable''' by all in order to solve this.
 
 
 
===PHP markers===
 
 
 
Don't forget the <?php markers at the beginning of your Conrtoller and Model files, they are omitted in the tutorial.
 
 
 
==Symfony==
 
 
 
I tested version 2.4.1:
 
*[http://symfony.com/ Framework's homepage]
 
*[http://symfony.com/doc/current/quick_tour/the_big_picture.html Quick tour]
 
 
 
Note: download the zip version of Symfony Standard.
 
 
 
===Set-up===
 
 
 
I found this framework quite difficult to set-up.
 
 
 
First I had to open the symfony/web/app_dev.php file to comment out this block of code:
 
 
 
<pre>
 
// This check prevents access to debug front controllers that are deployed by accident to production servers.
 
// Feel free to remove this, extend it, or make something more sophisticated.
 
/*if (isset($_SERVER['HTTP_CLIENT_IP'])
 
    || isset($_SERVER['HTTP_X_FORWARDED_FOR'])
 
    || !in_array(@$_SERVER['REMOTE_ADDR'], array('127.0.0.1', 'fe80::1', '::1'))
 
) {
 
    header('HTTP/1.0 403 Forbidden');
 
    exit('You are not allowed to access this file. Check '.basename(__FILE__).' for more information.');
 
}*/
 
</pre>
 
 
 
And then again in symfony/web/config.php
 
 
 
<pre>
 
/*if (!in_array(@$_SERVER['REMOTE_ADDR'], array(
 
    '127.0.0.1',
 
    '::1',
 
))) {
 
    header('HTTP/1.0 403 Forbidden');
 
    exit('This script is only accessible from localhost.');
 
}*/
 
</pre>
 
 
 
Now I can browse to the [http://mi-linux.wlv.ac.uk/~in9352/symfony/web/config.php config.php] file, which tells me I need to make the folders app/cache/ and app/logs/ writable by all, which is easy enough.
 
 
 
It also tells me to "set the date.timezone setting in php.ini (like Europe/Paris)". I will ask ITS to make the change at server level, but in the meantime you can specify it in the .htaccess file, by adding this line right at the end of the file:
 
 
 
<pre>
 
php_value date.timezone "Europe/London"
 
</pre>
 
 
 
I can now browse to my home page ([http://mi-linux.wlv.ac.uk/~in9352/symfony/web/app_dev.php/ http://mi-linux.wlv.ac.uk/~in9352/symfony/web/app_dev.php/]), but it throws a memory error:
 
 
 
<pre>
 
FatalErrorException: Error: Allowed memory size of 16777216 bytes exhausted (tried to allocate 262144 bytes)
 
</pre>
 
 
 
Again we can get around the issue by increasing the amount of RAM PHP can use on the server by adding this line to the .htaccess file:
 
 
 
<pre>
 
php_value memory_limit 64M
 
</pre>
 
 
 
But I am a little concerned that this framework seems to require a lot of server resources!
 
 
 
==Laravel==
 
 
 
*[http://laravel.com/ Homepage]
 
*[http://laravel.com/docs/quick Quickstart guide]
 
 
 
The Laravel framework utilizes [https://getcomposer.org/ Composer] for installation and dependency management, which is not currently installed on mi-linux. Fortunately you can install it in your home folder by running the following commands:
 
 
 
<pre>
 
mkdir ~/bin
 
wget -O ~/bin/composer https://getcomposer.org/composer.phar
 
chmod +x ~/bin/composer
 
echo PATH=\$PATH:\~/bin >>~/.bashrc
 
. ~/.bashrc
 
</pre>
 
 
 
Then you can run the install command as per [http://laravel.com/docs/quick Quickstart guide] instructions:
 
 
 
<pre>
 
composer create-project laravel/laravel your-project-name --prefer-dist
 
</pre>
 
 
 
The command above will download and install a fresh copy of Laravel in a new '''your-project-name''' folder within your current directory.
 
 
 
==Zend Framework==
 
 
 
So far I have not managed to successfully install Zend on mi-linux :(
 

Latest revision as of 12:44, 17 January 2024

Main Page >> Advanced Web Development >> Workbook >> Week 03

PHP Web Frameworks and databases

CodeIgniter

This week, go through the following steps of the tutorial:

Then read the following sections of the documentation, to consolidate the above:

Laravel

This week, read the following sections of the documentation:

And work through the remaining sections of the Bootcamp tutorial: