On Feb 16, 7:35 pm, brian <[email protected]> wrote:
> On Mon, Feb 16, 2009 at 1:08 PM, haj <[email protected]> wrote:
>
> > More detailed explanation and examples in the API doc would be
> > seriously helpful especially to newer users.
>
> > I wish it had comment section like PHP doc site.
>
> I'll second that. Though, unlike the PHP manual, the API is created
> from the actual source, so it's reasonable that there are few
> examples. Better would be comments in the cookbook,
Why add comments? Everyone and anyone can and should add whatever they
feel is appropriate to the *contents* of the book. Submissions are
reviewed for consistency but you (I'm pointing at yous, readers ;) )
are able to add to/edit/translate the whole thing. Speak to _psychic_
about any significant additions/changes you want to make first just so
your efforts don't sit in the pending que for too long. One thing:
don't make "suggestions" which are a request for someone else to write
docs - the book is a community effort, not a public todo/request list
for someone else.
It is underway to enable automatic linking from the api to the book's
contents, so you can go from the API directly to the more detailed
explanation, although the book search should provide sufficient hints
where to look for any particular method.
Regarding deprecation of methods such as findAll findNeighbors etc.
I would have thought it's obvious, but the new syntax ensures
consistency.
$params = array('conditions' => $conditions, ...);
$all = $this->find('all', $params);
$names = $this->find('list', $params);
$params['field'] = $this->displayField;
$nameNeighbors = $this->find('neighbors', $params);
$custom = $this->find('someCustomType', $params);
There's no need to even glance at the api to know what params to pass.
findAll, find, findNeighbors etc. each had different params, which
means you can't know what to do without looking and/or remembering.
AD
--~--~---------~--~----~------------~-------~--~----~
You received this message because you are subscribed to the Google Groups
"CakePHP" group.
To post to this group, send email to [email protected]
To unsubscribe from this group, send email to
[email protected]
For more options, visit this group at
http://groups.google.com/group/cake-php?hl=en
-~----------~----~----~----~------~----~------~--~---
