Nette – API Reference
- Inza
- Člen | 330
Podobně jako např. u jazyka Java plní API roli jakési referenční příručky dovedené „at absurdum“. Když si programátor neví rady s konkrétní třídou, interface, či metodou – ve smyslu počtu a pořadí jejích argumentů, návratového typu, či rámcového popisu funkce, pomocí API může tyto informace rychle a efektivně najít. Taktéž bude možná v budoucnu možné integrací tohoto API do IDE rozšířit možnosti tohoto IDE např. o typovou kontrolu Nette kódu a další věci (to je aktuálně vzhledem k aktuálnímu stavu všech IDE pro PHP utopie, ale třeba někdy…).
Toto je jediná část dokumentace, kterou v podstatě již máme hotovou – díky tomu, že David pečlivě kód komentoval a díky tomu, že existují nástroje, jako je phpDocumentor. Jediné nad čím je třeba se zde zamyslet, je, zda do API neintegrovat ke každé třídě kde to má nějaký smysl příklad jejího použití – má to tak například JQuery – ale možná by bylo lepší toto mít až jako součást PRG…
Měla by:
- Poskytovat rychlou a efektivní cestu k získání určitého druhu informací
Neměla by:
- Poskytovat informace, které jsou poskytovány lepším způsobem jinými druhy dokumentace – například informace ve smyslu „jak na to“
Co si vy myslíte o Nette API? – Co byste doplnili/upravili/změnili na jeho aktuální podobě?
- Patrik Votoček
- Člen | 2221
Inza napsal(a):
… Jediné nad čím je třeba se zde zamyslet, je, zda do API neintegrovat ke každé třídě kde to má nějaký smysl příklad jejího použití – má to tak například JQuery – ale možná by bylo lepší toto mít až jako součást PRG…
Řel bych že tady už to je a je to tam dost dlouho https://api.nette.org/…ms/Form.html
- Inza
- Člen | 330
vrtak-cz napsal(a):
Řekl bych že tady už to je a je to tam dost dlouho https://api.nette.org/…ms/Form.html
To ano, ale já narážím na to, že to není zcela všude, kde by mělo být – viz. Nette/Cache, Nette/Config, atd.
- Honza Marek
- Člen | 1664
Řel bych že tady už to je a je to tam dost dlouho https://api.nette.org/…ms/Form.html
Ha o tom ani nevim.
- David Grudl
- Nette Core | 8218
V API vyhledává Zend Lucene, na webu vyhledává Google a ve fóru PunBB & Google. Na zdrojáky by se teoreticky dal použít Google Code.
Jako nejlepší se mi asi jeví Google (nikoliv Google Code), klíčové je ale to, aby indexoval weby rychle. Výsledky na API jsou skutečně mizerné, zkusil jsem tam dát taky Google a uvidíme. Nebo víte o něčem lepším?
- Inza
- Člen | 330
David Grudl napsal(a):
V API vyhledává Zend Lucene, na webu vyhledává Google a ve fóru PunBB & Google. Na zdrojáky by se teoreticky dal použít Google Code.
Jako nejlepší se mi asi jeví Google (nikoliv Google Code), klíčové je ale to, aby indexoval weby rychle. Výsledky na API jsou skutečně mizerné, zkusil jsem tam dát taky Google a uvidíme. Nebo víte o něčem lepším?
Pro API nevím, ale pro web – co to integrovat do té naší Nette wiki? – totéž pro fórum… Nebyly by pak výsledky lepší?
- David Grudl
- Nette Core | 8218
Inza napsal(a):
Pro API nevím, ale pro web – co to integrovat do té naší Nette wiki? – totéž pro fórum… Nebyly by pak výsledky lepší?
Nerozumím – integrovat Google? Ten už tam je.
- Inza
- Člen | 330
David Grudl napsal(a):
Inza napsal(a):
Pro API nevím, ale pro web – co to integrovat do té naší Nette wiki? – totéž pro fórum… Nebyly by pak výsledky lepší?
Nerozumím – integrovat Google? Ten už tam je.
NN nemyslel jsem integrovat Google, ale integrovat schopnost vyhledávání do Nette-wiki – jako že to napsat, páč by ty výsledky pak asi byly lepší…
- David Grudl
- Nette Core | 8218
Ale co je to „schopnost vyhledávání“? Jaký engine to bude zajišťovat? Lucene, Google, nějaký jiný?
- Inza
- Člen | 330
David Grudl napsal(a):
Ale co je to „schopnost vyhledávání“? Jaký engine to bude zajišťovat? Lucene, Google, nějaký jiný?
Aby to umělo vyhledávat – mít políčko hledej a zobrazit výsledky. Co tím chci říct: to současné hledání google je na nic. Nenajdi tím nic, ono to proleze všechny stránky a zobrazí mi výsledky. Ale podle mě by bylo lepší to vyhledávání naférovku implementovat v tom systému (webové aplikaci Nette-wiki) – jako že se to zeptá DB a zobrazí to z ní výsledky.
Podle mě by použitelnost takového vyhledávání byla mnohem větší.
Mám tím na mysli neintegrovat něčí řešení ale napsání vlastního, šitého „na míru“ – protože takové řešení by pak prohledávalo POUZE relevantní data (obsah databáze) a ne celé stránky. Navíc by to mohlo zobrazovat výsledky inteligentně…
- David Grudl
- Nette Core | 8218
Napsat vyhledávací engine je něco jako napsat vlastní PHP. To je utopie. Tudíž zůstává otázka, jaký existující engine zvolit.
to současné hledání google je na nic. Nenajdi tím nic, ono to proleze všechny stránky a zobrazí mi výsledky.
No a to je jakože dobře, ne? ;)
- Tomik
- Nette Evangelist | 485
David Grudl napsal(a):
Napsat vyhledávací engine je něco jako napsat vlastní PHP. To je utopie. Tudíž zůstává otázka, jaký existující engine zvolit.
to současné hledání google je na nic. Nenajdi tím nic, ono to proleze všechny stránky a zobrazí mi výsledky.
No a to je jakože dobře, ne? ;)
Řekl bych, že současné vyhledávání je poměrně funkční a v pohodě..
- David Grudl
- Nette Core | 8218
- crempa
- Člen | 198
Lze ted nejak jednoduse vyhledávat pouze v dokumentaci (tj. bez pouziti nejakych dalsich direktiv treba pro google search). Obcas vim ze neco v dokumentaci nekde je, ale najit to pres vyhledavani je celkem problem, protoze se tam michaji i vysledky z fora a API…
Editoval crempa (17. 4. 2009 21:52)
- kravčo
- Člen | 721
David Grudl napsal(a):
Napsat vyhledávací engine je něco jako napsat vlastní PHP. To je utopie. Tudíž zůstává otázka, jaký existující engine zvolit.
to současné hledání google je na nic. Nenajdi tím nic, ono to proleze všechny stránky a zobrazí mi výsledky.
No a to je jakože dobře, ne? ;)
Mne trochu vadí to, čo tu už niekto spomínal – pri vyhľadávaní na fóre to hľadá na celom webe Nette – na fóre, v dokumentácii aj v API. Keď potrebujem vo fóre niečo nájsť vnímam túto „feature“ skôr kontraproduktívne. Predstavoval by som si to tak, ako je to v API.
Je to zámer?
- David Grudl
- Nette Core | 8218
Ono se to dá přepnout (Upravit výsledky hledání > forum). Bohužel
jsem nezjistil, jak přimět Google hledat přímo v jedné sekci. Leda aby
vyhledávací políčko směřovalo na mezistránku, která tam doplní
more:forum a redirektne na Google.
edit: zkusil jsem to udělat
- David Grudl
- Nette Core | 8218
R2D2 napsal(a):
a když by se s tím pohrálo v tom Lucene, aby byly jasné priority? Titulek > část obsahu, Dokumentace > Api > fórum … a tak
Určitě by se z toho dalo vytáhnout mnohem víc. Narovinu – řešit to nebudu. API i Zend jsou volně ke stažení a pokud se s tím někdo vyhraje a pošle mi kód, rád to na web hodím.
- kravčo
- Člen | 721
David Grudl napsal(a):
Ono se to dá přepnout (Upravit výsledky hledání > forum). Bohužel jsem nezjistil, jak přimět Google hledat přímo v jedné sekci. Leda aby vyhledávací políčko směřovalo na mezistránku, která tam doplní
more:foruma redirektne na Google.
To mi doteraz úplne uniklo :)
edit: zkusil jsem to udělat
Super!