forked from sribanta/Generatrix
-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathREADME
119 lines (60 loc) · 8.75 KB
/
README
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
Introduction
------------
Generatrix is a MVC framework for PHP5 which is not inspired by existing frameworks but by our belief in Magic. Our idea was to create a framework, where everything works like magic. Some of the concepts might feel a little different if you've worked on other frameworks before, but trust me, whatever we have here, does work like magic.
If you find a bug, please fork this and fix it up. We would be indebited to you for life. If you need our help, let me know.
If you are using this for a college project, apply to us and we will recruit you.
If you are using this for a commercial project, you can either pay us $500 a year or send us a thank you email. We value each of them equally.
If you think it sucks, or just want to get friendly, or want to buy us a beer, or want to talk business, or if you just want to spam us, you can drop us an email at contact@vxtindia.com.
So, what can this thing do for me?
----------------------------------
There are a lot of features planned, but here is the list of features which are already working
1. Database Mapping
One major problem with databases is that everytime you change something in the DB, it's a pain to go and change the same details in the application as well. To fix this issue, we have created a file called databases.php which **automatically** creates classes for each table in your database so that you can directly start accessing them in your code. You would need the command line to do this. Once you are at the root of the app, you can do this - $ ./generatrix prepareModel . As soon as you do this, the code will check if a file called app/model/databases.php is already present. If it is, it will give you the instructions to delete it. If not, we will create a new file. So if the name of your table is cars, you would now have a class classed 'cars' which you can use as - $cars = new cars($this->getDb);
2. Create new Controllers / Views automatically
To create a new view, you don't have to write any code. You can just type the following on the comand line - $ ./generatrix addPage test . It will automatically create two files - app/controllers/testController.php and app/view/testView.php with the basic code already present.
3. Caching Pages
In the file app/settings/config.json, you can set cache-pages as 'true' and set the time to any number of seconds. Now, all your pages will automatically be cached in a file for that duration.
4. Caching Database Queries
In the occasional case that you need to cache database queries, you can set cache-db as 'true' in app/settings/config.json and your queries will start coming from a cache.
5. Better Debug Options
Instead of using the regular var_dump and print_r, which don't display your objects and arrays properly, we have a new function called 'display()' which will highlight the error on the page so that you can see the problem clearly. You can also change the call to display_system() etc to show the message in a different way. You can also stop debugging for production servers, but mentioning 'debug-values' as 'false' in app/settings/config.json . All errors are automatically caught and displayed with the display_error() call. The values output are different depending on if you are viewing them on the browser or CLI (<br> or '\n')
6. Automatic URL Rewriting
All URLs are automatically rewritten in Generatrix. By default a url like http://vxtindia.com/contacts/view would send the request to app/controllers/contactsController.php and call the funtion view() in that file. Once that gets executed, it will call app/views/contactsView.php and call the function view() there.
7. Custom URL Rewriting
Since automatic URL rewriting is such a pain at times, we added a way to map your controllers and functions, so that you can choose which parameter in the url should be the controller and which should be the function that gets called automatically. You can do so by setting 'use-catch-all' to 'true' in app/settings/config.json and editing the file app/settings/mapping.php
8. Database Integration
Unluckily we can only access one database right now. In case you need to access it, all you have to do is enter the details in app/settings/config.json . There will only be one common database object, which will only get created when you make a call to the database. If you don't, the object never initializes.
9. Database Prefixes
You can also use database prefixes, as we have used 'cv_' in the example. If you do that, your class names won't show cv_ in the name. For example, if you are using Wordpress, and you want to access the wp_users table, you can set the 'database-prefix' value to 'wp_' and your class name would now only be 'user'.
10. Use jquery from Google's Servers
If you want to use any of the javascript libraries hosted by google, you can just enter the version number for that file in app/settings/config.json and that file will be loaded automatically. You can use this to load Jquery, JqueryUI, Prototype, Scriptalicious, MooTools, Dojo, SWFObject, YUI or EXT Core.
11. EMail to your heart's content
PHPMailer is included by default, so you can call it whenever you like without downloading and installing it!
12. Works with CLI as well
Any url that can run in the browser can also work in CLI!! I know that's way too cool. To give you an example, if you have your login page as http://vxtindia.com/user/login, you can see the exact same output on CLI by typing ./index.php user login . This works like a charm when you use **cronjobs**
13. Automatically Require Files
All files in app/model, app/controllers, app/views and app/external are automatically included in the system. So you can call them without thinking twice.
14. Break Views in SubViews to reuse!
Since only the view gets called automatically, you can break a page into subviews. You can reuse that subview in any of the views again.
15. Tell the Controller that you're using JSON
The Controller has an option called is_html which if set to false means that you're writing a JSON or XML response. In that case, it doesn't try to include the DOCTYPE automatically. And well, this is the next point.
16. Set DOCTYPE
For all your pages, you can set the doctype automatically by mentioning it the file app/settings/config.json
17. Automatically loads Blueprint-CSS
We love Blueprint so much that we load it automatically in the code for each page. So you can just start typing class='span-24' and it will work. If your page width is not 950px, you can also edit the values in the file public/style/generated.phpx . The .phpx extension is include in .htaccess so you don't have to worry about it. You can just change the variable $total_width to whatever value you like and it should work!
18. Controls for extra functionality
A control is piece of code which contains HTML, CSS and JS for the complete part. You can include any control by simply calling $this->loadControl(). The most popular is going to be Table Control
19. Create Tables of the fly
Using javascript from datatables.net, we convert tables into searchable, paginated data tables as soon as you use the control 'tables' by calling $this->loadControl('table', ...).
20. Database Interactions
All calls to the database returns Associative Arrays. When you select, you get a new row from each new row in the database. When you insert you get the insert_id as the response (again in an array). We can also log the timing required for each database call, if you're worried about your performance. Also doing simple selects, inserts, delets are easier that you can imagine!
21. Curl included by default
So you don't have to download a new version everytime! You can use the class Curl in the system.
22. Export Database
To export the complete database, you can just type the following on the command line - $ ./generatrix exportDb
23. Links, Redirection
Writing relative links is always a problem, so we have made sure that you don't have to do that at all! To write the absolute url, you need to call the function href('/user/login') and the parameters are from the root of Generatrix and not of the server. Redirections works in a similar way. You only need to mention the path from the Generatrix root.
24. You love Timthumb, So do we.
A function call to image($path, $height, $width), returns the path using timthumb.php. For example, I have an image at http://vxtindia.com/test/something/vercingetorix.gif, and I need to display it in size 50x50, we can go - <img src="<?php image('/test/something/vercingetorix.gif', 50, 50); ?>" />
25. Include external Classes
To include any external class in the code, just copy it to app/external and it will automatically be loaded. If you have a folder, you can move the folder to the external folder and write a file outside which access the values inside the new folder.