Par tipů na lepší názvosloví

David Grudl napsal(a):

• z chystaných věcí: Presenter vyžadující, aby uživatel byl přihlášen, se bude moci označit anotací. Jakou? Název by neměl vzbuzovat dojem, že presenter je „zabezpečený“.

Já na tohle používám abstraktní AuthenticatedPresenter takže /** @authenticated */ by mi proto přišlo intuitivní, ale možná je to jenom můj zvyk.

David Grudl napsal(a):

• „namespaces“ v Session: jmenné prostory v PHP 5.3 jsou ještě příliš čerstvé a dochází ke zmatení pojmů, když namespaces v Session představují něco zcela jiného

collection?

• Helpery u šablon: historický název, avšak kdo skutečně nazývá pravou část makra např. {$price|money} slovem helper?

spíš „modifikátor“

• Form::setDefaults() – není očekávanější spíš setDefaultValues()?

je jedno jak se to jmenuje ale ať je to stejné s BaseControl::setDefaultValue()

• Form::IMAGE jakožto validátor pro obrázky JPEG, PNG a GIF by se spíš mohl jmenovat třeba WEBIMAGE
• obdobně Nette\Http\FileUpload::isImage() → isWebImage() ?

stávající je podle mě OK… WEBIMAGE se mě nelíbí

• Form::$onSubmit zahrnuje i to, že formulář musí být validní, což není zřejmé. Zvolit jinou událost?

Form::$onValidSubmit ?

• nové Cache::start() pro kešování výstupu je poněkud zavádějící

Co to to?

• z chystaných věcí: Presenter vyžadující, aby uživatel byl přihlášen, se bude moci označit anotací. Jakou? Název by neměl vzbuzovat dojem, že presenter je „zabezpečený“.

User::isLoggedIn() → @loggedIn

• objeví se defaultní presentery (např. ErrorPresenter), jaký jim dát název modulu?

Žádný? spíš zavést namespace App

David Grudl napsal(a):

• Form::setDefaults() – není očekávanější spíš setDefaultValues()?

Přidávám hlas pro setDefaultValues

• Form::IMAGE jakožto validátor pro obrázky JPEG, PNG a GIF by se spíš mohl jmenovat třeba WEBIMAGE
• obdobně Nette\Http\FileUpload::isImage() → isWebImage() ?

Tohle mi přijde jako z bláta do louže. Kde je specifikované co je web image? Budu si muset pamatovat úplně stejně jako u samotného image, že se jedná pouze o JPEG,PNG a GIF…

• Form::addDynamic, addElastic či addRepeater?

Zvolil bych addDynamic – lidé vytvářejí témata s návy typu „dynamické formuláře“, proto mi přijde slovo dynamic jako nejlépe výstižné (zvážil bych možná addDynamicPart)

• User::setAuthenticationHandler() – z hlavy to neumím napsat, nebyl by lepší název podle interface User::setAuthenticator() a obdobně User::setAuthorizator() ?

Tohle si myslím že by byla drobná změna k lepšímu, ale obejdu se bez toho…

• z chystaných věcí: Presenter vyžadující, aby uživatel byl přihlášen, se bude moci označit anotací. Jakou? Název by neměl vzbuzovat dojem, že presenter je „zabezpečený“.

Pro tohle používám anotaci @authenticated, pokud pak potřebuji vyjímku použiju u action/render metody @unauthenticated

• session collection? To snad né…to smrdí kolekcema ;-)
• modifikátor? To snad také ne… Vykřikněte v místnosti plné programátorů „Modifikátor!!!“ a věřím tomu, že sborově odpoví „Přístupu!!!“…helper mi přijde ok.
• Rozhodně onValidSubmit[]…když používám onSubmit[], tak si vždycky říkám…„Jojo, to je vlastně ta událost, kde v názvu chybí slovo“…:-)
• setDefaultValues() je krásně vystihující.

…na ostatní zatím nemám názor…

Edit:

• session…jen mi ještě tak blesklo hlavou, co třeba jenom space? Možná je to úplná ptákovina, možná ne…kdo ví…je to myšlenka úterní půlnoci :-) Ještě mě teda napadlo scope, ale to je možná ještě víc mimo…nebo ne? :-)

Editoval Ondřej Brejla (10. 5. 2011 23:40)

• modifikátor je podle mě odpovídající označení
• onValidSubmit zní ok
• WEBIMAGE určitě ne – co to je „web image“?
• addDynamic zní univerzálněji, addRepeater nezní špatně ale neznalý nevim jestli pochopí…
• addUpload zní dobře

isImage(), Form::IMAGE nechat, z názvu a kontextu je jasné, co dělají.

