4 |
|
|
5 |
=head1 DESCRIPTION |
=head1 DESCRIPTION |
6 |
|
|
7 |
This page describes general idea about A3C application and current status of implementation |
This page describes general idea about A3C application and current status of implementation. |
8 |
|
|
9 |
|
Oppinions should be attributed to Dobrica Pavlinusic, and not other developers :-) |
10 |
|
It's surposed to convey a story which is coherent enough for new developer |
11 |
|
to join into project. Most of other documentation is more useful when |
12 |
|
developing and looking into code usage (if it's not documented and tested, |
13 |
|
it doesn't exist) but this part is delivered as pure POD for reading pleasure. |
14 |
|
|
15 |
|
=head1 Models |
16 |
|
|
17 |
|
Models in Jifty are at perl level objects (with validation and |
18 |
|
canonicalization) and tables in database. |
19 |
|
|
20 |
|
For a start, we implement some magic documented in L<A3C::Record> on records |
21 |
|
(rows in database). |
22 |
|
|
23 |
|
Then, we need to mungle data without re-thinking SQL queries which would |
24 |
|
produce same results, so there is L<A3C::SQL> which produce objects that |
25 |
|
look like L<Jifty::Collection>s, but aren't. This allows us to switch into |
26 |
|
SQL in views if needed. |
27 |
|
|
28 |
|
This method is not perfect, and shouldn't be used instead of Jifty models |
29 |
|
just to write SQL because it doesn't do any permission checking. However, |
30 |
|
it's a huge help for compex C<GROUP BY> and C<JOIN> queries which are hard |
31 |
|
to express using L<Jifty::DBI>. |
32 |
|
|
33 |
|
If we needed to generate those queries from within program (from user data, |
34 |
|
for example) something like L<Fey::SQL> would be much better tool. |
35 |
|
|
36 |
=head1 LDAP |
=head1 LDAP |
37 |
|
|
101 |
have to take a look in C<lib/Strix.pm>) implements pure DBI code (ported |
have to take a look in C<lib/Strix.pm>) implements pure DBI code (ported |
102 |
from php) to access data directly. Keep in mind that this data have to be |
from php) to access data directly. Keep in mind that this data have to be |
103 |
cached for any resonable performance. On the other hand, data can be |
cached for any resonable performance. On the other hand, data can be |
104 |
structured usefully, for example trees are structured in useful way for JSON |
structured usefully, for example trees are structured in useful way for |
105 |
direct JSON output. |
direct output to JSON. |
106 |
|
|
107 |
If tree has C<class> key, it can be set to C<error> so that we can mark |
If tree has C<class> key, it can be set to C<error> so that we can mark |
108 |
errors in data using same CSS class in views. This might be useful convention. |
errors in data using same CSS class in views. This might be useful convention. |
109 |
|
|
110 |
|
I prefer to keep this file documented up to level that make it's usage from Jifty and |
111 |
|
C<t/50-strix.t> makes sanse, but not more than that. |
112 |
|
|
113 |
=head1 HTML |
=head1 HTML |
114 |
|
|
115 |
We don't generate HTML using templates. In fact, all HTML is encoded in perl |
We don't generate HTML using templates. In fact, all HTML is encoded in perl |
121 |
for us anyway) for easier maintenance, probably by same logic as view names |
for us anyway) for easier maintenance, probably by same logic as view names |
122 |
to skip additional step of mapping when human are watching into code. |
to skip additional step of mapping when human are watching into code. |
123 |
|
|
124 |
|
In long run, this should allow us to refactor templates at code level and |
125 |
|
create different re-usable widgets which brings us to following topic... |
126 |
|
|
127 |
|
=head1 AJAX |
128 |
|
|
129 |
|
Jifty's way of AJAX are L<Jifty::Manual::PageRegions>. |
130 |
|
|
131 |
|
=head2 Strix navigation |
132 |
|
|
133 |
|
L<http://a3c.skole.hr/strix/navigation> |
134 |
|
|
135 |
|
For now, we have implementation of two-level select which is in sync with |
136 |
|
instance clipboard (implemented by L<A3C::Model::StrixInstanceSelection> and |
137 |
|
L<A3C::View::Strix> and L<A3C::Action::StrixSelectSite>. This is |
138 |
|
good candidate to refactor into reusable widget on it's own. |
139 |
|
|
140 |
=head1 BUGS |
=head1 BUGS |
141 |
|
|
142 |
Many probably, documented in C<TODO> which is also useful for quick overview |
Many probably, documented in C<TODO> which is also useful for quick overview |