22 | * @copyright since 2012 Scavix Software Ltd. & Co. KG
23 | * @license http://www.opensource.org/licenses/lgpl-license.php LGPL
24 | */
25 | ?>
26 | WebFramework Documentor
27 |
28 | This is a tool to create documentation from DocComments in the WebFramework sourcecode.
29 | We use it to automate and speed up things - and it will constantly remind us of missing documentation.
30 | It will create a bunch of cross-linked markdown files that we push to the WebFramework.wiki repository
31 | thus using the standard GitHub mechanism for our documentation.
32 |
33 |
--------------------------------------------------------------------------------
/web/logs/.htaccess:
--------------------------------------------------------------------------------
1 | Deny from all
2 |
--------------------------------------------------------------------------------
/web/sample_blog/.htaccess:
--------------------------------------------------------------------------------
1 | # ----------------------------------------------------------------------------------------
2 | # Scavix Web Development Framework
3 | #
4 | # Copyright (c) since 2012 Scavix Software Ltd. & Co. KG
5 | #
6 | # This library is free software; you can redistribute it
7 | # and/or modify it under the terms of the GNU Lesser General
8 | # Public License as published by the Free Software Foundation;
9 | # either version 3 of the License, or (at your option) any
10 | # later version.
11 | #
12 | # This library is distributed in the hope that it will be useful,
13 | # but WITHOUT ANY WARRANTY; without even the implied warranty of
14 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 | # Lesser General Public License for more details.
16 | #
17 | # You should have received a copy of the GNU Lesser General Public
18 | # License along with this library. If not, see
19 | #
20 | # @author Scavix Software Ltd. & Co. KG http://www.scavix.com
21 | # @copyright since 2012 Scavix Software Ltd. & Co. KG
22 | # @license http://www.opensource.org/licenses/lgpl-license.php LGPL
23 | # ----------------------------------------------------------------------------------------
24 |
25 | RewriteEngine On
26 |
27 | # redirect NoCache files to the real ones
28 | SetEnv WDF_FEATURES_NOCACHE on
29 | RewriteRule (.*)/nc([0-9]+)/(.*) $1/$3?_nc=$2 [L,QSA]
30 |
31 | # redirect inexistant requests to index.php
32 | SetEnv WDF_FEATURES_REWRITE on
33 | RewriteCond %{REQUEST_FILENAME} !-f
34 | RewriteCond %{REQUEST_FILENAME} !-d
35 | RewriteCond %{REQUEST_URI} !index.php
36 | RewriteRule (.*) index.php?wdf_route=$1 [L,QSA]
37 |
--------------------------------------------------------------------------------
/web/sample_blog/README.md:
--------------------------------------------------------------------------------
1 | Blog sample
2 | ===========
3 |
4 | This is the sample code used in the article describing the WebFramework basics:
5 | [Ultra-Rapid PHP Application Development](http://www.codeproject.com/Articles/553018/Ultra-Rapid-PHP-Application-Development)
6 |
--------------------------------------------------------------------------------
/web/sample_blog/config.php:
--------------------------------------------------------------------------------
1 |
20 | *
21 | * @author Scavix Software Ltd. & Co. KG http://www.scavix.com
22 | * @copyright since 2012 Scavix Software Ltd. & Co. KG
23 | * @license http://www.opensource.org/licenses/lgpl-license.php LGPL
24 | */
25 |
26 | // Pages are PHP classes extending HtmlPage
27 | $CONFIG['system']['default_page'] = "Blog";
28 | // Events are mapped to PHP class methods
29 | $CONFIG['system']['default_event'] = "Index";
30 |
31 | // Application specific classpath
32 | classpath_add(__DIR__.'/controller');
33 | classpath_add(__DIR__.'/templates');
34 |
35 | // Database connection, a DSN passed to the PDO constructor
36 | $CONFIG['model']['system']['connection_string'] = "sqlite:../blog.db";
37 | $CONFIG['model']['system']['default'] = true;
38 |
39 | // Logger Config
40 | ini_set("error_log", __DIR__.'/../logs/blog_php_error.log');
41 | $CONFIG['system']['logging'] = array
42 | (
43 | 'human_readable' => array
44 | (
45 | 'path' => __DIR__.'/../logs/',
46 | 'filename_pattern' => 'blog_wdf.log',
47 | 'log_severity' => true,
48 | 'max_filesize' => 10*1024*1024,
49 | 'keep_for_days' => 5,
50 | 'max_trace_depth' => 16,
51 | ),
52 | 'full_trace' => array
53 | (
54 | 'class' => 'TraceLogger',
55 | 'path' => __DIR__.'/../logs/',
56 | 'filename_pattern' => 'blog_wdf.trace',
57 | 'log_severity' => true,
58 | 'max_trace_depth' => 10,
59 | 'max_filesize' => 10*1024*1024,
60 | 'keep_for_days' => 4,
61 | ),
62 | );
63 |
64 | // Resources config
65 | $CONFIG['resources'][] = array
66 | (
67 | 'ext' => 'js|css|less|png|jpg|jpeg|gif|htc|ico',
68 | 'path' => realpath(__DIR__.'/res/'),
69 | 'url' => 'res/',
70 | 'append_nc' => true,
71 | );
72 | // If you put WDF into a separate folder next to the app (like here), that folder must be externaly accessible.
73 | // So maybe you'll have to set up a subdomain for it and set that to 'resources_system_url_root'.
74 | // For now we just rely on the built in router that will output the resource contents via readfile().
75 | $CONFIG['resources_system_url_root'] = false;
76 | //$CONFIG['resources_system_url_root'] = 'http://wdf.domain.com/'; // <- sample
77 |
78 | // some essentials
79 | $CONFIG['system']['modules'] = array();
80 | date_default_timezone_set("Europe/Berlin");
81 |
--------------------------------------------------------------------------------
/web/sample_blog/controller/blog.class.php:
--------------------------------------------------------------------------------
1 |
20 | *
21 | * @author Scavix Software Ltd. & Co. KG http://www.scavix.com
22 | * @copyright since 2012 Scavix Software Ltd. & Co. KG
23 | * @license http://www.opensource.org/licenses/lgpl-license.php LGPL
24 | */
25 |
26 | use ScavixWDF\Base\HtmlPage;
27 | use ScavixWDF\Base\Template;
28 | use ScavixWDF\Controls\Anchor;
29 |
30 | class Blog extends HtmlPage
31 | {
32 | function __construct()
33 | {
34 | parent::__construct();
35 | $ds = model_datasource('system');
36 | $ds->ExecuteSql("CREATE TABLE IF NOT EXISTS blog(id INTEGER,title VARCHAR(50),body TEXT,PRIMARY KEY(id))");
37 |
38 | $this->content(new Anchor( buildQuery('blog','newpost'), 'New post' ));
39 | }
40 |
41 | function Index()
42 | {
43 | $ds = model_datasource('system');
44 | foreach( $ds->Query('blog')->orderBy('id','desc') as $post )
45 | {
46 | $tpl = Template::Make('post')
47 | ->set('title',$post->title)
48 | ->set('body',$post->body);
49 | $this->content($tpl);
50 | }
51 | }
52 |
53 | function NewPost()
54 | {
55 | log_debug("New Post");
56 | $this->content( Template::Make('newpostform') );
57 | }
58 |
59 | /**
60 | * @attribute[RequestParam('title','string')]
61 | * @attribute[RequestParam('body','string')]
62 | */
63 | function AddPost($title,$body)
64 | {
65 | log_debug("Add Post");
66 | $ds = model_datasource('system');
67 | $ds->ExecuteSql("INSERT INTO blog(title,body)VALUES(?,?)",array($title,$body));
68 | redirect('blog','index');
69 | }
70 | }
--------------------------------------------------------------------------------
/web/sample_blog/index.php:
--------------------------------------------------------------------------------
1 |
20 | *
21 | * @author Scavix Software Ltd. & Co. KG http://www.scavix.com
22 | * @copyright since 2012 Scavix Software Ltd. & Co. KG
23 | * @license http://www.opensource.org/licenses/lgpl-license.php LGPL
24 | */
25 | require_once(__DIR__."/../system/system.php");
26 |
27 | switchToDev();
28 | system_init('blog');
29 |
30 | if( isset($_GET['clear']) )
31 | {
32 | cache_clear();
33 | $_SESSION = array();
34 | }
35 |
36 | system_execute();
37 |
--------------------------------------------------------------------------------
/web/sample_blog/res/blog.less:
--------------------------------------------------------------------------------
1 | /**
2 | * Scavix Web Development Framework
3 | *
4 | * Copyright (c) since 2024 Scavix Software GmbH & Co. KG
5 | *
6 | * This library is free software; you can redistribute it
7 | * and/or modify it under the terms of the GNU Lesser General
8 | * Public License as published by the Free Software Foundation;
9 | * either version 3 of the License, or (at your option) any
10 | * later version.
11 | *
12 | * This library is distributed in the hope that it will be useful,
13 | * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 | * Lesser General Public License for more details.
16 | *
17 | * You should have received a copy of the GNU Lesser General Public
18 | * License along with this library. If not, see
19 | *
20 | * @author Scavix Software GmbH & Co. KG https://www.scavix.com
21 | * @copyright since 2024 Scavix Software GmbH & Co. KG
22 | * @license http://www.opensource.org/licenses/lgpl-license.php LGPL
23 | */
24 | body
25 | {
26 | padding: 1em 25%;
27 |
28 | h1
29 | {
30 | color: red;
31 | }
32 |
33 | p
34 | {
35 | color: black;
36 | border-bottom: 1px dotted black;
37 | padding: 0 1em 1em 1em;
38 | }
39 |
40 | form
41 | {
42 | display: flex;
43 | flex-direction: column;
44 |
45 | > div
46 | {
47 | display: flex;
48 |
49 | span
50 | {
51 | flex: 1;
52 | min-width: 150px;
53 | }
54 | input, textarea
55 | {
56 | flex: 5;
57 | }
58 | }
59 | }
60 | }
61 |
--------------------------------------------------------------------------------
/web/sample_blog/templates/newpostform.tpl.php:
--------------------------------------------------------------------------------
1 |
20 | *
21 | * @author Scavix Software Ltd. & Co. KG http://www.scavix.com
22 | * @copyright since 2012 Scavix Software Ltd. & Co. KG
23 | * @license http://www.opensource.org/licenses/lgpl-license.php LGPL
24 | */
25 | ?>
26 |
--------------------------------------------------------------------------------
/web/sample_blog/templates/post.tpl.php:
--------------------------------------------------------------------------------
1 |
20 | *
21 | * @author Scavix Software Ltd. & Co. KG http://www.scavix.com
22 | * @copyright since 2012 Scavix Software Ltd. & Co. KG
23 | * @license http://www.opensource.org/licenses/lgpl-license.php LGPL
24 | */
25 | ?>
26 |
27 |
--------------------------------------------------------------------------------
/web/sample_charts/.htaccess:
--------------------------------------------------------------------------------
1 | # ----------------------------------------------------------------------------------------
2 | # Scavix Web Development Framework
3 | #
4 | # Copyright (c) since 2012 Scavix Software Ltd. & Co. KG
5 | #
6 | # This library is free software; you can redistribute it
7 | # and/or modify it under the terms of the GNU Lesser General
8 | # Public License as published by the Free Software Foundation;
9 | # either version 3 of the License, or (at your option) any
10 | # later version.
11 | #
12 | # This library is distributed in the hope that it will be useful,
13 | # but WITHOUT ANY WARRANTY; without even the implied warranty of
14 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 | # Lesser General Public License for more details.
16 | #
17 | # You should have received a copy of the GNU Lesser General Public
18 | # License along with this library. If not, see
19 | #
20 | # @author Scavix Software Ltd. & Co. KG http://www.scavix.com
21 | # @copyright since 2012 Scavix Software Ltd. & Co. KG
22 | # @license http://www.opensource.org/licenses/lgpl-license.php LGPL
23 | # ----------------------------------------------------------------------------------------
24 |
25 | RewriteEngine On
26 |
27 | # redirect NoCache files to the real ones
28 | SetEnv WDF_FEATURES_NOCACHE on
29 | RewriteRule (.*)/nc([0-9]+)/(.*) $1/$3?_nc=$2 [L,QSA]
30 |
31 | # redirect inexistant requests to index.php
32 | SetEnv WDF_FEATURES_REWRITE on
33 | RewriteCond %{REQUEST_FILENAME} !-f
34 | RewriteCond %{REQUEST_FILENAME} !-d
35 | RewriteCond %{REQUEST_URI} !index.php
36 | RewriteRule (.*) index.php?wdf_route=$1 [L,QSA]
37 |
--------------------------------------------------------------------------------
/web/sample_charts/README.md:
--------------------------------------------------------------------------------
1 | Chart sample
2 | ============
3 |
4 | This is a sample on how to use the charts provided by the WebFramework in your web application.
5 |
--------------------------------------------------------------------------------
/web/sample_charts/config.php:
--------------------------------------------------------------------------------
1 |
20 | *
21 | * @author Scavix Software Ltd. & Co. KG http://www.scavix.com
22 | * @copyright since 2012 Scavix Software Ltd. & Co. KG
23 | * @license http://www.opensource.org/licenses/lgpl-license.php LGPL
24 | */
25 |
26 | // Pages are PHP classes extending HtmlPage
27 | $CONFIG['system']['default_page'] = "ChartRoulette";
28 | // Events are mapped to PHP class methods
29 | $CONFIG['system']['default_event'] = "Index";
30 |
31 | // Application specific classpath
32 | classpath_add(__DIR__.'/controller');
33 |
34 | // Database connection, a DSN passed to the PDO constructor
35 | $CONFIG['model']['system']['connection_string'] = "sqlite:../chartroulette.db";
36 | $CONFIG['model']['system']['default'] = true;
37 | $GLOBALS['CREATE_DATA'] = !file_exists("../chartroulette.db");
38 |
39 |
40 | // Logger Config
41 | ini_set("error_log", __DIR__.'/../logs/chartroulette_php_error.log');
42 | $CONFIG['system']['logging'] = array
43 | (
44 | 'human_readable' => array
45 | (
46 | 'path' => __DIR__.'/../logs/',
47 | 'filename_pattern' => 'chartroulette_wdf.log',
48 | 'log_severity' => true,
49 | 'max_filesize' => 10*1024*1024,
50 | 'keep_for_days' => 5,
51 | 'max_trace_depth' => 16,
52 | ),
53 | 'full_trace' => array
54 | (
55 | 'class' => 'TraceLogger',
56 | 'path' => __DIR__.'/../logs/',
57 | 'filename_pattern' => 'chartroulette_wdf.trace',
58 | 'log_severity' => true,
59 | 'max_trace_depth' => 10,
60 | 'max_filesize' => 10*1024*1024,
61 | 'keep_for_days' => 4,
62 | ),
63 | );
64 |
65 | // Resources config
66 | $CONFIG['resources'][] = array
67 | (
68 | 'ext' => 'js|css|png|jpg|jpeg|gif|htc|ico',
69 | 'path' => realpath(__DIR__.'/res/'),
70 | 'url' => 'res/',
71 | 'append_nc' => true,
72 | );
73 | // If you put WDF into a separate folder next to the app (like here), that folder must be externaly accessible.
74 | // So maybe you'll have to set up a subdomain for it and set that to 'resources_system_url_root'.
75 | // For now we just rely on the built in router that will output the resource contents via readfile().
76 | $CONFIG['resources_system_url_root'] = false;
77 | //$CONFIG['resources_system_url_root'] = 'http://chartroulette.if.it.is.free.com/'; // <- sample
78 |
79 | // some essentials
80 | $CONFIG['system']['modules'] = array();
81 | date_default_timezone_set("Europe/Berlin");
82 |
--------------------------------------------------------------------------------
/web/sample_charts/controller/chartroulette.class.php:
--------------------------------------------------------------------------------
1 |
20 | *
21 | * @author Scavix Software Ltd. & Co. KG http://www.scavix.com
22 | * @copyright since 2012 Scavix Software Ltd. & Co. KG
23 | * @license http://www.opensource.org/licenses/lgpl-license.php LGPL
24 | */
25 |
26 | use ScavixWDF\Base\HtmlPage;
27 | use ScavixWDF\Controls\ChartJS3;
28 | use ScavixWDF\Google\GoogleVisualization;
29 | use ScavixWDF\Google\gvBarChart;
30 | //use ScavixWDF\Google\gvComboChart;
31 | use ScavixWDF\Google\gvGeoChart;
32 | use ScavixWDF\Google\gvPieChart;
33 | use ScavixWDF\JQueryUI\uiTabs;
34 | use ScavixWDF\Localization\Localization;
35 | use ScavixWDF\Model\DataSource;
36 |
37 | class ChartRoulette extends HtmlPage
38 | {
39 | function __construct()
40 | {
41 | parent::__construct();
42 | if( $GLOBALS['CREATE_DATA'] )
43 | {
44 | $ds = model_datasource('system');
45 |
46 | $fn = array('John','Jane','Thomas','Marc','Jamie','Bob','Marie');
47 | $ln = array('Doe','Murphy','Anderson','Smith');
48 | $country_codes = array('DE','US','RU','FR','IT','SE');
49 | $ds->ExecuteSql("CREATE TABLE participants(name VARCHAR(50), country VARCHAR(5),age INTEGER,game_count INTEGER,PRIMARY KEY(name))");
50 | foreach( $fn as $f )
51 | {
52 | foreach( $ln as $l )
53 | {
54 | $cc = $country_codes[rand(0, count($country_codes)-1)];
55 | $ds->ExecuteSql("INSERT INTO participants(name,country,age,game_count)VALUES(?,?,?,?)",array("$f $l",$cc,rand(18,70),rand(0,100)));
56 | }
57 | }
58 |
59 | $nums = array();
60 | $ds->ExecuteSql("CREATE TABLE numbers(number INTEGER,hit_count INTEGER,PRIMARY KEY(number))");
61 | for($i=0; $i<=36; $i++)
62 | {
63 | $nums[$i] = 0;
64 | $ds->ExecuteSql("INSERT INTO numbers(number,hit_count)VALUES(?,?)",array($i,0));
65 | }
66 | for($i=0; $i<9999; $i++)
67 | {
68 | $rnd = rand(0,36);
69 | $nums[$rnd]++;
70 | }
71 | foreach( $nums as $i=>$c )
72 | $ds->ExecuteSql("UPDATE numbers SET hit_count=? WHERE number=?",array($c,$i));
73 | }
74 | GoogleVisualization::$DefaultDatasource = model_datasource('system');
75 | }
76 |
77 | /**
78 | * @attribute[RequestParam('type','string',false)]
79 | * @attribute[RequestParam('data','string',false)]
80 | */
81 | function Index($type,$data)
82 | {
83 | $tabs = new uiTabs();
84 | $tabs->AddTab("Participants by game count", $this->ParticipantsGames());
85 | $tabs->AddTab("Participants by age", $this->ParticipantsAge());
86 | $tabs->AddTab("Participants countries", $this->ParticipantsCountries());
87 |
88 | $this->content($tabs);
89 | }
90 |
91 | function ParticipantsAge()
92 | {
93 | $data = DataSource::Get()->ExecuteSql("SELECT age, count(*) as cnt FROM participants GROUP BY age ORDER BY cnt DESC")
94 | ->Enumerate('cnt', false, 'age');
95 | $labels = array_map(function ($a) { return "$a years";},array_keys($data));
96 | $data = array_combine($labels, array_values($data));
97 | return ChartJS3::Pie("Participants by age", 400)
98 | ->setSeries(['age'=>"Age",'cnt'=>"Count"])
99 | ->setPieData($data);
100 | }
101 |
102 | function ParticipantsGames()
103 | {
104 | $data = DataSource::Get()->ExecuteSql("SELECT name, game_count FROM participants ORDER BY game_count DESC")
105 | ->Enumerate('game_count', false, 'name');
106 | return ChartJS3::Bar("Participants by game count", 400)
107 | ->setPieData($data)
108 | ->legend('display',false)
109 | ->opt('indexAxis','y');
110 | }
111 |
112 | function ParticipantsCountries()
113 | {
114 | $chart = new gvGeoChart();
115 | $chart->setTitle("Participants countries")
116 | ->setDataHeader("Country","Participants")
117 | ->setSize(800, 400)
118 | ->opt('is3D',true);
119 | $country_names = Localization::get_country_names();
120 | foreach( DataSource::Get()->ExecuteSql("SELECT country, count(*) as cnt FROM participants GROUP BY country ORDER BY cnt DESC") as $row )
121 | $chart->addDataRow($country_names[$row['country']],intval($row['cnt']));
122 |
123 | return $chart;
124 | }
125 | }
--------------------------------------------------------------------------------
/web/sample_charts/index.php:
--------------------------------------------------------------------------------
1 |
20 | *
21 | * @author Scavix Software Ltd. & Co. KG http://www.scavix.com
22 | * @copyright since 2012 Scavix Software Ltd. & Co. KG
23 | * @license http://www.opensource.org/licenses/lgpl-license.php LGPL
24 | */
25 | require_once(__DIR__."/../system/system.php");
26 |
27 | switchToDev();
28 | system_init('chartroulette');
29 |
30 | if( isset($_GET['clear']) )
31 | {
32 | cache_clear();
33 | $_SESSION = array();
34 | }
35 |
36 | system_execute();
37 |
--------------------------------------------------------------------------------
/web/sample_shop/.htaccess:
--------------------------------------------------------------------------------
1 | # ----------------------------------------------------------------------------------------
2 | # Scavix Web Development Framework
3 | #
4 | # Copyright (c) since 2012 Scavix Software Ltd. & Co. KG
5 | #
6 | # This library is free software; you can redistribute it
7 | # and/or modify it under the terms of the GNU Lesser General
8 | # Public License as published by the Free Software Foundation;
9 | # either version 3 of the License, or (at your option) any
10 | # later version.
11 | #
12 | # This library is distributed in the hope that it will be useful,
13 | # but WITHOUT ANY WARRANTY; without even the implied warranty of
14 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 | # Lesser General Public License for more details.
16 | #
17 | # You should have received a copy of the GNU Lesser General Public
18 | # License along with this library. If not, see
19 | #
20 | # @author Scavix Software Ltd. & Co. KG http://www.scavix.com
21 | # @copyright since 2012 Scavix Software Ltd. & Co. KG
22 | # @license http://www.opensource.org/licenses/lgpl-license.php LGPL
23 | # ----------------------------------------------------------------------------------------
24 |
25 |
26 | RewriteEngine On
27 |
28 | # redirect NoCache files to the real ones
29 | SetEnv WDF_FEATURES_NOCACHE on
30 | RewriteRule (.*)/nc([0-9]+)/(.*) $1/$3?_nc=$2 [L,QSA]
31 |
32 | # redirect inexistant requests to index.php
33 | SetEnv WDF_FEATURES_REWRITE on
34 | RewriteCond %{REQUEST_FILENAME} !-f
35 | RewriteCond %{REQUEST_FILENAME} !-d
36 | RewriteCond %{REQUEST_URI} !index.php
37 | RewriteRule (.*) index.php?wdf_route=$1 [L,QSA]
38 |
--------------------------------------------------------------------------------
/web/sample_shop/README.md:
--------------------------------------------------------------------------------
1 | Shop sample
2 | ===========
3 |
4 | This is the sample code used in the article describing how to use the WebFramework to
5 | [Easily implementing your own online shop](http://www.codeproject.com/Articles/586703/Easily-implementing-your-own-online-shop)
6 |
--------------------------------------------------------------------------------
/web/sample_shop/config.php:
--------------------------------------------------------------------------------
1 |
20 | *
21 | * @author Scavix Software Ltd. & Co. KG http://www.scavix.com
22 | * @copyright since 2012 Scavix Software Ltd. & Co. KG
23 | * @license http://www.opensource.org/licenses/lgpl-license.php LGPL
24 | */
25 |
26 | // Pages are PHP classes extending HtmlPage
27 | $CONFIG['system']['default_page'] = "Products";
28 | // Events are mapped to PHP class methods
29 | $CONFIG['system']['default_event'] = "Index";
30 |
31 | // Application specific classpath
32 | classpath_add(__DIR__.'/controller');
33 | classpath_add(__DIR__.'/templates');
34 | classpath_add(__DIR__.'/model');
35 |
36 | // Database connection, a DSN passed to the PDO constructor
37 | $CONFIG['model']['system']['connection_string'] = "sqlite:../shop.db";
38 | $CONFIG['model']['system']['default'] = true;
39 |
40 | // Logger Config
41 | ini_set("error_log", __DIR__.'/../logs/shop_php_error.log');
42 | $CONFIG['system']['logging'] = array
43 | (
44 | 'human_readable' => array
45 | (
46 | 'path' => __DIR__.'/../logs/',
47 | 'filename_pattern' => 'shop_wdf.log',
48 | 'log_severity' => true,
49 | 'max_filesize' => 10*1024*1024,
50 | 'keep_for_days' => 5,
51 | 'max_trace_depth' => 16,
52 | ),
53 | 'full_trace' => array
54 | (
55 | 'class' => 'TraceLogger',
56 | 'path' => __DIR__.'/../logs/',
57 | 'filename_pattern' => 'shop_wdf.trace',
58 | 'log_severity' => true,
59 | 'max_trace_depth' => 10,
60 | 'max_filesize' => 10*1024*1024,
61 | 'keep_for_days' => 4,
62 | ),
63 | );
64 |
65 | // Resources config
66 | $CONFIG['resources'][] = array
67 | (
68 | 'ext' => 'js|css|png|jpg|jpeg|gif|htc|ico',
69 | 'path' => realpath(__DIR__.'/res/'),
70 | 'url' => 'res/',
71 | 'append_nc' => true,
72 | );
73 |
74 | // this is products image folder.
75 | // setting it up as resource folder allows us to simply use resFile() to reference a products image.
76 | $CONFIG['resources'][] = array
77 | (
78 | 'ext' => 'png|jpg|jpeg|gif',
79 | 'path' => realpath(__DIR__.'/images/'),
80 | 'url' => 'images/',
81 | 'append_nc' => true,
82 | );
83 |
84 | // some essentials
85 | $CONFIG['system']['modules'] = array('payment');
86 | date_default_timezone_set("Europe/Berlin");
87 |
88 | // configure payment module with your IShopOrder class
89 | $CONFIG["payment"]["order_model"] = 'SampleShopOrder';
90 | // set up Gate2Shop if you want to use it
91 | $CONFIG["payment"]["gate2shop"]["merchant_id"] = '';
92 | $CONFIG["payment"]["gate2shop"]["merchant_site_id"] = '';
93 | $CONFIG["payment"]["gate2shop"]["secret_key"] = '';
94 | // set up PayPal if you want to use it
95 | $CONFIG["payment"]["paypal"]["paypal_id"] = '';
96 | $CONFIG["payment"]["paypal"]["notify_handler"] = array('Basket','Notification');
97 |
98 | // Credentials for the Admin controller. Hardcoding them is okay for now, but they should obviously be stored in DB later.
99 | // Note: never store passwords, but salted password hashes!
100 | $CONFIG["admin"]["username"] = 'admin';
101 | $CONFIG["admin"]["password"] = 'admin';
--------------------------------------------------------------------------------
/web/sample_shop/controller/admin.class.php:
--------------------------------------------------------------------------------
1 |
20 | *
21 | * @author Scavix Software Ltd. & Co. KG http://www.scavix.com
22 | * @copyright since 2012 Scavix Software Ltd. & Co. KG
23 | * @license http://www.opensource.org/licenses/lgpl-license.php LGPL
24 | */
25 | use ScavixWDF\Base\AjaxAction;
26 | use ScavixWDF\Base\AjaxResponse;
27 | use ScavixWDF\Base\Template;
28 | use ScavixWDF\Controls\Form\Form;
29 | use ScavixWDF\JQueryUI\Dialog\uiDialog;
30 | use ScavixWDF\JQueryUI\uiButton;
31 | use ScavixWDF\JQueryUI\uiDatabaseTable;
32 | use ScavixWDF\JQueryUI\uiMessage;
33 |
34 | class Admin extends ShopBase
35 | {
36 | /**
37 | * Checks if aa admin has logged in and redirects to login if not.
38 | */
39 | private function _login()
40 | {
41 | // check only the fact that somebody logged in
42 | if( avail($_SESSION,'logged_in') )
43 | return true;
44 |
45 | // redirect to login. this terminates the script execution.
46 | redirect('Admin','Login');
47 | }
48 |
49 | /**
50 | * @attribute[RequestParam('username','string',false)]
51 | * @attribute[RequestParam('password','string',false)]
52 | */
53 | function Login($username,$password)
54 | {
55 | // if credentials are given, try to log in
56 | if( $username && $password )
57 | {
58 | // see config.php for credentials
59 | if( $username==cfg_get('admin','username') && $password==cfg_get('admin','password') )
60 | {
61 | $_SESSION['logged_in'] = true; // check only the fact that somebody logged in
62 | redirect('Admin');
63 | }
64 | $this->content(uiMessage::Error("Unknown username/passsword"));
65 | }
66 | // putting it together as control here. other ways would be to create a new class
67 | // derived from Control or a Template (anonymous or with an own class)
68 | $form = $this->content(new Form());
69 | $form->content("Username:");
70 | $form->AddText('username', '');
71 | $form->content("
Password:");
72 | $form->AddPassword('password', '');
73 | $form->AddSubmit("Login");
74 | }
75 |
76 | function Index()
77 | {
78 | $this->_login(); // require admin to be logged in
79 |
80 | // add products table and a button to create a new product
81 | $this->content("Products
");
82 | $this->content(new uiDatabaseTable(model_datasource('system'),false,'products'))
83 | ->AddPager(10)
84 | ->AddRowAction('trash', 'Delete', $this, 'DelProduct');
85 | $this->content(uiButton::Textual('Add product'))->onclick = AjaxAction::Post('Admin', 'AddProduct');
86 |
87 | // add orders table
88 | $this->content("Orders
");
89 | $this->content(new uiDatabaseTable(model_datasource('system'),false,'orders'))
90 | ->AddPager(10)
91 | ->OrderBy = 'id DESC';
92 |
93 | // add customers table
94 | $this->content("Customers
");
95 | $this->content(new uiDatabaseTable(model_datasource('system'),false,'customers'))
96 | ->AddPager(10)
97 | ->OrderBy = 'id DESC';
98 | }
99 |
100 | /**
101 | * @attribute[RequestParam('title','string',false)]
102 | * @attribute[RequestParam('tagline','string',false)]
103 | * @attribute[RequestParam('body','text',false)]
104 | * @attribute[RequestParam('price','double',false)]
105 | */
106 | function AddProduct($title,$tagline,$body,$price)
107 | {
108 | $this->_login(); // require admin to be logged in
109 |
110 | // This is a quite simple condition: You MUST provide each of the variables
111 | if( $title && $tagline && $body && $price )
112 | {
113 | // store the uploaded image if present
114 | if( isset($_FILES['image']) && $_FILES['image']['name'] )
115 | {
116 | $i = 1; $image = __DIR__.'/../images/'.$_FILES['image']['name'];
117 | while( file_exists($image) )
118 | $image = __DIR__.'/../images/'.($i++).'_'.$_FILES['image']['name'];
119 | move_uploaded_file($_FILES['image']['tmp_name'], $image);
120 | $image = basename($image);
121 | }
122 | else
123 | $image = '';
124 |
125 | // store the new product into the database
126 | $ds = model_datasource('system');
127 | $ds->ExecuteSql("INSERT INTO products(title,tagline,body,image,price)VALUES(?,?,?,?,?)",
128 | array($title,$tagline,$body,$image,$price));
129 |
130 | redirect('Admin');
131 | }
132 | // create a dialog and put a template on it.
133 | $dlg = new uiDialog('Add product',array('width'=>600,'height'=>450));
134 | $dlg->content( Template::Make('admin_product_add') );
135 | $dlg->AddButton('Add product', "$('#frm_add_product').submit()"); // frm_add_product is defined in the template
136 | $dlg->AddCloseButton("Cancel");
137 | return $dlg;
138 | }
139 |
140 | /**
141 | * @attribute[RequestParam('table','string',false)]
142 | * @attribute[RequestParam('action','string',false)]
143 | * @attribute[RequestParam('model','array',false)]
144 | * @attribute[RequestParam('row','string',false)]
145 | */
146 | function DelProduct($table,$action,$model,$row)
147 | {
148 | $this->_login(); // require admin to be logged in
149 |
150 | // we use the ajax confirm features of the framework which require some translated string, so we set them up here
151 | // normally we would start the sysadmin and create some, but for this sample we ignore that.
152 | default_string('TITLE_DELPRODUCT','Delete Product');
153 | default_string('TXT_DELPRODUCT','Do you really want to remove this product? This cannot be undone!');
154 | if( !AjaxAction::IsConfirmed('DELPRODUCT') )
155 | return AjaxAction::Confirm('DELPRODUCT', 'Admin', 'DelProduct', array('model'=>$model));
156 |
157 | // load and delete the product dataset
158 | $ds = model_datasource('system');
159 | $prod = $ds->Query('products')->eq('id',$model['id'])->current();
160 | $prod->Delete();
161 |
162 | // delete the image too if present
163 | if( $prod->image )
164 | {
165 | $image = __DIR__.'/../images/'.$prod->image;
166 | if( file_exists($image) )
167 | unlink($image);
168 | }
169 | return AjaxResponse::Redirect('Admin');
170 | }
171 | }
172 |
--------------------------------------------------------------------------------
/web/sample_shop/controller/basket.class.php:
--------------------------------------------------------------------------------
1 |
20 | *
21 | * @author Scavix Software Ltd. & Co. KG http://www.scavix.com
22 | * @copyright since 2012 Scavix Software Ltd. & Co. KG
23 | * @license http://www.opensource.org/licenses/lgpl-license.php LGPL
24 | */
25 | use ScavixWDF\Base\Template;
26 | use ScavixWDF\JQueryUI\uiButton;
27 | use ScavixWDF\JQueryUI\uiMessage;
28 |
29 | class Basket extends ShopBase
30 | {
31 | /**
32 | * Lists all items in the basket.
33 | * @attribute[RequestParam('error','string',false)]
34 | */
35 | function Index($error)
36 | {
37 | // display any given error message
38 | if( $error )
39 | $this->content(uiMessage::Error($error));
40 |
41 | // prepare basket variable
42 | if( !isset($_SESSION['basket']) )
43 | $_SESSION['basket'] = array();
44 |
45 | if( count($_SESSION['basket']) == 0 )
46 | $this->content(uiMessage::Hint('Basket is empty'));
47 | else
48 | {
49 | // list all items in the basket ...
50 | $ds = model_datasource('system');
51 | $price_total = 0;
52 | foreach( $_SESSION['basket'] as $id=>$amount )
53 | {
54 | $prod = $ds->Query('products')->eq('id',$id)->current();
55 |
56 | //... each using a template
57 | $this->content( Template::Make('product_basket') )
58 | ->set('title',$prod->title)
59 | ->set('amount',$amount)
60 | ->set('price',$prod->price)
61 | ->set('image',resFile($prod->image)) // see config.php where we set up products images folder as resource folder
62 | ->set('add',buildQuery('Basket','Add',array('id'=>$prod->id)))
63 | ->set('remove',buildQuery('Basket','Remove',array('id'=>$prod->id)))
64 | ;
65 | $price_total += $amount * $prod->price;
66 | }
67 | // display total price and the button to go on
68 | $this->content("Total price: $price_total
");
69 | $this->content( uiButton::Textual("Buy now") )->onclick = "location.href = '".buildQuery('Basket','BuyNow')."'";
70 | }
71 | }
72 |
73 | /**
74 | * Adds a product to the basket.
75 | * @attribute[RequestParam('id','int')]
76 | */
77 | function Add($id)
78 | {
79 | // check if the product exists
80 | $ds = model_datasource('system');
81 | $prod = $ds->Query('products')->eq('id',$id)->current();
82 | if( !$prod )
83 | redirect('Basket','Index',array('error'=>'Product not found'));
84 |
85 | // increase the counter for this product
86 | if( !isset($_SESSION['basket'][$id]) )
87 | $_SESSION['basket'][$id] = 0;
88 | $_SESSION['basket'][$id]++;
89 | redirect('Basket','Index');
90 | }
91 |
92 | /**
93 | * Removes an item from the basket.
94 | * @attribute[RequestParam('id','int')]
95 | */
96 | function Remove($id)
97 | {
98 | // check if the product exists
99 | $ds = model_datasource('system');
100 | $prod = $ds->Query('products')->eq('id',$id)->current();
101 | if( !$prod )
102 | redirect('Basket','Index',array('error'=>'Product not found'));
103 |
104 | // decrease the counter for this product
105 | if( isset($_SESSION['basket'][$id]) )
106 | $_SESSION['basket'][$id]--;
107 | // and unset if no more items left
108 | if( $_SESSION['basket'][$id] == 0 )
109 | unset($_SESSION['basket'][$id]);
110 | redirect('Basket','Index');
111 | }
112 |
113 | /**
114 | * Entrypoint for the checkout process.
115 | *
116 | * Requests customers address details and asks for payment processor.
117 | */
118 | function BuyNow()
119 | {
120 | // displays the chechout form, which has all inputs for address on it
121 | $this->content( Template::Make('checkout_form') );
122 | }
123 |
124 | /**
125 | * Persists current basket to the database and starts checkout process.
126 | * @attribute[RequestParam('fname','string')]
127 | * @attribute[RequestParam('lname','string')]
128 | * @attribute[RequestParam('street','string')]
129 | * @attribute[RequestParam('zip','string')]
130 | * @attribute[RequestParam('city','string')]
131 | * @attribute[RequestParam('email','string')]
132 | * @attribute[RequestParam('provider','string')]
133 | */
134 | function StartCheckout($fname,$lname,$street,$zip,$city,$email,$provider)
135 | {
136 | log_debug("StartCheckout($fname,$lname,$street,$zip,$city,$email,$provider)");
137 |
138 | if( !$fname || !$lname || !$street || !$zip || !$city || !$email )
139 | redirect('Basket','Index',array('error'=>'Missing some data'));
140 |
141 | // create a new customer. note that we do not check for existance or stuff.
142 | // this should be part of a real shop system!
143 | $cust = new SampleCustomer();
144 | $cust->fname = $fname;
145 | $cust->lname = $lname;
146 | $cust->street = $street;
147 | $cust->zip = $zip;
148 | $cust->city = $city;
149 | $cust->email = $email;
150 | $cust->price_total = 0;
151 | $cust->Save();
152 |
153 | // create a new order and assign the customer (from above)
154 | $order = new SampleShopOrder();
155 | $order->customer_id = $cust->id;
156 | $order->created = 'now()';
157 | $order->Save();
158 |
159 | // now loop thru the basket-items and add them to the order...
160 | $ds = model_datasource('system');
161 | foreach( $_SESSION['basket'] as $id=>$amount )
162 | {
163 | //... by creating a dataset for each item
164 | $prod = $ds->Query('products')->eq('id',$id)->current();
165 | $item = new SampleShopOrderItem();
166 | $item->order_id = $order->id;
167 | $item->price = $prod->price;
168 | $item->amount = $amount;
169 | $item->title = $prod->title;
170 | $item->tagline = $prod->tagline;
171 | $item->body = $prod->body;
172 | $item->Save();
173 |
174 | $order->price_total += $amount * $prod->price;
175 | }
176 | // save the order again to persist the total amount
177 | $order->Save();
178 | $_SESSION['basket'] = array();
179 |
180 | // finally start the checkout process using the given payment provider
181 | log_debug("Handing control over to payment provider '$provider'");
182 | $p = new $provider();
183 | $p->StartCheckout($order,buildQuery('Basket','PostPayment'));
184 | }
185 |
186 | /**
187 | * This is the return URL for the payment provider.
188 | * Will be called when payment raches a final state, so control is handed over to our
189 | * app again from the payment processor.
190 | */
191 | function PostPayment()
192 | {
193 | // we just display the $_REQUEST data for now. in fact this is the point where some processing
194 | // should take place: send email to the team, that prepares the items for shipping, send email(s) to customer,...
195 | log_debug("PostPayment",$_REQUEST);
196 | $this->content("Payment processed
");
197 | $this->content("Provider returned this data:
".render_var($_REQUEST)."
");
198 | }
199 |
200 | /**
201 | * This is a special handler method for PayPal.
202 | * It will be called asynchronously from PayPal backend so user will never see results of it.
203 | * Just here to update the database when payments are ready or refunded or whatever.
204 | * See https://www.paypal.com/ipn for details but in fact WebFramework will handle this for you.
205 | * Just needs this entry point for the callback.
206 | * @attribute[RequestParam('provider','string')]
207 | */
208 | function Notification($provider)
209 | {
210 | log_debug("Notification",$_REQUEST);
211 | $provider = new $provider();
212 | if( $provider->HandleIPN($_REQUEST) )
213 | die("OK");
214 | die("ERR");
215 | }
216 | }
217 |
--------------------------------------------------------------------------------
/web/sample_shop/controller/products.class.php:
--------------------------------------------------------------------------------
1 |
20 | *
21 | * @author Scavix Software Ltd. & Co. KG http://www.scavix.com
22 | * @copyright since 2012 Scavix Software Ltd. & Co. KG
23 | * @license http://www.opensource.org/licenses/lgpl-license.php LGPL
24 | */
25 | use ScavixWDF\Base\Template;
26 | use ScavixWDF\JQueryUI\uiMessage;
27 |
28 | class Products extends ShopBase
29 | {
30 | /**
31 | * Lists all products.
32 | * @attribute[RequestParam('error','string',false)]
33 | */
34 | function Index($error)
35 | {
36 | // display error message if given
37 | if( $error )
38 | $this->content(uiMessage::Error($error));
39 |
40 | // loop thru the products...
41 | $ds = model_datasource('system');
42 | foreach( $ds->Query('products')->orderBy('title') as $prod )
43 | {
44 | //... and use a template to represent each
45 | $this->content( Template::Make('product_overview') )
46 | ->set('title',$prod->title)
47 | ->set('tagline',$prod->tagline)
48 | ->set('image',resFile($prod->image)) // see config.php where we set up products images folder as resource folder
49 | ->set('link',buildQuery('Products','Details',array('id'=>$prod->id)))
50 | ;
51 | }
52 | }
53 |
54 | /**
55 | * Shows product details
56 | * @attribute[RequestParam('id','int')]
57 | */
58 | function Details($id)
59 | {
60 | // check if product really exists
61 | $ds = model_datasource('system');
62 | $prod = $ds->Query('products')->eq('id',$id)->current();
63 | if( !$prod )
64 | redirect('Products','Index',array('error'=>'Product not found'));
65 |
66 | // create a template with product details
67 | $this->content( Template::Make('product_details') )
68 | ->set('title',$prod->title)
69 | ->set('description',$prod->body)
70 | ->set('image',resFile($prod->image)) // see config.php where we set up products images folder as resource folder
71 | ->set('link',buildQuery('Basket','Add',array('id'=>$prod->id)))
72 | ;
73 | }
74 | }
75 |
--------------------------------------------------------------------------------
/web/sample_shop/controller/shopbase.class.php:
--------------------------------------------------------------------------------
1 |
20 | *
21 | * @author Scavix Software Ltd. & Co. KG http://www.scavix.com
22 | * @copyright since 2012 Scavix Software Ltd. & Co. KG
23 | * @license http://www.opensource.org/licenses/lgpl-license.php LGPL
24 | */
25 | use ScavixWDF\Base\HtmlPage;
26 |
27 | /**
28 | * For now we only use this to have a central derived template for all subclasses.
29 | */
30 | class ShopBase extends HtmlPage
31 | {
32 |
33 | }
34 |
--------------------------------------------------------------------------------
/web/sample_shop/controller/shopbase.tpl.php:
--------------------------------------------------------------------------------
1 |
20 | *
21 | * @author Scavix Software Ltd. & Co. KG http://www.scavix.com
22 | * @copyright since 2012 Scavix Software Ltd. & Co. KG
23 | * @license http://www.opensource.org/licenses/lgpl-license.php LGPL
24 | */
25 | ?>
26 |
36 |
--------------------------------------------------------------------------------
/web/sample_shop/images/product1.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ScavixSoftware/WebFramework/bc8a7c6a2b16ed8ba8fd39bb54e005cd7e6ea91b/web/sample_shop/images/product1.png
--------------------------------------------------------------------------------
/web/sample_shop/images/product2.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ScavixSoftware/WebFramework/bc8a7c6a2b16ed8ba8fd39bb54e005cd7e6ea91b/web/sample_shop/images/product2.png
--------------------------------------------------------------------------------
/web/sample_shop/images/product3.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ScavixSoftware/WebFramework/bc8a7c6a2b16ed8ba8fd39bb54e005cd7e6ea91b/web/sample_shop/images/product3.png
--------------------------------------------------------------------------------
/web/sample_shop/index.php:
--------------------------------------------------------------------------------
1 |
20 | *
21 | * @author Scavix Software Ltd. & Co. KG http://www.scavix.com
22 | * @copyright since 2012 Scavix Software Ltd. & Co. KG
23 | * @license http://www.opensource.org/licenses/lgpl-license.php LGPL
24 | */
25 |
26 | require_once(__DIR__."/../system/system.php");
27 |
28 | switchToDev();
29 | system_init('shop');
30 |
31 | if( isset($_GET['clear']) )
32 | {
33 | cache_clear();
34 | $_SESSION = array();
35 | }
36 |
37 | /**
38 | * Creates a all tables and some sample data.
39 | */
40 | function ensure_db()
41 | {
42 | $flds = array();
43 | foreach( array('email','fname','lname','street','zip','city') as $fld )
44 | $flds[] = "$fld VARCHAR(255)";
45 | $flds = implode(",", $flds);
46 |
47 | $ds = model_datasource('system');
48 | $ds->ExecuteSql("CREATE TABLE IF NOT EXISTS products(id INTEGER,title VARCHAR(50),tagline VARCHAR(100),body TEXT,image VARCHAR(50),price DOUBLE,PRIMARY KEY(id))");
49 | $ds->ExecuteSql("CREATE TABLE IF NOT EXISTS orders(id INTEGER,customer_id INTEGER,status INTEGER,created DATETIME,updated DATETIME,completed DATETIME,deleted DATETIME,price_total DOUBLE,PRIMARY KEY(id))");
50 | $ds->ExecuteSql("CREATE TABLE IF NOT EXISTS items(id INTEGER,order_id INTEGER,title VARCHAR(50),tagline VARCHAR(100),body TEXT,price DOUBLE,amount DOUBLE,PRIMARY KEY(id))");
51 | $ds->ExecuteSql("CREATE TABLE IF NOT EXISTS customers(id INTEGER,$flds,PRIMARY KEY(id))");
52 |
53 | if( $ds->ExecuteScalar("SELECT count(*) FROM products") == 0 )
54 | {
55 | $ds->ExecuteSql("INSERT INTO products(title,tagline,body,image,price)VALUES(?,?,?,?,?)",
56 | array('Product 1','This is short desc for product 1','Here we go with an real description that can be long and will only be displayed on products details page','product1.png',11.99));
57 | $ds->ExecuteSql("INSERT INTO products(title,tagline,body,image,price)VALUES(?,?,?,?,?)",
58 | array('Product 2','Product 2 has a tagline too','But we will go with a short description','product2.png',9.85));
59 | $ds->ExecuteSql("INSERT INTO products(title,tagline,body,image,price)VALUES(?,?,?,?,?)",
60 | array('Product 3','Product 3 tagline: we need that for listings','No desc here too as this is demo data','product3.png',1.99));
61 | }
62 | }
63 | // Not nice to call that every time, but we will go for it in our sample.
64 | ensure_db();
65 |
66 | system_execute();
67 |
--------------------------------------------------------------------------------
/web/sample_shop/model/samplecustomer.class.php:
--------------------------------------------------------------------------------
1 |
20 | *
21 | * @author Scavix Software Ltd. & Co. KG http://www.scavix.com
22 | * @copyright since 2012 Scavix Software Ltd. & Co. KG
23 | * @license http://www.opensource.org/licenses/lgpl-license.php LGPL
24 | */
25 | use ScavixWDF\Model\Model;
26 |
27 | /**
28 | * Represents a customer in the database.
29 | *
30 | * Just a placeholder class to be able to query the DB nicely.
31 | */
32 | class SampleCustomer extends Model
33 | {
34 | /**
35 | * Returns the table name.
36 | * See https://github.com/ScavixSoftware/WebFramework/wiki/classes_essentials_model_model.class#gettablename
37 | */
38 | public function GetTableName() { return 'customers'; }
39 | }
--------------------------------------------------------------------------------
/web/sample_shop/model/sampleshoporder.class.php:
--------------------------------------------------------------------------------
1 |
20 | *
21 | * @author Scavix Software Ltd. & Co. KG http://www.scavix.com
22 | * @copyright since 2012 Scavix Software Ltd. & Co. KG
23 | * @license http://www.opensource.org/licenses/lgpl-license.php LGPL
24 | */
25 | use ScavixWDF\Model\Model;
26 | use ScavixWDF\Payment\IShopOrder;
27 | use ScavixWDF\Payment\ShopOrderAddress;
28 |
29 | /**
30 | * Represents an order in the database.
31 | *
32 | * In fact nothing more than implementations for the inherited Model
33 | * and the implemented IShopOrder interface.
34 | * See https://github.com/ScavixSoftware/WebFramework/wiki/classes_modules_payment#wiki-1c67f96d00c3c22f1ab9002cd0e3acbb
35 | * More logic would go into the Set* methods to handle different order states.
36 | * For our sample we just set the states in the DB.
37 | */
38 | class SampleShopOrder extends Model implements IShopOrder
39 | {
40 | const UNKNOWN = 0;
41 | const PENDING = 10;
42 | const PAID = 20;
43 | const FAILED = 30;
44 | const REFUNDED = 40;
45 |
46 | /**
47 | * Returns the table name.
48 | * See https://github.com/ScavixSoftware/WebFramework/wiki/classes_essentials_model_model.class#gettablename
49 | */
50 | public function GetTableName() { return 'orders'; }
51 |
52 | /**
53 | * Gets the orders address.
54 | * @return ShopOrderAddress The order address
55 | */
56 | public function GetAddress()
57 | {
58 | $res = new ShopOrderAddress();
59 | $res->Firstname = $this->fname;
60 | $res->Lastname = $this->lname;
61 | $res->Address1 = $this->street;
62 | $res->Zip = $this->zip;
63 | $res->City = $this->city;
64 | $res->Email = $this->email;
65 | return $res;
66 | }
67 |
68 | /**
69 | * Gets the currency code.
70 | * @return string A valid currency code
71 | */
72 | public function GetCurrency() { return 'EUR'; }
73 |
74 | /**
75 | * Gets the invoice ID.
76 | * @return mixed Invoice identifier
77 | */
78 | public function GetInvoiceId() { return "I".$this->id; }
79 |
80 | /**
81 | * Gets the order culture code.
82 | *
83 | * See
84 | * @return string Valid culture code
85 | */
86 | public function GetLocale() { return 'en-US'; }
87 |
88 | /**
89 | * Return the total price incl. VAT (if VAT applies for the given country).
90 | * @param float $price The price without VAT.
91 | * @return float Price including VAT (if VAT applies for the country).
92 | */
93 | public function GetTotalPrice($price = false)
94 | {
95 | if( $price !== false )
96 | return $price * ( (1+$this->GetVatPercent()) / 100 );
97 | return $this->price_total * ( (1+$this->GetVatPercent()) / 100 );
98 | }
99 |
100 | /**
101 | * Return the total VAT (if VAT applies for the given country).
102 | * @return float VAT in order currency
103 | */
104 | public function GetTotalVat() { return $this->price_total * ($this->GetVatPercent()/100); }
105 |
106 | /**
107 | * Return the total VAT percent (if VAT applies for the given country).
108 | * @return float VAT percent
109 | */
110 | public function GetVatPercent() { return 19; }
111 |
112 | /**
113 | * Returns all items.
114 | *
115 | * @return array A list of objects
116 | */
117 | public function ListItems() { return SampleShopOrderItem::Make()->eq('order_id',$this->id)->orderBy('id'); }
118 |
119 | /**
120 | * Sets the currency
121 | * @param string $currency_code A valid currency code
122 | * @return void
123 | */
124 | public function SetCurrency($currency_code) { /* we stay with EUR */ }
125 |
126 | /**
127 | * Creates an instance from an order id.
128 | * @return IShopOrder The new/loaded order
129 | */
130 | public static function FromOrderId($order_id)
131 | {
132 | return SampleShopOrder::Make()->eq('id',$order_id)->current();
133 | }
134 |
135 | /**
136 | * Called when the order has failed.
137 | *
138 | * This is a callback from the payment processor. Will be called when there was an error in the payment process.
139 | * This can be synchronous (when cutsomer aborts in then initial payment ui) or asynchronous when something goes wrong
140 | * later in the payment processors processes.
141 | * @param int $payment_provider_type Provider type identifier (::PROCESSOR_PAYPAL, ::PROCESSOR_GATE2SHOP, ...)
142 | * @param mixed $transaction_id Transaction identifier (from the payment provider)
143 | * @param string $statusmsg An optional status message
144 | * @return void
145 | */
146 | public function SetFailed($payment_provider_type, $transaction_id, $statusmsg = false)
147 | {
148 | $this->status = self::FAILED;
149 | $this->updated = $this->deleted = 'now()';
150 | $this->Save();
151 | }
152 |
153 | /**
154 | * Called when the order has been paid.
155 | *
156 | * This is a callback from the payment processor. Will be called when the customer has paid the order.
157 | * @param int $payment_provider_type Provider type identifier (::PROCESSOR_PAYPAL, ::PROCESSOR_GATE2SHOP, ...)
158 | * @param mixed $transaction_id Transaction identifier (from the payment provider)
159 | * @param string $statusmsg An optional status message
160 | * @return void
161 | */
162 | public function SetPaid($payment_provider_type, $transaction_id, $statusmsg = false)
163 | {
164 | $this->status = self::PAID;
165 | $this->updated = $this->completed = 'now()';
166 | $this->Save();
167 | }
168 |
169 | /**
170 | * Called when the order has reached pending state.
171 | *
172 | * This is a callback from the payment processor. Will be called when the customer has paid the order but the
173 | * payment has not yet been finished/approved by the provider.
174 | * @param int $payment_provider_type Provider type identifier (::PROCESSOR_PAYPAL, ::PROCESSOR_GATE2SHOP, ...)
175 | * @param mixed $transaction_id Transaction identifier (from the payment provider)
176 | * @param string $statusmsg An optional status message
177 | * @return void
178 | */
179 | public function SetPending($payment_provider_type, $transaction_id, $statusmsg = false)
180 | {
181 | $this->status = self::PENDING;
182 | $this->updated = 'now()';
183 | $this->Save();
184 | }
185 |
186 | /**
187 | * Called when the order has been refunded.
188 | *
189 | * This is a callback from the payment processor. Will be called when the payment was refunded for any reason.
190 | * This can be reasons from the provider and/or from the customer (when he cancels the payment later).
191 | * @param int $payment_provider_type Provider type identifier (::PROCESSOR_PAYPAL, ::PROCESSOR_GATE2SHOP, ...)
192 | * @param mixed $transaction_id Transaction identifier (from the payment provider)
193 | * @param string $statusmsg An optional status message
194 | * @return void
195 | */
196 | public function SetRefunded($payment_provider_type, $transaction_id, $statusmsg = false)
197 | {
198 | $this->status = self::REFUNDED;
199 | $this->updated = $this->deleted = 'now()';
200 | $this->Save();
201 | }
202 |
203 | /**
204 | * Checks if VAT needs to be paid.
205 | * @return boolean true or false
206 | */
207 | public function DoAddVat() { return true; /* Let's assume normal VAT customers for now */ }
208 | }
--------------------------------------------------------------------------------
/web/sample_shop/model/sampleshoporderitem.class.php:
--------------------------------------------------------------------------------
1 |
20 | *
21 | * @author Scavix Software Ltd. & Co. KG http://www.scavix.com
22 | * @copyright since 2012 Scavix Software Ltd. & Co. KG
23 | * @license http://www.opensource.org/licenses/lgpl-license.php LGPL
24 | */
25 | use ScavixWDF\Model\Model;
26 | use ScavixWDF\Payment\IShopOrderItem;
27 |
28 | /**
29 | * Represents an order item in the database.
30 | *
31 | * In fact nothing more than implementations for the inherited Model
32 | * and the implemented IShopOrderItem interface.
33 | * See https://github.com/ScavixSoftware/WebFramework/wiki/classes_modules_payment#wiki-97745ff2e14aebb2225c7647a8a059bc
34 | */
35 | class SampleShopOrderItem extends Model implements IShopOrderItem
36 | {
37 | /**
38 | * Returns the table name.
39 | * See https://github.com/ScavixSoftware/WebFramework/wiki/classes_essentials_model_model.class#gettablename
40 | */
41 | public function GetTableName() { return 'items'; }
42 |
43 | /**
44 | * Gets the price per item converted into the requested currency.
45 | * @param string $currency Currency code
46 | * @return float The price per item converted into $currency
47 | */
48 | public function GetAmount($currency) { return $this->price; }
49 |
50 | /**
51 | * Gets the discount.
52 | * @return float The discount
53 | */
54 | public function GetDiscount() { return 0; }
55 |
56 | /**
57 | * Gets the handling cost.
58 | * @return float Cost for handling
59 | */
60 | public function GetHandling() { return 0; }
61 |
62 | /**
63 | * Gets the items name.
64 | * @return string The item name
65 | */
66 | public function GetName() { return $this->title; }
67 |
68 | /**
69 | * Gets the quantity.
70 | * @return float The quantity
71 | */
72 | public function GetQuantity() { return $this->amount; }
73 |
74 | /**
75 | * Gets the shipping cost.
76 | * @return float Cost for shipping
77 | */
78 | public function GetShipping() { return 0; }
79 | }
--------------------------------------------------------------------------------
/web/sample_shop/res/shopbase.css:
--------------------------------------------------------------------------------
1 | /**
2 | * Scavix Web Development Framework
3 | *
4 | * Copyright (c) since 2012 Scavix Software Ltd. & Co. KG
5 | *
6 | * This library is free software; you can redistribute it
7 | * and/or modify it under the terms of the GNU Lesser General
8 | * Public License as published by the Free Software Foundation;
9 | * either version 3 of the License, or (at your option) any
10 | * later version.
11 | *
12 | * This library is distributed in the hope that it will be useful,
13 | * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 | * Lesser General Public License for more details.
16 | *
17 | * You should have received a copy of the GNU Lesser General Public
18 | * License along with this library. If not, see
19 | *
20 | * @author Scavix Software Ltd. & Co. KG http://www.scavix.com
21 | * @copyright since 2012 Scavix Software Ltd. & Co. KG
22 | * @license http://www.opensource.org/licenses/lgpl-license.php LGPL
23 | */
24 |
25 | #page { font: 14px normal Verdana,Arial,serif; }
26 | #page > div { width: 960px; margin: auto; }
27 | #navigation { padding-bottom: 10px; border-bottom: 1px solid gray; }
28 | #navigation a
29 | {
30 | font-size: 18px;
31 | font-weight: bold;
32 | margin-right: 15px;
33 | }
34 |
35 | .product_overview
36 | {
37 | clear: both;
38 | margin-top: 25px;
39 | border-bottom: 1px solid gray;
40 | height: 75px;
41 | }
42 |
43 | .product_overview img
44 | {
45 | width: 50px;
46 | float: left;
47 | margin-right: 10px;
48 | }
49 |
50 | .product_overview div
51 | {
52 | white-space: nowrap;
53 | overflow: hidden;
54 | }
55 |
56 | .product_overview .title { font-weight: bold; }
57 | .product_overview a { float: right; }
58 |
59 | .product_basket
60 | {
61 | clear: both;
62 | }
63 |
64 | .product_basket img
65 | {
66 | width: 30px;
67 | float: left;
68 | margin-right: 10px;
69 | }
70 |
71 | .basket_total
72 | {
73 | clear: both;
74 | text-align: right;
75 | font-size: 14px;
76 | font-weight: bold;
77 | }
--------------------------------------------------------------------------------
/web/sample_shop/templates/admin_product_add.tpl.php:
--------------------------------------------------------------------------------
1 |
20 | *
21 | * @author Scavix Software Ltd. & Co. KG http://www.scavix.com
22 | * @copyright since 2012 Scavix Software Ltd. & Co. KG
23 | * @license http://www.opensource.org/licenses/lgpl-license.php LGPL
24 | */
25 | ?>
26 |
--------------------------------------------------------------------------------
/web/sample_shop/templates/checkout_form.tpl.php:
--------------------------------------------------------------------------------
1 |
20 | *
21 | * @author Scavix Software Ltd. & Co. KG http://www.scavix.com
22 | * @copyright since 2012 Scavix Software Ltd. & Co. KG
23 | * @license http://www.opensource.org/licenses/lgpl-license.php LGPL
24 | */
25 | ?>
26 |
--------------------------------------------------------------------------------
/web/sample_shop/templates/product_basket.tpl.php:
--------------------------------------------------------------------------------
1 |
20 | *
21 | * @author Scavix Software Ltd. & Co. KG http://www.scavix.com
22 | * @copyright since 2012 Scavix Software Ltd. & Co. KG
23 | * @license http://www.opensource.org/licenses/lgpl-license.php LGPL
24 | */
25 | ?>
26 |
--------------------------------------------------------------------------------
/web/sample_shop/templates/product_details.tpl.php:
--------------------------------------------------------------------------------
1 |
20 | *
21 | * @author Scavix Software Ltd. & Co. KG http://www.scavix.com
22 | * @copyright since 2012 Scavix Software Ltd. & Co. KG
23 | * @license http://www.opensource.org/licenses/lgpl-license.php LGPL
24 | */
25 | ?>
26 |
--------------------------------------------------------------------------------
/web/sample_shop/templates/product_overview.tpl.php:
--------------------------------------------------------------------------------
1 |
20 | *
21 | * @author Scavix Software Ltd. & Co. KG http://www.scavix.com
22 | * @copyright since 2012 Scavix Software Ltd. & Co. KG
23 | * @license http://www.opensource.org/licenses/lgpl-license.php LGPL
24 | */
25 | ?>
26 |
--------------------------------------------------------------------------------
28 |
29 |
30 | Details...
31 |