Helpery také nechat, nevidím důvod pro přejmenování. Z názvu je opět jasné, jaký je jejich účel.

David Grudl napsal(a):

• Helpery u šablon: historický název, avšak kdo skutečně nazývá pravou část makra např. {$price|money} slovem helper?

Já jo. Ale je pravda, že jsem se to naučil od Nette, tak nevím, jestli je to správně.

• Form::$onSubmit zahrnuje i to, že formulář musí být validní, což není zřejmé. Zvolit jinou událost?

Pokud bude onSubmit zachováno s tím, že bude přijímat i nevalidní data, tak tohle je naprosto zásadní nekompatibilita, která může nasekat bezpečnostní díry do webů nic netušících updatujících uživatelů. Navíc mi současný onSubmit naprosto vyhovuje, proč bych měl zpracovávat nevalidní formulář?

• Form::addDynamic, addElastic či addRepeater?

asi Repeater

• User::setAuthenticationHandler() – z hlavy to neumím napsat, nebyl by lepší název podle interface User::setAuthenticator() a obdobně User::setAuthorizator() ?

asi jo

• objeví se defaultní presentery (např. ErrorPresenter), jaký jim dát název modulu?

Nette

• session: section se mi líbi asi nejvíc
• Form::$onSubmit → $onSuccess jsem měl v plánu (a také + $onError). Zpětnou kompatibilitu je třeba zachovat. Návrh: $onSubmit, pokud je prázdné $onSuccess, se bude chovat po staru, jinak ponovu.
• Form::addRepeater nejpřesněji vystihuje podstatu prvku, pojem dynamický je širší a zahrnuje třeba i provázané selectboxy apod.
• anotace pro presenter a metody: @authenticated bez napovídání nedám :-) Asi by bylo vhodnější @loggedIn podle vzoru $user->loggedIn. Šlo by to použít i ve variantách jako @loggedIn(role = admin). Jak ale zapsat výjimku, když by jedna metoda neměla být loggedIn?

• Form::setDefaultValues() mi připadá lepší, proč varianta bez „s“?
• Form::addFileUpload(), addImageButton() a addSubmitButton() je takřka jednomyslná shoda. Ještě mě napadá, že v názvu addHidden() chybí podstatné jméno.

• Control::invalidateControl() – co třeba nějaký paintControl, repaint, redraw?

• SelectBox::skipFirst() – navrhuji setPrompt(). Připomíná mi to staré dobré časy s DOSem ;-)

• WEBIMAGE: je to vlastně totéž jako (dříve používané) webcolors. PHP umí zpracovat a prohlížeče zobrazit jen tři formáty, kdežto obrázek může být také BMP a TIFF (možná ještě ICO, nic dalšího se nepoužívá). Tohle je potřeba v názvosloví nějak postihnout.

norbe napsal(a):

Tohle mi přijde jako z bláta do louže. Kde je specifikované co je web image?

Zde http://www.w3.org/Graphics/ a http://www.w3.org/…objects.html#…

co refresh()?

/**
 * @user(loggedIn, role = admin)
 */
Presenter
{
    /**
     * @user()
     */
    method()
}

Nebolo by na mieste zaviesť i prefix, ktorý by riešil prípadné kolízie s phpdoc, tak ako je to pri latte? Písanie @n:user() je trochu krkolomné, ale napr. @@user() alebo n@user() by sa písalo o čosi ľahšie…

David Grudl napsal(a):
Zde http://www.w3.org/Graphics/ a http://www.w3.org/…objects.html#…

V prvním odkazu vidím např. i formát SVG (který se mi právě při použití webimage ihned vybavil), které podporované není. V druhém příkazu je naopak uvedeno „Examples“ tedy příklady, nikoliv výčet všech možných.

Jako největší argument ale vidím to, že když chci někde přidat validaci pro obrázky, rozhodně mne nenapadne začínat slovem WEB a nebude mi teda fungovat napovídání v IDE (jestli jsem výjimka tak ať se to klidně přejmenuje).

• SelectBox::skipFirst(): po vzoru textboxů v HTML5 by mohlo být setPlaceholder()
• v názvu addHidden() chybí podstatné jméno: hidden je vlastně blbý název přejatý z HTML. co vymyslet lepší? addVariable(), addParameter()…

Form::addDynamic, addElastic či addRepeater?

Jsem pro ponechání addDynamic, popř. addRepeater.
U addElastic by nebylo jasné jakou vlastnost form má.

Zdravím,

nenašel jsem lepší sekci, než je tato stará.

IE je schopný mime jpegu předat jako image/pjpeg.
Chtělo by to statickou metodu, která určí, zda-li jde o webimage či ne.