Forums

Unfortunately no one can be told what FluxBB is - you have to see it for yourself.

You are not logged in.

#1 2015-01-13 20:46:12

Franz
Lead developer
From: Germany
Registered: 2008-05-13
Posts: 6,047
Website

2.0 Documentation: First attempt

I just made a little bit of the documentation (especially aimed at developers) of v2.0 available on GitHub: https://github.com/fluxbb/docs.

This is obviously not complete yet, and I am also not sure whether everything is understandable and makes sense. Some things might have been overlooked etc.

But that's why I made it public now, I'd love to have some feedback. And this should also help people understand why things are the way they are in the core of v2.0.


fluxbb.de | develoPHP

"As code is more often read than written it's really important to write clean code."

Offline

#2 2015-01-13 21:23:14

chris98
Member
From: England, United Kingdom
Registered: 2013-05-31
Posts: 906
Website

Re: 2.0 Documentation: First attempt

Hurrah! Always great to hear more about 2.0, and even better in such an easily comprehendible way too. It sounds like the database system of 2.0 is exactly what I've been trying to achieve on my own site.

It certainly sounds very simple from what you've put there, and this is coming from someone who has only really touched on classes before.

Offline

#3 2015-01-13 21:29:54

Franz
Lead developer
From: Germany
Registered: 2008-05-13
Posts: 6,047
Website

Re: 2.0 Documentation: First attempt

Wait, I'm confused.

I didn't even write anything about databases, or did I?


fluxbb.de | develoPHP

"As code is more often read than written it's really important to write clean code."

Offline

#4 2015-01-13 21:44:31

chris98
Member
From: England, United Kingdom
Registered: 2013-05-31
Posts: 906
Website

Re: 2.0 Documentation: First attempt

Wrong terminology, sorry. I meant the queries used to interact with the database, such as these:

$id = $this->get('id');
$sortBy = $this->get('sort_order', 'asc');

Offline

#5 2015-01-14 08:28:03

Franz
Lead developer
From: Germany
Registered: 2008-05-13
Posts: 6,047
Website

Re: 2.0 Documentation: First attempt

Well, apparently I wasn't that clear there. wink

These methods can be used to retrieve any input passed to the action classes. That has nothing to do with database queries...


fluxbb.de | develoPHP

"As code is more often read than written it's really important to write clean code."

Offline

#6 2015-01-14 10:05:10

chris98
Member
From: England, United Kingdom
Registered: 2013-05-31
Posts: 906
Website

Re: 2.0 Documentation: First attempt

I think it must have been partially due to this sentence:

The  get()  method gives the developer access to any parameters passed to the action.

It says it gives them access, but I just assumed that it also automatically ran queries (or at least did something else) based on those parameters somehow. Reading back over that now you've explained it makes we wonder what had happened to me last night smile

Last edited by chris98 (2015-01-14 10:05:24)

Offline

#7 2015-01-17 20:24:44

123
Member
From: Poland
Registered: 2012-07-24
Posts: 323

Re: 2.0 Documentation: First attempt

Good idea.


[img]http://imagizer.imageshack.com/img633/7813/XjQh8f.png[/img]
https://github.com/123s   My profile in github
Ach, lekceważyłaś wolę króla
a w nocy naszego spotkania, śmiałaś się do łez

Offline

#8 2015-01-19 04:07:29

eric235u
Member
From: free software land
Registered: 2008-05-10
Posts: 74
Website

Re: 2.0 Documentation: First attempt

Looks great!


Nonprofit-CRM  Constituent relationship management software, services, and information.

Offline

Board footer

Powered by FluxBB 1.5.8