form.inc 196 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805
  1. <?php
  2. /**
  3. * @file
  4. * Functions for form and batch generation and processing.
  5. */
  6. /**
  7. * @defgroup forms Form builder functions
  8. * @{
  9. * Functions that build an abstract representation of a HTML form.
  10. *
  11. * All modules should declare their form builder functions to be in this
  12. * group and each builder function should reference its validate and submit
  13. * functions using \@see. Conversely, validate and submit functions should
  14. * reference the form builder function using \@see. For examples, of this see
  15. * system_modules_uninstall() or user_pass(), the latter of which has the
  16. * following in its doxygen documentation:
  17. * - \@ingroup forms
  18. * - \@see user_pass_validate()
  19. * - \@see user_pass_submit()
  20. *
  21. * @}
  22. */
  23. /**
  24. * @defgroup form_api Form generation
  25. * @{
  26. * Functions to enable the processing and display of HTML forms.
  27. *
  28. * Drupal uses these functions to achieve consistency in its form processing and
  29. * presentation, while simplifying code and reducing the amount of HTML that
  30. * must be explicitly generated by modules.
  31. *
  32. * The primary function used with forms is drupal_get_form(), which is
  33. * used for forms presented interactively to a user. Forms can also be built and
  34. * submitted programmatically without any user input using the
  35. * drupal_form_submit() function.
  36. *
  37. * drupal_get_form() handles retrieving, processing, and displaying a rendered
  38. * HTML form for modules automatically.
  39. *
  40. * Here is an example of how to use drupal_get_form() and a form builder
  41. * function:
  42. * @code
  43. * $form = drupal_get_form('my_module_example_form');
  44. * ...
  45. * function my_module_example_form($form, &$form_state) {
  46. * $form['submit'] = array(
  47. * '#type' => 'submit',
  48. * '#value' => t('Submit'),
  49. * );
  50. * return $form;
  51. * }
  52. * function my_module_example_form_validate($form, &$form_state) {
  53. * // Validation logic.
  54. * }
  55. * function my_module_example_form_submit($form, &$form_state) {
  56. * // Submission logic.
  57. * }
  58. * @endcode
  59. *
  60. * Or with any number of additional arguments:
  61. * @code
  62. * $extra = "extra";
  63. * $form = drupal_get_form('my_module_example_form', $extra);
  64. * ...
  65. * function my_module_example_form($form, &$form_state, $extra) {
  66. * $form['submit'] = array(
  67. * '#type' => 'submit',
  68. * '#value' => $extra,
  69. * );
  70. * return $form;
  71. * }
  72. * @endcode
  73. *
  74. * The $form argument to form-related functions is a structured array containing
  75. * the elements and properties of the form. For information on the array
  76. * components and format, and more detailed explanations of the Form API
  77. * workflow, see the
  78. * @link forms_api_reference.html Form API reference @endlink
  79. * and the
  80. * @link http://drupal.org/node/37775 Form API documentation section. @endlink
  81. * In addition, there is a set of Form API tutorials in
  82. * @link form_example_tutorial.inc the Form Example Tutorial @endlink which
  83. * provide basics all the way up through multistep forms.
  84. *
  85. * In the form builder, validation, submission, and other form functions,
  86. * $form_state is the primary influence on the processing of the form and is
  87. * passed by reference to most functions, so they use it to communicate with
  88. * the form system and each other.
  89. *
  90. * See drupal_build_form() for documentation of $form_state keys.
  91. */
  92. /**
  93. * Returns a renderable form array for a given form ID.
  94. *
  95. * This function should be used instead of drupal_build_form() when $form_state
  96. * is not needed (i.e., when initially rendering the form) and is often
  97. * used as a menu callback.
  98. *
  99. * @param $form_id
  100. * The unique string identifying the desired form. If a function with that
  101. * name exists, it is called to build the form array. Modules that need to
  102. * generate the same form (or very similar forms) using different $form_ids
  103. * can implement hook_forms(), which maps different $form_id values to the
  104. * proper form constructor function. Examples may be found in node_forms(),
  105. * and search_forms(). hook_forms() can also be used to define forms in
  106. * classes.
  107. * @param ...
  108. * Any additional arguments are passed on to the functions called by
  109. * drupal_get_form(), including the unique form constructor function. For
  110. * example, the node_edit form requires that a node object is passed in here
  111. * when it is called. These are available to implementations of
  112. * hook_form_alter() and hook_form_FORM_ID_alter() as the array
  113. * $form_state['build_info']['args'].
  114. *
  115. * @return
  116. * The form array.
  117. *
  118. * @see drupal_build_form()
  119. */
  120. function drupal_get_form($form_id) {
  121. $form_state = array();
  122. $args = func_get_args();
  123. // Remove $form_id from the arguments.
  124. array_shift($args);
  125. $form_state['build_info']['args'] = $args;
  126. return drupal_build_form($form_id, $form_state);
  127. }
  128. /**
  129. * Builds and process a form based on a form id.
  130. *
  131. * The form may also be retrieved from the cache if the form was built in a
  132. * previous page-load. The form is then passed on for processing, validation
  133. * and submission if there is proper input.
  134. *
  135. * @param $form_id
  136. * The unique string identifying the desired form. If a function with that
  137. * name exists, it is called to build the form array. Modules that need to
  138. * generate the same form (or very similar forms) using different $form_ids
  139. * can implement hook_forms(), which maps different $form_id values to the
  140. * proper form constructor function. Examples may be found in node_forms(),
  141. * and search_forms().
  142. * @param $form_state
  143. * An array which stores information about the form. This is passed as a
  144. * reference so that the caller can use it to examine what in the form changed
  145. * when the form submission process is complete. Furthermore, it may be used
  146. * to store information related to the processed data in the form, which will
  147. * persist across page requests when the 'cache' or 'rebuild' flag is set.
  148. * The following parameters may be set in $form_state to affect how the form
  149. * is rendered:
  150. * - build_info: Internal. An associative array of information stored by Form
  151. * API that is necessary to build and rebuild the form from cache when the
  152. * original context may no longer be available:
  153. * - args: A list of arguments to pass to the form constructor.
  154. * - files: An optional array defining include files that need to be loaded
  155. * for building the form. Each array entry may be the path to a file or
  156. * another array containing values for the parameters 'type', 'module' and
  157. * 'name' as needed by module_load_include(). The files listed here are
  158. * automatically loaded by form_get_cache(). By default the current menu
  159. * router item's 'file' definition is added, if any. Use
  160. * form_load_include() to add include files from a form constructor.
  161. * - form_id: Identification of the primary form being constructed and
  162. * processed.
  163. * - base_form_id: Identification for a base form, as declared in a
  164. * hook_forms() implementation.
  165. * - immutable: If this flag is set to TRUE, a new form build id is
  166. * generated when the form is loaded from the cache. If it is subsequently
  167. * saved to the cache again, it will have another cache id and therefore
  168. * the original form and form-state will remain unaltered. This is
  169. * important when page caching is enabled in order to prevent form state
  170. * from leaking between anonymous users.
  171. * - rebuild_info: Internal. Similar to 'build_info', but pertaining to
  172. * drupal_rebuild_form().
  173. * - rebuild: Normally, after the entire form processing is completed and
  174. * submit handlers have run, a form is considered to be done and
  175. * drupal_redirect_form() will redirect the user to a new page using a GET
  176. * request (so a browser refresh does not re-submit the form). However, if
  177. * 'rebuild' has been set to TRUE, then a new copy of the form is
  178. * immediately built and sent to the browser, instead of a redirect. This is
  179. * used for multi-step forms, such as wizards and confirmation forms.
  180. * Normally, $form_state['rebuild'] is set by a submit handler, since it is
  181. * usually logic within a submit handler that determines whether a form is
  182. * done or requires another step. However, a validation handler may already
  183. * set $form_state['rebuild'] to cause the form processing to bypass submit
  184. * handlers and rebuild the form instead, even if there are no validation
  185. * errors.
  186. * - redirect: Used to redirect the form on submission. It may either be a
  187. * string containing the destination URL, or an array of arguments
  188. * compatible with drupal_goto(). See drupal_redirect_form() for complete
  189. * information.
  190. * - no_redirect: If set to TRUE the form will NOT perform a drupal_goto(),
  191. * even if 'redirect' is set.
  192. * - method: The HTTP form method to use for finding the input for this form.
  193. * May be 'post' or 'get'. Defaults to 'post'. Note that 'get' method
  194. * forms do not use form ids so are always considered to be submitted, which
  195. * can have unexpected effects. The 'get' method should only be used on
  196. * forms that do not change data, as that is exclusively the domain of
  197. * 'post.'
  198. * - cache: If set to TRUE the original, unprocessed form structure will be
  199. * cached, which allows the entire form to be rebuilt from cache. A typical
  200. * form workflow involves two page requests; first, a form is built and
  201. * rendered for the user to fill in. Then, the user fills the form in and
  202. * submits it, triggering a second page request in which the form must be
  203. * built and processed. By default, $form and $form_state are built from
  204. * scratch during each of these page requests. Often, it is necessary or
  205. * desired to persist the $form and $form_state variables from the initial
  206. * page request to the one that processes the submission. 'cache' can be set
  207. * to TRUE to do this. A prominent example is an Ajax-enabled form, in which
  208. * ajax_process_form() enables form caching for all forms that include an
  209. * element with the #ajax property. (The Ajax handler has no way to build
  210. * the form itself, so must rely on the cached version.) Note that the
  211. * persistence of $form and $form_state happens automatically for
  212. * (multi-step) forms having the 'rebuild' flag set, regardless of the value
  213. * for 'cache'.
  214. * - no_cache: If set to TRUE the form will NOT be cached, even if 'cache' is
  215. * set.
  216. * - values: An associative array of values submitted to the form. The
  217. * validation functions and submit functions use this array for nearly all
  218. * their decision making. (Note that #tree determines whether the values are
  219. * a flat array or an array whose structure parallels the $form array. See
  220. * @link forms_api_reference.html Form API reference @endlink for more
  221. * information.) These are raw and unvalidated, so should not be used
  222. * without a thorough understanding of security implications. In almost all
  223. * cases, code should use the data in the 'values' array exclusively. The
  224. * most common use of this key is for multi-step forms that need to clear
  225. * some of the user input when setting 'rebuild'. The values correspond to
  226. * $_POST or $_GET, depending on the 'method' chosen.
  227. * - always_process: If TRUE and the method is GET, a form_id is not
  228. * necessary. This should only be used on RESTful GET forms that do NOT
  229. * write data, as this could lead to security issues. It is useful so that
  230. * searches do not need to have a form_id in their query arguments to
  231. * trigger the search.
  232. * - must_validate: Ordinarily, a form is only validated once, but there are
  233. * times when a form is resubmitted internally and should be validated
  234. * again. Setting this to TRUE will force that to happen. This is most
  235. * likely to occur during Ajax operations.
  236. * - programmed: If TRUE, the form was submitted programmatically, usually
  237. * invoked via drupal_form_submit(). Defaults to FALSE.
  238. * - programmed_bypass_access_check: If TRUE, programmatic form submissions
  239. * are processed without taking #access into account. Set this to FALSE
  240. * when submitting a form programmatically with values that may have been
  241. * input by the user executing the current request; this will cause #access
  242. * to be respected as it would on a normal form submission. Defaults to
  243. * TRUE.
  244. * - process_input: Boolean flag. TRUE signifies correct form submission.
  245. * This is always TRUE for programmed forms coming from drupal_form_submit()
  246. * (see 'programmed' key), or if the form_id coming from the $_POST data is
  247. * set and matches the current form_id.
  248. * - submitted: If TRUE, the form has been submitted. Defaults to FALSE.
  249. * - executed: If TRUE, the form was submitted and has been processed and
  250. * executed. Defaults to FALSE.
  251. * - triggering_element: (read-only) The form element that triggered
  252. * submission. This is the same as the deprecated
  253. * $form_state['clicked_button']. It is the element that caused submission,
  254. * which may or may not be a button (in the case of Ajax forms). This key is
  255. * often used to distinguish between various buttons in a submit handler,
  256. * and is also used in Ajax handlers.
  257. * - clicked_button: Deprecated. Use triggering_element instead.
  258. * - has_file_element: Internal. If TRUE, there is a file element and Form API
  259. * will set the appropriate 'enctype' HTML attribute on the form.
  260. * - groups: Internal. An array containing references to fieldsets to render
  261. * them within vertical tabs.
  262. * - storage: $form_state['storage'] is not a special key, and no specific
  263. * support is provided for it in the Form API. By tradition it was
  264. * the location where application-specific data was stored for communication
  265. * between the submit, validation, and form builder functions, especially
  266. * in a multi-step-style form. Form implementations may use any key(s)
  267. * within $form_state (other than the keys listed here and other reserved
  268. * ones used by Form API internals) for this kind of storage. The
  269. * recommended way to ensure that the chosen key doesn't conflict with ones
  270. * used by the Form API or other modules is to use the module name as the
  271. * key name or a prefix for the key name. For example, the Node module uses
  272. * $form_state['node'] in node editing forms to store information about the
  273. * node being edited, and this information stays available across successive
  274. * clicks of the "Preview" button as well as when the "Save" button is
  275. * finally clicked.
  276. * - buttons: A list containing copies of all submit and button elements in
  277. * the form.
  278. * - complete form: A reference to the $form variable containing the complete
  279. * form structure. #process, #after_build, #element_validate, and other
  280. * handlers being invoked on a form element may use this reference to access
  281. * other information in the form the element is contained in.
  282. * - temporary: An array holding temporary data accessible during the current
  283. * page request only. All $form_state properties that are not reserved keys
  284. * (see form_state_keys_no_cache()) persist throughout a multistep form
  285. * sequence. Form API provides this key for modules to communicate
  286. * information across form-related functions during a single page request.
  287. * It may be used to temporarily save data that does not need to or should
  288. * not be cached during the whole form workflow; e.g., data that needs to be
  289. * accessed during the current form build process only. There is no use-case
  290. * for this functionality in Drupal core.
  291. * - wrapper_callback: Modules that wish to pre-populate certain forms with
  292. * common elements, such as back/next/save buttons in multi-step form
  293. * wizards, may define a form builder function name that returns a form
  294. * structure, which is passed on to the actual form builder function.
  295. * Such implementations may either define the 'wrapper_callback' via
  296. * hook_forms() or have to invoke drupal_build_form() (instead of
  297. * drupal_get_form()) on their own in a custom menu callback to prepare
  298. * $form_state accordingly.
  299. * Information on how certain $form_state properties control redirection
  300. * behavior after form submission may be found in drupal_redirect_form().
  301. *
  302. * @return
  303. * The rendered form. This function may also perform a redirect and hence may
  304. * not return at all, depending upon the $form_state flags that were set.
  305. *
  306. * @see drupal_redirect_form()
  307. */
  308. function drupal_build_form($form_id, &$form_state) {
  309. // Ensure some defaults; if already set they will not be overridden.
  310. $form_state += form_state_defaults();
  311. if (!isset($form_state['input'])) {
  312. $form_state['input'] = $form_state['method'] == 'get' ? $_GET : $_POST;
  313. }
  314. if (isset($_SESSION['batch_form_state'])) {
  315. // We've been redirected here after a batch processing. The form has
  316. // already been processed, but needs to be rebuilt. See _batch_finished().
  317. $form_state = $_SESSION['batch_form_state'];
  318. unset($_SESSION['batch_form_state']);
  319. return drupal_rebuild_form($form_id, $form_state);
  320. }
  321. // If the incoming input contains a form_build_id, we'll check the cache for a
  322. // copy of the form in question. If it's there, we don't have to rebuild the
  323. // form to proceed. In addition, if there is stored form_state data from a
  324. // previous step, we'll retrieve it so it can be passed on to the form
  325. // processing code.
  326. $check_cache = isset($form_state['input']['form_id']) && $form_state['input']['form_id'] == $form_id && !empty($form_state['input']['form_build_id']);
  327. if ($check_cache) {
  328. $form = form_get_cache($form_state['input']['form_build_id'], $form_state);
  329. }
  330. // If the previous bit of code didn't result in a populated $form object, we
  331. // are hitting the form for the first time and we need to build it from
  332. // scratch.
  333. if (!isset($form)) {
  334. // If we attempted to serve the form from cache, uncacheable $form_state
  335. // keys need to be removed after retrieving and preparing the form, except
  336. // any that were already set prior to retrieving the form.
  337. if ($check_cache) {
  338. $form_state_before_retrieval = $form_state;
  339. }
  340. $form = drupal_retrieve_form($form_id, $form_state);
  341. drupal_prepare_form($form_id, $form, $form_state);
  342. // form_set_cache() removes uncacheable $form_state keys defined in
  343. // form_state_keys_no_cache() in order for multi-step forms to work
  344. // properly. This means that form processing logic for single-step forms
  345. // using $form_state['cache'] may depend on data stored in those keys
  346. // during drupal_retrieve_form()/drupal_prepare_form(), but form
  347. // processing should not depend on whether the form is cached or not, so
  348. // $form_state is adjusted to match what it would be after a
  349. // form_set_cache()/form_get_cache() sequence. These exceptions are
  350. // allowed to survive here:
  351. // - always_process: Does not make sense in conjunction with form caching
  352. // in the first place, since passing form_build_id as a GET parameter is
  353. // not desired.
  354. // - temporary: Any assigned data is expected to survives within the same
  355. // page request.
  356. if ($check_cache) {
  357. $uncacheable_keys = array_flip(array_diff(form_state_keys_no_cache(), array('always_process', 'temporary')));
  358. $form_state = array_diff_key($form_state, $uncacheable_keys);
  359. $form_state += $form_state_before_retrieval;
  360. }
  361. }
  362. // Now that we have a constructed form, process it. This is where:
  363. // - Element #process functions get called to further refine $form.
  364. // - User input, if any, gets incorporated in the #value property of the
  365. // corresponding elements and into $form_state['values'].
  366. // - Validation and submission handlers are called.
  367. // - If this submission is part of a multistep workflow, the form is rebuilt
  368. // to contain the information of the next step.
  369. // - If necessary, the form and form state are cached or re-cached, so that
  370. // appropriate information persists to the next page request.
  371. // All of the handlers in the pipeline receive $form_state by reference and
  372. // can use it to know or update information about the state of the form.
  373. drupal_process_form($form_id, $form, $form_state);
  374. // If this was a successful submission of a single-step form or the last step
  375. // of a multi-step form, then drupal_process_form() issued a redirect to
  376. // another page, or back to this page, but as a new request. Therefore, if
  377. // we're here, it means that this is either a form being viewed initially
  378. // before any user input, or there was a validation error requiring the form
  379. // to be re-displayed, or we're in a multi-step workflow and need to display
  380. // the form's next step. In any case, we have what we need in $form, and can
  381. // return it for rendering.
  382. return $form;
  383. }
  384. /**
  385. * Retrieves default values for the $form_state array.
  386. */
  387. function form_state_defaults() {
  388. return array(
  389. 'rebuild' => FALSE,
  390. 'rebuild_info' => array(),
  391. 'redirect' => NULL,
  392. // @todo 'args' is usually set, so no other default 'build_info' keys are
  393. // appended via += form_state_defaults().
  394. 'build_info' => array(
  395. 'args' => array(),
  396. 'files' => array(),
  397. ),
  398. 'temporary' => array(),
  399. 'submitted' => FALSE,
  400. 'executed' => FALSE,
  401. 'programmed' => FALSE,
  402. 'programmed_bypass_access_check' => TRUE,
  403. 'cache'=> FALSE,
  404. 'method' => 'post',
  405. 'groups' => array(),
  406. 'buttons' => array(),
  407. );
  408. }
  409. /**
  410. * Constructs a new $form from the information in $form_state.
  411. *
  412. * This is the key function for making multi-step forms advance from step to
  413. * step. It is called by drupal_process_form() when all user input processing,
  414. * including calling validation and submission handlers, for the request is
  415. * finished. If a validate or submit handler set $form_state['rebuild'] to TRUE,
  416. * and if other conditions don't preempt a rebuild from happening, then this
  417. * function is called to generate a new $form, the next step in the form
  418. * workflow, to be returned for rendering.
  419. *
  420. * Ajax form submissions are almost always multi-step workflows, so that is one
  421. * common use-case during which form rebuilding occurs. See ajax_form_callback()
  422. * for more information about creating Ajax-enabled forms.
  423. *
  424. * @param $form_id
  425. * The unique string identifying the desired form. If a function
  426. * with that name exists, it is called to build the form array.
  427. * Modules that need to generate the same form (or very similar forms)
  428. * using different $form_ids can implement hook_forms(), which maps
  429. * different $form_id values to the proper form constructor function. Examples
  430. * may be found in node_forms() and search_forms().
  431. * @param $form_state
  432. * A keyed array containing the current state of the form.
  433. * @param $old_form
  434. * (optional) A previously built $form. Used to retain the #build_id and
  435. * #action properties in Ajax callbacks and similar partial form rebuilds. The
  436. * only properties copied from $old_form are the ones which both exist in
  437. * $old_form and for which $form_state['rebuild_info']['copy'][PROPERTY] is
  438. * TRUE. If $old_form is not passed, the entire $form is rebuilt freshly.
  439. * 'rebuild_info' needs to be a separate top-level property next to
  440. * 'build_info', since the contained data must not be cached.
  441. *
  442. * @return
  443. * The newly built form.
  444. *
  445. * @see drupal_process_form()
  446. * @see ajax_form_callback()
  447. */
  448. function drupal_rebuild_form($form_id, &$form_state, $old_form = NULL) {
  449. $form = drupal_retrieve_form($form_id, $form_state);
  450. // If only parts of the form will be returned to the browser (e.g., Ajax or
  451. // RIA clients), or if the form already had a new build ID regenerated when it
  452. // was retrieved from the form cache, reuse the existing #build_id.
  453. // Otherwise, a new #build_id is generated, to not clobber the previous
  454. // build's data in the form cache; also allowing the user to go back to an
  455. // earlier build, make changes, and re-submit.
  456. // @see drupal_prepare_form()
  457. $enforce_old_build_id = isset($old_form['#build_id']) && !empty($form_state['rebuild_info']['copy']['#build_id']);
  458. $old_form_is_mutable_copy = isset($old_form['#build_id_old']);
  459. if ($enforce_old_build_id || $old_form_is_mutable_copy) {
  460. $form['#build_id'] = $old_form['#build_id'];
  461. if ($old_form_is_mutable_copy) {
  462. $form['#build_id_old'] = $old_form['#build_id_old'];
  463. }
  464. }
  465. else {
  466. if (isset($old_form['#build_id'])) {
  467. $form['#build_id_old'] = $old_form['#build_id'];
  468. }
  469. $form['#build_id'] = 'form-' . drupal_random_key();
  470. }
  471. // #action defaults to request_uri(), but in case of Ajax and other partial
  472. // rebuilds, the form is submitted to an alternate URL, and the original
  473. // #action needs to be retained.
  474. if (isset($old_form['#action']) && !empty($form_state['rebuild_info']['copy']['#action'])) {
  475. $form['#action'] = $old_form['#action'];
  476. }
  477. drupal_prepare_form($form_id, $form, $form_state);
  478. // Caching is normally done in drupal_process_form(), but what needs to be
  479. // cached is the $form structure before it passes through form_builder(),
  480. // so we need to do it here.
  481. // @todo For Drupal 8, find a way to avoid this code duplication.
  482. if (empty($form_state['no_cache'])) {
  483. form_set_cache($form['#build_id'], $form, $form_state);
  484. }
  485. // Clear out all group associations as these might be different when
  486. // re-rendering the form.
  487. $form_state['groups'] = array();
  488. // Return a fully built form that is ready for rendering.
  489. return form_builder($form_id, $form, $form_state);
  490. }
  491. /**
  492. * Fetches a form from cache.
  493. */
  494. function form_get_cache($form_build_id, &$form_state) {
  495. if ($cached = cache_get('form_' . $form_build_id, 'cache_form')) {
  496. $form = $cached->data;
  497. global $user;
  498. if ((isset($form['#cache_token']) && drupal_valid_token($form['#cache_token'])) || (!isset($form['#cache_token']) && !$user->uid)) {
  499. if ($cached = cache_get('form_state_' . $form_build_id, 'cache_form')) {
  500. // Re-populate $form_state for subsequent rebuilds.
  501. $form_state = $cached->data + $form_state;
  502. // If the original form is contained in include files, load the files.
  503. // @see form_load_include()
  504. $form_state['build_info'] += array('files' => array());
  505. foreach ($form_state['build_info']['files'] as $file) {
  506. if (is_array($file)) {
  507. $file += array('type' => 'inc', 'name' => $file['module']);
  508. module_load_include($file['type'], $file['module'], $file['name']);
  509. }
  510. elseif (file_exists($file)) {
  511. require_once DRUPAL_ROOT . '/' . $file;
  512. }
  513. }
  514. }
  515. // Generate a new #build_id if the cached form was rendered on a cacheable
  516. // page.
  517. if (!empty($form_state['build_info']['immutable'])) {
  518. $form['#build_id_old'] = $form['#build_id'];
  519. $form['#build_id'] = 'form-' . drupal_random_key();
  520. $form['form_build_id']['#value'] = $form['#build_id'];
  521. $form['form_build_id']['#id'] = $form['#build_id'];
  522. unset($form_state['build_info']['immutable']);
  523. }
  524. return $form;
  525. }
  526. }
  527. }
  528. /**
  529. * Stores a form in the cache.
  530. */
  531. function form_set_cache($form_build_id, $form, $form_state) {
  532. // The default cache_form expiration is 6 hours. On busy sites, the cache_form
  533. // table can become very large. A shorter cache lifetime can help to keep the
  534. // table's size under control.
  535. $expire = variable_get('form_cache_expiration', 21600);
  536. // Ensure that the form build_id embedded in the form structure is the same as
  537. // the one passed in as a parameter. This is an additional safety measure to
  538. // prevent legacy code operating directly with form_get_cache and
  539. // form_set_cache from accidentally overwriting immutable form state.
  540. if ($form['#build_id'] != $form_build_id) {
  541. watchdog('form', 'Form build-id mismatch detected while attempting to store a form in the cache.', array(), WATCHDOG_ERROR);
  542. return;
  543. }
  544. // Cache form structure.
  545. if (isset($form)) {
  546. if ($GLOBALS['user']->uid) {
  547. $form['#cache_token'] = drupal_get_token();
  548. }
  549. unset($form['#build_id_old']);
  550. cache_set('form_' . $form_build_id, $form, 'cache_form', REQUEST_TIME + $expire);
  551. }
  552. // Cache form state.
  553. if (variable_get('cache', 0) && drupal_page_is_cacheable()) {
  554. $form_state['build_info']['immutable'] = TRUE;
  555. }
  556. if ($data = array_diff_key($form_state, array_flip(form_state_keys_no_cache()))) {
  557. cache_set('form_state_' . $form_build_id, $data, 'cache_form', REQUEST_TIME + $expire);
  558. }
  559. }
  560. /**
  561. * Returns an array of $form_state keys that shouldn't be cached.
  562. */
  563. function form_state_keys_no_cache() {
  564. return array(
  565. // Public properties defined by form constructors and form handlers.
  566. 'always_process',
  567. 'must_validate',
  568. 'rebuild',
  569. 'rebuild_info',
  570. 'redirect',
  571. 'no_redirect',
  572. 'temporary',
  573. // Internal properties defined by form processing.
  574. 'buttons',
  575. 'triggering_element',
  576. 'clicked_button',
  577. 'complete form',
  578. 'groups',
  579. 'input',
  580. 'method',
  581. 'submit_handlers',
  582. 'submitted',
  583. 'executed',
  584. 'validate_handlers',
  585. 'values',
  586. );
  587. }
  588. /**
  589. * Ensures an include file is loaded whenever the form is processed.
  590. *
  591. * Example:
  592. * @code
  593. * // Load node.admin.inc from Node module.
  594. * form_load_include($form_state, 'inc', 'node', 'node.admin');
  595. * @endcode
  596. *
  597. * Use this function instead of module_load_include() from inside a form
  598. * constructor or any form processing logic as it ensures that the include file
  599. * is loaded whenever the form is processed. In contrast to using
  600. * module_load_include() directly, form_load_include() makes sure the include
  601. * file is correctly loaded also if the form is cached.
  602. *
  603. * @param $form_state
  604. * The current state of the form.
  605. * @param $type
  606. * The include file's type (file extension).
  607. * @param $module
  608. * The module to which the include file belongs.
  609. * @param $name
  610. * (optional) The base file name (without the $type extension). If omitted,
  611. * $module is used; i.e., resulting in "$module.$type" by default.
  612. *
  613. * @return
  614. * The filepath of the loaded include file, or FALSE if the include file was
  615. * not found or has been loaded already.
  616. *
  617. * @see module_load_include()
  618. */
  619. function form_load_include(&$form_state, $type, $module, $name = NULL) {
  620. if (!isset($name)) {
  621. $name = $module;
  622. }
  623. if (!isset($form_state['build_info']['files']["$module:$name.$type"])) {
  624. // Only add successfully included files to the form state.
  625. if ($result = module_load_include($type, $module, $name)) {
  626. $form_state['build_info']['files']["$module:$name.$type"] = array(
  627. 'type' => $type,
  628. 'module' => $module,
  629. 'name' => $name,
  630. );
  631. return $result;
  632. }
  633. }
  634. return FALSE;
  635. }
  636. /**
  637. * Retrieves, populates, and processes a form.
  638. *
  639. * This function allows you to supply values for form elements and submit a
  640. * form for processing. Compare to drupal_get_form(), which also builds and
  641. * processes a form, but does not allow you to supply values.
  642. *
  643. * There is no return value, but you can check to see if there are errors
  644. * by calling form_get_errors().
  645. *
  646. * @param $form_id
  647. * The unique string identifying the desired form. If a function
  648. * with that name exists, it is called to build the form array.
  649. * Modules that need to generate the same form (or very similar forms)
  650. * using different $form_ids can implement hook_forms(), which maps
  651. * different $form_id values to the proper form constructor function. Examples
  652. * may be found in node_forms() and search_forms().
  653. * @param $form_state
  654. * A keyed array containing the current state of the form. Most important is
  655. * the $form_state['values'] collection, a tree of data used to simulate the
  656. * incoming $_POST information from a user's form submission. If a key is not
  657. * filled in $form_state['values'], then the default value of the respective
  658. * element is used. To submit an unchecked checkbox or other control that
  659. * browsers submit by not having a $_POST entry, include the key, but set the
  660. * value to NULL.
  661. * @param ...
  662. * Any additional arguments are passed on to the functions called by
  663. * drupal_form_submit(), including the unique form constructor function.
  664. * For example, the node_edit form requires that a node object be passed
  665. * in here when it is called. Arguments that need to be passed by reference
  666. * should not be included here, but rather placed directly in the $form_state
  667. * build info array so that the reference can be preserved. For example, a
  668. * form builder function with the following signature:
  669. * @code
  670. * function mymodule_form($form, &$form_state, &$object) {
  671. * }
  672. * @endcode
  673. * would be called via drupal_form_submit() as follows:
  674. * @code
  675. * $form_state['values'] = $my_form_values;
  676. * $form_state['build_info']['args'] = array(&$object);
  677. * drupal_form_submit('mymodule_form', $form_state);
  678. * @endcode
  679. * For example:
  680. * @code
  681. * // register a new user
  682. * $form_state = array();
  683. * $form_state['values']['name'] = 'robo-user';
  684. * $form_state['values']['mail'] = 'robouser@example.com';
  685. * $form_state['values']['pass']['pass1'] = 'password';
  686. * $form_state['values']['pass']['pass2'] = 'password';
  687. * $form_state['values']['op'] = t('Create new account');
  688. * drupal_form_submit('user_register_form', $form_state);
  689. * @endcode
  690. */
  691. function drupal_form_submit($form_id, &$form_state) {
  692. if (!isset($form_state['build_info']['args'])) {
  693. $args = func_get_args();
  694. array_shift($args);
  695. array_shift($args);
  696. $form_state['build_info']['args'] = $args;
  697. }
  698. // Merge in default values.
  699. $form_state += form_state_defaults();
  700. // Populate $form_state['input'] with the submitted values before retrieving
  701. // the form, to be consistent with what drupal_build_form() does for
  702. // non-programmatic submissions (form builder functions may expect it to be
  703. // there).
  704. $form_state['input'] = $form_state['values'];
  705. $form_state['programmed'] = TRUE;
  706. $form = drupal_retrieve_form($form_id, $form_state);
  707. // Programmed forms are always submitted.
  708. $form_state['submitted'] = TRUE;
  709. // Reset form validation.
  710. $form_state['must_validate'] = TRUE;
  711. form_clear_error();
  712. drupal_prepare_form($form_id, $form, $form_state);
  713. drupal_process_form($form_id, $form, $form_state);
  714. }
  715. /**
  716. * Retrieves the structured array that defines a given form.
  717. *
  718. * @param $form_id
  719. * The unique string identifying the desired form. If a function
  720. * with that name exists, it is called to build the form array.
  721. * Modules that need to generate the same form (or very similar forms)
  722. * using different $form_ids can implement hook_forms(), which maps
  723. * different $form_id values to the proper form constructor function.
  724. * @param $form_state
  725. * A keyed array containing the current state of the form, including the
  726. * additional arguments to drupal_get_form() or drupal_form_submit() in the
  727. * 'args' component of the array.
  728. */
  729. function drupal_retrieve_form($form_id, &$form_state) {
  730. $forms = &drupal_static(__FUNCTION__);
  731. // Record the $form_id.
  732. $form_state['build_info']['form_id'] = $form_id;
  733. // Record the filepath of the include file containing the original form, so
  734. // the form builder callbacks can be loaded when the form is being rebuilt
  735. // from cache on a different path (such as 'system/ajax'). See
  736. // form_get_cache(). Don't do this in maintenance mode as Drupal may not be
  737. // fully bootstrapped (i.e. during installation) in which case
  738. // menu_get_item() is not available.
  739. if (!isset($form_state['build_info']['files']['menu']) && !defined('MAINTENANCE_MODE')) {
  740. $item = menu_get_item();
  741. if (!empty($item['include_file'])) {
  742. // Do not use form_load_include() here, as the file is already loaded.
  743. // Anyway, form_get_cache() is able to handle filepaths too.
  744. $form_state['build_info']['files']['menu'] = $item['include_file'];
  745. }
  746. }
  747. // We save two copies of the incoming arguments: one for modules to use
  748. // when mapping form ids to constructor functions, and another to pass to
  749. // the constructor function itself.
  750. $args = $form_state['build_info']['args'];
  751. // We first check to see if there's a function named after the $form_id.
  752. // If there is, we simply pass the arguments on to it to get the form.
  753. if (!function_exists($form_id)) {
  754. // In cases where many form_ids need to share a central constructor function,
  755. // such as the node editing form, modules can implement hook_forms(). It
  756. // maps one or more form_ids to the correct constructor functions.
  757. //
  758. // We cache the results of that hook to save time, but that only works
  759. // for modules that know all their form_ids in advance. (A module that
  760. // adds a small 'rate this comment' form to each comment in a list
  761. // would need a unique form_id for each one, for example.)
  762. //
  763. // So, we call the hook if $forms isn't yet populated, OR if it doesn't
  764. // yet have an entry for the requested form_id.
  765. if (!isset($forms) || !isset($forms[$form_id])) {
  766. $forms = module_invoke_all('forms', $form_id, $args);
  767. }
  768. $form_definition = $forms[$form_id];
  769. if (isset($form_definition['callback arguments'])) {
  770. $args = array_merge($form_definition['callback arguments'], $args);
  771. }
  772. if (isset($form_definition['callback'])) {
  773. $callback = $form_definition['callback'];
  774. $form_state['build_info']['base_form_id'] = isset($form_definition['base_form_id']) ? $form_definition['base_form_id'] : $callback;
  775. }
  776. // In case $form_state['wrapper_callback'] is not defined already, we also
  777. // allow hook_forms() to define one.
  778. if (!isset($form_state['wrapper_callback']) && isset($form_definition['wrapper_callback'])) {
  779. $form_state['wrapper_callback'] = $form_definition['wrapper_callback'];
  780. }
  781. }
  782. $form = array();
  783. // We need to pass $form_state by reference in order for forms to modify it,
  784. // since call_user_func_array() requires that referenced variables are passed
  785. // explicitly.
  786. $args = array_merge(array($form, &$form_state), $args);
  787. // When the passed $form_state (not using drupal_get_form()) defines a
  788. // 'wrapper_callback', then it requests to invoke a separate (wrapping) form
  789. // builder function to pre-populate the $form array with form elements, which
  790. // the actual form builder function ($callback) expects. This allows for
  791. // pre-populating a form with common elements for certain forms, such as
  792. // back/next/save buttons in multi-step form wizards. See drupal_build_form().
  793. if (isset($form_state['wrapper_callback']) && is_callable($form_state['wrapper_callback'])) {
  794. $form = call_user_func_array($form_state['wrapper_callback'], $args);
  795. // Put the prepopulated $form into $args.
  796. $args[0] = $form;
  797. }
  798. // If $callback was returned by a hook_forms() implementation, call it.
  799. // Otherwise, call the function named after the form id.
  800. $form = call_user_func_array(isset($callback) ? $callback : $form_id, $args);
  801. $form['#form_id'] = $form_id;
  802. return $form;
  803. }
  804. /**
  805. * Processes a form submission.
  806. *
  807. * This function is the heart of form API. The form gets built, validated and in
  808. * appropriate cases, submitted and rebuilt.
  809. *
  810. * @param $form_id
  811. * The unique string identifying the current form.
  812. * @param $form
  813. * An associative array containing the structure of the form.
  814. * @param $form_state
  815. * A keyed array containing the current state of the form. This
  816. * includes the current persistent storage data for the form, and
  817. * any data passed along by earlier steps when displaying a
  818. * multi-step form. Additional information, like the sanitized $_POST
  819. * data, is also accumulated here.
  820. */
  821. function drupal_process_form($form_id, &$form, &$form_state) {
  822. $form_state['values'] = array();
  823. // With $_GET, these forms are always submitted if requested.
  824. if ($form_state['method'] == 'get' && !empty($form_state['always_process'])) {
  825. if (!isset($form_state['input']['form_build_id'])) {
  826. $form_state['input']['form_build_id'] = $form['#build_id'];
  827. }
  828. if (!isset($form_state['input']['form_id'])) {
  829. $form_state['input']['form_id'] = $form_id;
  830. }
  831. if (!isset($form_state['input']['form_token']) && isset($form['#token'])) {
  832. $form_state['input']['form_token'] = drupal_get_token($form['#token']);
  833. }
  834. }
  835. // form_builder() finishes building the form by calling element #process
  836. // functions and mapping user input, if any, to #value properties, and also
  837. // storing the values in $form_state['values']. We need to retain the
  838. // unprocessed $form in case it needs to be cached.
  839. $unprocessed_form = $form;
  840. $form = form_builder($form_id, $form, $form_state);
  841. // Only process the input if we have a correct form submission.
  842. if ($form_state['process_input']) {
  843. drupal_validate_form($form_id, $form, $form_state);
  844. // drupal_html_id() maintains a cache of element IDs it has seen,
  845. // so it can prevent duplicates. We want to be sure we reset that
  846. // cache when a form is processed, so scenarios that result in
  847. // the form being built behind the scenes and again for the
  848. // browser don't increment all the element IDs needlessly.
  849. if (!form_get_errors()) {
  850. // In case of errors, do not break HTML IDs of other forms.
  851. drupal_static_reset('drupal_html_id');
  852. }
  853. if ($form_state['submitted'] && !form_get_errors() && !$form_state['rebuild']) {
  854. // Execute form submit handlers.
  855. form_execute_handlers('submit', $form, $form_state);
  856. // We'll clear out the cached copies of the form and its stored data
  857. // here, as we've finished with them. The in-memory copies are still
  858. // here, though.
  859. if (!variable_get('cache', 0) && !empty($form_state['values']['form_build_id'])) {
  860. cache_clear_all('form_' . $form_state['values']['form_build_id'], 'cache_form');
  861. cache_clear_all('form_state_' . $form_state['values']['form_build_id'], 'cache_form');
  862. }
  863. // If batches were set in the submit handlers, we process them now,
  864. // possibly ending execution. We make sure we do not react to the batch
  865. // that is already being processed (if a batch operation performs a
  866. // drupal_form_submit).
  867. if ($batch =& batch_get() && !isset($batch['current_set'])) {
  868. // Store $form_state information in the batch definition.
  869. // We need the full $form_state when either:
  870. // - Some submit handlers were saved to be called during batch
  871. // processing. See form_execute_handlers().
  872. // - The form is multistep.
  873. // In other cases, we only need the information expected by
  874. // drupal_redirect_form().
  875. if ($batch['has_form_submits'] || !empty($form_state['rebuild'])) {
  876. $batch['form_state'] = $form_state;
  877. }
  878. else {
  879. $batch['form_state'] = array_intersect_key($form_state, array_flip(array('programmed', 'rebuild', 'storage', 'no_redirect', 'redirect')));
  880. }
  881. $batch['progressive'] = !$form_state['programmed'];
  882. batch_process();
  883. // Execution continues only for programmatic forms.
  884. // For 'regular' forms, we get redirected to the batch processing
  885. // page. Form redirection will be handled in _batch_finished(),
  886. // after the batch is processed.
  887. }
  888. // Set a flag to indicate that the form has been processed and executed.
  889. $form_state['executed'] = TRUE;
  890. // Redirect the form based on values in $form_state.
  891. drupal_redirect_form($form_state);
  892. }
  893. // Don't rebuild or cache form submissions invoked via drupal_form_submit().
  894. if (!empty($form_state['programmed'])) {
  895. return;
  896. }
  897. // If $form_state['rebuild'] has been set and input has been processed
  898. // without validation errors, we are in a multi-step workflow that is not
  899. // yet complete. A new $form needs to be constructed based on the changes
  900. // made to $form_state during this request. Normally, a submit handler sets
  901. // $form_state['rebuild'] if a fully executed form requires another step.
  902. // However, for forms that have not been fully executed (e.g., Ajax
  903. // submissions triggered by non-buttons), there is no submit handler to set
  904. // $form_state['rebuild']. It would not make sense to redisplay the
  905. // identical form without an error for the user to correct, so we also
  906. // rebuild error-free non-executed forms, regardless of
  907. // $form_state['rebuild'].
  908. // @todo D8: Simplify this logic; considering Ajax and non-HTML front-ends,
  909. // along with element-level #submit properties, it makes no sense to have
  910. // divergent form execution based on whether the triggering element has
  911. // #executes_submit_callback set to TRUE.
  912. if (($form_state['rebuild'] || !$form_state['executed']) && !form_get_errors()) {
  913. // Form building functions (e.g., _form_builder_handle_input_element())
  914. // may use $form_state['rebuild'] to determine if they are running in the
  915. // context of a rebuild, so ensure it is set.
  916. $form_state['rebuild'] = TRUE;
  917. $form = drupal_rebuild_form($form_id, $form_state, $form);
  918. }
  919. }
  920. // After processing the form, the form builder or a #process callback may
  921. // have set $form_state['cache'] to indicate that the form and form state
  922. // shall be cached. But the form may only be cached if the 'no_cache' property
  923. // is not set to TRUE. Only cache $form as it was prior to form_builder(),
  924. // because form_builder() must run for each request to accommodate new user
  925. // input. Rebuilt forms are not cached here, because drupal_rebuild_form()
  926. // already takes care of that.
  927. if (!$form_state['rebuild'] && $form_state['cache'] && empty($form_state['no_cache'])) {
  928. form_set_cache($form['#build_id'], $unprocessed_form, $form_state);
  929. }
  930. }
  931. /**
  932. * Prepares a structured form array.
  933. *
  934. * Adds required elements, executes any hook_form_alter functions, and
  935. * optionally inserts a validation token to prevent tampering.
  936. *
  937. * @param $form_id
  938. * A unique string identifying the form for validation, submission,
  939. * theming, and hook_form_alter functions.
  940. * @param $form
  941. * An associative array containing the structure of the form.
  942. * @param $form_state
  943. * A keyed array containing the current state of the form. Passed
  944. * in here so that hook_form_alter() calls can use it, as well.
  945. */
  946. function drupal_prepare_form($form_id, &$form, &$form_state) {
  947. global $user;
  948. $form['#type'] = 'form';
  949. $form_state['programmed'] = isset($form_state['programmed']) ? $form_state['programmed'] : FALSE;
  950. // Fix the form method, if it is 'get' in $form_state, but not in $form.
  951. if ($form_state['method'] == 'get' && !isset($form['#method'])) {
  952. $form['#method'] = 'get';
  953. }
  954. // Generate a new #build_id for this form, if none has been set already. The
  955. // form_build_id is used as key to cache a particular build of the form. For
  956. // multi-step forms, this allows the user to go back to an earlier build, make
  957. // changes, and re-submit.
  958. // @see drupal_build_form()
  959. // @see drupal_rebuild_form()
  960. if (!isset($form['#build_id'])) {
  961. $form['#build_id'] = 'form-' . drupal_random_key();
  962. }
  963. $form['form_build_id'] = array(
  964. '#type' => 'hidden',
  965. '#value' => $form['#build_id'],
  966. '#id' => $form['#build_id'],
  967. '#name' => 'form_build_id',
  968. // Form processing and validation requires this value, so ensure the
  969. // submitted form value appears literally, regardless of custom #tree
  970. // and #parents being set elsewhere.
  971. '#parents' => array('form_build_id'),
  972. );
  973. // Add a token, based on either #token or form_id, to any form displayed to
  974. // authenticated users. This ensures that any submitted form was actually
  975. // requested previously by the user and protects against cross site request
  976. // forgeries.
  977. // This does not apply to programmatically submitted forms. Furthermore, since
  978. // tokens are session-bound and forms displayed to anonymous users are very
  979. // likely cached, we cannot assign a token for them.
  980. // During installation, there is no $user yet.
  981. if (!empty($user->uid) && !$form_state['programmed']) {
  982. // Form constructors may explicitly set #token to FALSE when cross site
  983. // request forgery is irrelevant to the form, such as search forms.
  984. if (isset($form['#token']) && $form['#token'] === FALSE) {
  985. unset($form['#token']);
  986. }
  987. // Otherwise, generate a public token based on the form id.
  988. else {
  989. $form['#token'] = $form_id;
  990. $form['form_token'] = array(
  991. '#id' => drupal_html_id('edit-' . $form_id . '-form-token'),
  992. '#type' => 'token',
  993. '#default_value' => drupal_get_token($form['#token']),
  994. // Form processing and validation requires this value, so ensure the
  995. // submitted form value appears literally, regardless of custom #tree
  996. // and #parents being set elsewhere.
  997. '#parents' => array('form_token'),
  998. );
  999. }
  1000. }
  1001. if (isset($form_id)) {
  1002. $form['form_id'] = array(
  1003. '#type' => 'hidden',
  1004. '#value' => $form_id,
  1005. '#id' => drupal_html_id("edit-$form_id"),
  1006. // Form processing and validation requires this value, so ensure the
  1007. // submitted form value appears literally, regardless of custom #tree
  1008. // and #parents being set elsewhere.
  1009. '#parents' => array('form_id'),
  1010. );
  1011. }
  1012. if (!isset($form['#id'])) {
  1013. $form['#id'] = drupal_html_id($form_id);
  1014. }
  1015. $form += element_info('form');
  1016. $form += array('#tree' => FALSE, '#parents' => array());
  1017. if (!isset($form['#validate'])) {
  1018. // Ensure that modules can rely on #validate being set.
  1019. $form['#validate'] = array();
  1020. // Check for a handler specific to $form_id.
  1021. if (function_exists($form_id . '_validate')) {
  1022. $form['#validate'][] = $form_id . '_validate';
  1023. }
  1024. // Otherwise check whether this is a shared form and whether there is a
  1025. // handler for the shared $form_id.
  1026. elseif (isset($form_state['build_info']['base_form_id']) && function_exists($form_state['build_info']['base_form_id'] . '_validate')) {
  1027. $form['#validate'][] = $form_state['build_info']['base_form_id'] . '_validate';
  1028. }
  1029. }
  1030. if (!isset($form['#submit'])) {
  1031. // Ensure that modules can rely on #submit being set.
  1032. $form['#submit'] = array();
  1033. // Check for a handler specific to $form_id.
  1034. if (function_exists($form_id . '_submit')) {
  1035. $form['#submit'][] = $form_id . '_submit';
  1036. }
  1037. // Otherwise check whether this is a shared form and whether there is a
  1038. // handler for the shared $form_id.
  1039. elseif (isset($form_state['build_info']['base_form_id']) && function_exists($form_state['build_info']['base_form_id'] . '_submit')) {
  1040. $form['#submit'][] = $form_state['build_info']['base_form_id'] . '_submit';
  1041. }
  1042. }
  1043. // If no #theme has been set, automatically apply theme suggestions.
  1044. // theme_form() itself is in #theme_wrappers and not #theme. Therefore, the
  1045. // #theme function only has to care for rendering the inner form elements,
  1046. // not the form itself.
  1047. if (!isset($form['#theme'])) {
  1048. $form['#theme'] = array($form_id);
  1049. if (isset($form_state['build_info']['base_form_id'])) {
  1050. $form['#theme'][] = $form_state['build_info']['base_form_id'];
  1051. }
  1052. }
  1053. // Invoke hook_form_alter(), hook_form_BASE_FORM_ID_alter(), and
  1054. // hook_form_FORM_ID_alter() implementations.
  1055. $hooks = array('form');
  1056. if (isset($form_state['build_info']['base_form_id'])) {
  1057. $hooks[] = 'form_' . $form_state['build_info']['base_form_id'];
  1058. }
  1059. $hooks[] = 'form_' . $form_id;
  1060. drupal_alter($hooks, $form, $form_state, $form_id);
  1061. }
  1062. /**
  1063. * Helper function to call form_set_error() if there is a token error.
  1064. */
  1065. function _drupal_invalid_token_set_form_error() {
  1066. $path = current_path();
  1067. $query = drupal_get_query_parameters();
  1068. $url = url($path, array('query' => $query));
  1069. // Setting this error will cause the form to fail validation.
  1070. form_set_error('form_token', t('The form has become outdated. Copy any unsaved work in the form below and then <a href="@link">reload this page</a>.', array('@link' => $url)));
  1071. }
  1072. /**
  1073. * Validates user-submitted form data in the $form_state array.
  1074. *
  1075. * @param $form_id
  1076. * A unique string identifying the form for validation, submission,
  1077. * theming, and hook_form_alter functions.
  1078. * @param $form
  1079. * An associative array containing the structure of the form, which is passed
  1080. * by reference. Form validation handlers are able to alter the form structure
  1081. * (like #process and #after_build callbacks during form building) in case of
  1082. * a validation error. If a validation handler alters the form structure, it
  1083. * is responsible for validating the values of changed form elements in
  1084. * $form_state['values'] to prevent form submit handlers from receiving
  1085. * unvalidated values.
  1086. * @param $form_state
  1087. * A keyed array containing the current state of the form. The current
  1088. * user-submitted data is stored in $form_state['values'], though
  1089. * form validation functions are passed an explicit copy of the
  1090. * values for the sake of simplicity. Validation handlers can also use
  1091. * $form_state to pass information on to submit handlers. For example:
  1092. * $form_state['data_for_submission'] = $data;
  1093. * This technique is useful when validation requires file parsing,
  1094. * web service requests, or other expensive requests that should
  1095. * not be repeated in the submission step.
  1096. */
  1097. function drupal_validate_form($form_id, &$form, &$form_state) {
  1098. $validated_forms = &drupal_static(__FUNCTION__, array());
  1099. if (isset($validated_forms[$form_id]) && empty($form_state['must_validate'])) {
  1100. return;
  1101. }
  1102. // If the session token was set by drupal_prepare_form(), ensure that it
  1103. // matches the current user's session. This is duplicate to code in
  1104. // form_builder() but left to protect any custom form handling code.
  1105. if (!empty($form['#token'])) {
  1106. if (!drupal_valid_token($form_state['values']['form_token'], $form['#token']) || !empty($form_state['invalid_token'])) {
  1107. _drupal_invalid_token_set_form_error();
  1108. // Stop here and don't run any further validation handlers, because they
  1109. // could invoke non-safe operations which opens the door for CSRF
  1110. // vulnerabilities.
  1111. $validated_forms[$form_id] = TRUE;
  1112. return;
  1113. }
  1114. }
  1115. _form_validate($form, $form_state, $form_id);
  1116. $validated_forms[$form_id] = TRUE;
  1117. // If validation errors are limited then remove any non validated form values,
  1118. // so that only values that passed validation are left for submit callbacks.
  1119. if (isset($form_state['triggering_element']['#limit_validation_errors']) && $form_state['triggering_element']['#limit_validation_errors'] !== FALSE) {
  1120. $values = array();
  1121. foreach ($form_state['triggering_element']['#limit_validation_errors'] as $section) {
  1122. // If the section exists within $form_state['values'], even if the value
  1123. // is NULL, copy it to $values.
  1124. $section_exists = NULL;
  1125. $value = drupal_array_get_nested_value($form_state['values'], $section, $section_exists);
  1126. if ($section_exists) {
  1127. drupal_array_set_nested_value($values, $section, $value);
  1128. }
  1129. }
  1130. // A button's #value does not require validation, so for convenience we
  1131. // allow the value of the clicked button to be retained in its normal
  1132. // $form_state['values'] locations, even if these locations are not included
  1133. // in #limit_validation_errors.
  1134. if (isset($form_state['triggering_element']['#button_type'])) {
  1135. $button_value = $form_state['triggering_element']['#value'];
  1136. // Like all input controls, the button value may be in the location
  1137. // dictated by #parents. If it is, copy it to $values, but do not override
  1138. // what may already be in $values.
  1139. $parents = $form_state['triggering_element']['#parents'];
  1140. if (!drupal_array_nested_key_exists($values, $parents) && drupal_array_get_nested_value($form_state['values'], $parents) === $button_value) {
  1141. drupal_array_set_nested_value($values, $parents, $button_value);
  1142. }
  1143. // Additionally, form_builder() places the button value in
  1144. // $form_state['values'][BUTTON_NAME]. If it's still there, after
  1145. // validation handlers have run, copy it to $values, but do not override
  1146. // what may already be in $values.
  1147. $name = $form_state['triggering_element']['#name'];
  1148. if (!isset($values[$name]) && isset($form_state['values'][$name]) && $form_state['values'][$name] === $button_value) {
  1149. $values[$name] = $button_value;
  1150. }
  1151. }
  1152. $form_state['values'] = $values;
  1153. }
  1154. }
  1155. /**
  1156. * Redirects the user to a URL after a form has been processed.
  1157. *
  1158. * After a form is submitted and processed, normally the user should be
  1159. * redirected to a new destination page. This function figures out what that
  1160. * destination should be, based on the $form_state array and the 'destination'
  1161. * query string in the request URL, and redirects the user there.
  1162. *
  1163. * Usually (for exceptions, see below) $form_state['redirect'] determines where
  1164. * to redirect the user. This can be set either to a string (the path to
  1165. * redirect to), or an array of arguments for drupal_goto(). If
  1166. * $form_state['redirect'] is missing, the user is usually (again, see below for
  1167. * exceptions) redirected back to the page they came from, where they should see
  1168. * a fresh, unpopulated copy of the form.
  1169. *
  1170. * Here is an example of how to set up a form to redirect to the path 'node':
  1171. * @code
  1172. * $form_state['redirect'] = 'node';
  1173. * @endcode
  1174. * And here is an example of how to redirect to 'node/123?foo=bar#baz':
  1175. * @code
  1176. * $form_state['redirect'] = array(
  1177. * 'node/123',
  1178. * array(
  1179. * 'query' => array(
  1180. * 'foo' => 'bar',
  1181. * ),
  1182. * 'fragment' => 'baz',
  1183. * ),
  1184. * );
  1185. * @endcode
  1186. *
  1187. * There are several exceptions to the "usual" behavior described above:
  1188. * - If $form_state['programmed'] is TRUE, the form submission was usually
  1189. * invoked via drupal_form_submit(), so any redirection would break the script
  1190. * that invoked drupal_form_submit() and no redirection is done.
  1191. * - If $form_state['rebuild'] is TRUE, the form is being rebuilt, and no
  1192. * redirection is done.
  1193. * - If $form_state['no_redirect'] is TRUE, redirection is disabled. This is
  1194. * set, for instance, by ajax_get_form() to prevent redirection in Ajax
  1195. * callbacks. $form_state['no_redirect'] should never be set or altered by
  1196. * form builder functions or form validation/submit handlers.
  1197. * - If $form_state['redirect'] is set to FALSE, redirection is disabled.
  1198. * - If none of the above conditions has prevented redirection, then the
  1199. * redirect is accomplished by calling drupal_goto(), passing in the value of
  1200. * $form_state['redirect'] if it is set, or the current path if it is
  1201. * not. drupal_goto() preferentially uses the value of $_GET['destination']
  1202. * (the 'destination' URL query string) if it is present, so this will
  1203. * override any values set by $form_state['redirect']. Note that during
  1204. * installation, install_goto() is called in place of drupal_goto().
  1205. *
  1206. * @param $form_state
  1207. * An associative array containing the current state of the form.
  1208. *
  1209. * @see drupal_process_form()
  1210. * @see drupal_build_form()
  1211. */
  1212. function drupal_redirect_form($form_state) {
  1213. // Skip redirection for form submissions invoked via drupal_form_submit().
  1214. if (!empty($form_state['programmed'])) {
  1215. return;
  1216. }
  1217. // Skip redirection if rebuild is activated.
  1218. if (!empty($form_state['rebuild'])) {
  1219. return;
  1220. }
  1221. // Skip redirection if it was explicitly disallowed.
  1222. if (!empty($form_state['no_redirect'])) {
  1223. return;
  1224. }
  1225. // Only invoke drupal_goto() if redirect value was not set to FALSE.
  1226. if (!isset($form_state['redirect']) || $form_state['redirect'] !== FALSE) {
  1227. if (isset($form_state['redirect'])) {
  1228. if (is_array($form_state['redirect'])) {
  1229. call_user_func_array('drupal_goto', $form_state['redirect']);
  1230. }
  1231. else {
  1232. // This function can be called from the installer, which guarantees
  1233. // that $redirect will always be a string, so catch that case here
  1234. // and use the appropriate redirect function.
  1235. $function = drupal_installation_attempted() ? 'install_goto' : 'drupal_goto';
  1236. $function($form_state['redirect']);
  1237. }
  1238. }
  1239. drupal_goto(current_path(), array('query' => drupal_get_query_parameters()));
  1240. }
  1241. }
  1242. /**
  1243. * Performs validation on form elements.
  1244. *
  1245. * First ensures required fields are completed, #maxlength is not exceeded, and
  1246. * selected options were in the list of options given to the user. Then calls
  1247. * user-defined validators.
  1248. *
  1249. * @param $elements
  1250. * An associative array containing the structure of the form.
  1251. * @param $form_state
  1252. * A keyed array containing the current state of the form. The current
  1253. * user-submitted data is stored in $form_state['values'], though
  1254. * form validation functions are passed an explicit copy of the
  1255. * values for the sake of simplicity. Validation handlers can also
  1256. * $form_state to pass information on to submit handlers. For example:
  1257. * $form_state['data_for_submission'] = $data;
  1258. * This technique is useful when validation requires file parsing,
  1259. * web service requests, or other expensive requests that should
  1260. * not be repeated in the submission step.
  1261. * @param $form_id
  1262. * A unique string identifying the form for validation, submission,
  1263. * theming, and hook_form_alter functions.
  1264. */
  1265. function _form_validate(&$elements, &$form_state, $form_id = NULL) {
  1266. // Also used in the installer, pre-database setup.
  1267. $t = get_t();
  1268. // Recurse through all children.
  1269. foreach (element_children($elements) as $key) {
  1270. if (isset($elements[$key]) && $elements[$key]) {
  1271. _form_validate($elements[$key], $form_state);
  1272. }
  1273. }
  1274. // Validate the current input.
  1275. if (!isset($elements['#validated']) || !$elements['#validated']) {
  1276. // The following errors are always shown.
  1277. if (isset($elements['#needs_validation'])) {
  1278. // Verify that the value is not longer than #maxlength.
  1279. if (isset($elements['#maxlength']) && drupal_strlen($elements['#value']) > $elements['#maxlength']) {
  1280. form_error($elements, $t('!name cannot be longer than %max characters but is currently %length characters long.', array('!name' => empty($elements['#title']) ? $elements['#parents'][0] : $elements['#title'], '%max' => $elements['#maxlength'], '%length' => drupal_strlen($elements['#value']))));
  1281. }
  1282. if (isset($elements['#options']) && isset($elements['#value'])) {
  1283. if ($elements['#type'] == 'select') {
  1284. $options = form_options_flatten($elements['#options']);
  1285. }
  1286. else {
  1287. $options = $elements['#options'];
  1288. }
  1289. if (is_array($elements['#value'])) {
  1290. $value = in_array($elements['#type'], array('checkboxes', 'tableselect')) ? array_keys($elements['#value']) : $elements['#value'];
  1291. foreach ($value as $v) {
  1292. if (!isset($options[$v])) {
  1293. form_error($elements, $t('An illegal choice has been detected. Please contact the site administrator.'));
  1294. watchdog('form', 'Illegal choice %choice in !name element.', array('%choice' => $v, '!name' => empty($elements['#title']) ? $elements['#parents'][0] : $elements['#title']), WATCHDOG_ERROR);
  1295. }
  1296. }
  1297. }
  1298. // Non-multiple select fields always have a value in HTML. If the user
  1299. // does not change the form, it will be the value of the first option.
  1300. // Because of this, form validation for the field will almost always
  1301. // pass, even if the user did not select anything. To work around this
  1302. // browser behavior, required select fields without a #default_value get
  1303. // an additional, first empty option. In case the submitted value is
  1304. // identical to the empty option's value, we reset the element's value
  1305. // to NULL to trigger the regular #required handling below.
  1306. // @see form_process_select()
  1307. elseif ($elements['#type'] == 'select' && !$elements['#multiple'] && $elements['#required'] && !isset($elements['#default_value']) && $elements['#value'] === $elements['#empty_value']) {
  1308. $elements['#value'] = NULL;
  1309. form_set_value($elements, NULL, $form_state);
  1310. }
  1311. elseif (!isset($options[$elements['#value']])) {
  1312. form_error($elements, $t('An illegal choice has been detected. Please contact the site administrator.'));
  1313. watchdog('form', 'Illegal choice %choice in %name element.', array('%choice' => $elements['#value'], '%name' => empty($elements['#title']) ? $elements['#parents'][0] : $elements['#title']), WATCHDOG_ERROR);
  1314. }
  1315. }
  1316. }
  1317. // While this element is being validated, it may be desired that some calls
  1318. // to form_set_error() be suppressed and not result in a form error, so
  1319. // that a button that implements low-risk functionality (such as "Previous"
  1320. // or "Add more") that doesn't require all user input to be valid can still
  1321. // have its submit handlers triggered. The triggering element's
  1322. // #limit_validation_errors property contains the information for which
  1323. // errors are needed, and all other errors are to be suppressed. The
  1324. // #limit_validation_errors property is ignored if submit handlers will run,
  1325. // but the element doesn't have a #submit property, because it's too large a
  1326. // security risk to have any invalid user input when executing form-level
  1327. // submit handlers.
  1328. if (isset($form_state['triggering_element']['#limit_validation_errors']) && ($form_state['triggering_element']['#limit_validation_errors'] !== FALSE) && !($form_state['submitted'] && !isset($form_state['triggering_element']['#submit']))) {
  1329. form_set_error(NULL, '', $form_state['triggering_element']['#limit_validation_errors']);
  1330. }
  1331. // If submit handlers won't run (due to the submission having been triggered
  1332. // by an element whose #executes_submit_callback property isn't TRUE), then
  1333. // it's safe to suppress all validation errors, and we do so by default,
  1334. // which is particularly useful during an Ajax submission triggered by a
  1335. // non-button. An element can override this default by setting the
  1336. // #limit_validation_errors property. For button element types,
  1337. // #limit_validation_errors defaults to FALSE (via system_element_info()),
  1338. // so that full validation is their default behavior.
  1339. elseif (isset($form_state['triggering_element']) && !isset($form_state['triggering_element']['#limit_validation_errors']) && !$form_state['submitted']) {
  1340. form_set_error(NULL, '', array());
  1341. }
  1342. // As an extra security measure, explicitly turn off error suppression if
  1343. // one of the above conditions wasn't met. Since this is also done at the
  1344. // end of this function, doing it here is only to handle the rare edge case
  1345. // where a validate handler invokes form processing of another form.
  1346. else {
  1347. drupal_static_reset('form_set_error:limit_validation_errors');
  1348. }
  1349. // Make sure a value is passed when the field is required.
  1350. if (isset($elements['#needs_validation']) && $elements['#required']) {
  1351. // A simple call to empty() will not cut it here as some fields, like
  1352. // checkboxes, can return a valid value of '0'. Instead, check the
  1353. // length if it's a string, and the item count if it's an array.
  1354. // An unchecked checkbox has a #value of integer 0, different than string
  1355. // '0', which could be a valid value.
  1356. $is_countable = is_array($elements['#value']) || $elements['#value'] instanceof Countable;
  1357. $is_empty_multiple = $is_countable && count($elements['#value']) == 0;
  1358. $is_empty_string = (is_string($elements['#value']) && drupal_strlen(trim($elements['#value'])) == 0);
  1359. $is_empty_value = ($elements['#value'] === 0);
  1360. $is_empty_null = is_null($elements['#value']);
  1361. if ($is_empty_multiple || $is_empty_string || $is_empty_value || $is_empty_null) {
  1362. // Although discouraged, a #title is not mandatory for form elements. In
  1363. // case there is no #title, we cannot set a form error message.
  1364. // Instead of setting no #title, form constructors are encouraged to set
  1365. // #title_display to 'invisible' to improve accessibility.
  1366. if (isset($elements['#title'])) {
  1367. form_error($elements, $t('!name field is required.', array('!name' => $elements['#title'])));
  1368. }
  1369. else {
  1370. form_error($elements);
  1371. }
  1372. }
  1373. }
  1374. // Call user-defined form level validators.
  1375. if (isset($form_id)) {
  1376. form_execute_handlers('validate', $elements, $form_state);
  1377. }
  1378. // Call any element-specific validators. These must act on the element
  1379. // #value data.
  1380. elseif (isset($elements['#element_validate'])) {
  1381. foreach ($elements['#element_validate'] as $function) {
  1382. $function($elements, $form_state, $form_state['complete form']);
  1383. }
  1384. }
  1385. $elements['#validated'] = TRUE;
  1386. }
  1387. // Done validating this element, so turn off error suppression.
  1388. // _form_validate() turns it on again when starting on the next element, if
  1389. // it's still appropriate to do so.
  1390. drupal_static_reset('form_set_error:limit_validation_errors');
  1391. }
  1392. /**
  1393. * Executes custom validation and submission handlers for a given form.
  1394. *
  1395. * Button-specific handlers are checked first. If none exist, the function
  1396. * falls back to form-level handlers.
  1397. *
  1398. * @param $type
  1399. * The type of handler to execute. 'validate' or 'submit' are the
  1400. * defaults used by Form API.
  1401. * @param $form
  1402. * An associative array containing the structure of the form.
  1403. * @param $form_state
  1404. * A keyed array containing the current state of the form. If the user
  1405. * submitted the form by clicking a button with custom handler functions
  1406. * defined, those handlers will be stored here.
  1407. */
  1408. function form_execute_handlers($type, &$form, &$form_state) {
  1409. $return = FALSE;
  1410. // If there was a button pressed, use its handlers.
  1411. if (isset($form_state[$type . '_handlers'])) {
  1412. $handlers = $form_state[$type . '_handlers'];
  1413. }
  1414. // Otherwise, check for a form-level handler.
  1415. elseif (isset($form['#' . $type])) {
  1416. $handlers = $form['#' . $type];
  1417. }
  1418. else {
  1419. $handlers = array();
  1420. }
  1421. foreach ($handlers as $function) {
  1422. // Check if a previous _submit handler has set a batch, but make sure we
  1423. // do not react to a batch that is already being processed (for instance
  1424. // if a batch operation performs a drupal_form_submit()).
  1425. if ($type == 'submit' && ($batch =& batch_get()) && !isset($batch['id'])) {
  1426. // Some previous submit handler has set a batch. To ensure correct
  1427. // execution order, store the call in a special 'control' batch set.
  1428. // See _batch_next_set().
  1429. $batch['sets'][] = array('form_submit' => $function);
  1430. $batch['has_form_submits'] = TRUE;
  1431. }
  1432. else {
  1433. $function($form, $form_state);
  1434. }
  1435. $return = TRUE;
  1436. }
  1437. return $return;
  1438. }
  1439. /**
  1440. * Files an error against a form element.
  1441. *
  1442. * When a validation error is detected, the validator calls form_set_error() to
  1443. * indicate which element needs to be changed and provide an error message. This
  1444. * causes the Form API to not execute the form submit handlers, and instead to
  1445. * re-display the form to the user with the corresponding elements rendered with
  1446. * an 'error' CSS class (shown as red by default).
  1447. *
  1448. * The standard form_set_error() behavior can be changed if a button provides
  1449. * the #limit_validation_errors property. Multistep forms not wanting to
  1450. * validate the whole form can set #limit_validation_errors on buttons to
  1451. * limit validation errors to only certain elements. For example, pressing the
  1452. * "Previous" button in a multistep form should not fire validation errors just
  1453. * because the current step has invalid values. If #limit_validation_errors is
  1454. * set on a clicked button, the button must also define a #submit property
  1455. * (may be set to an empty array). Any #submit handlers will be executed even if
  1456. * there is invalid input, so extreme care should be taken with respect to any
  1457. * actions taken by them. This is typically not a problem with buttons like
  1458. * "Previous" or "Add more" that do not invoke persistent storage of the
  1459. * submitted form values. Do not use the #limit_validation_errors property on
  1460. * buttons that trigger saving of form values to the database.
  1461. *
  1462. * The #limit_validation_errors property is a list of "sections" within
  1463. * $form_state['values'] that must contain valid values. Each "section" is an
  1464. * array with the ordered set of keys needed to reach that part of
  1465. * $form_state['values'] (i.e., the #parents property of the element).
  1466. *
  1467. * Example 1: Allow the "Previous" button to function, regardless of whether any
  1468. * user input is valid.
  1469. *
  1470. * @code
  1471. * $form['actions']['previous'] = array(
  1472. * '#type' => 'submit',
  1473. * '#value' => t('Previous'),
  1474. * '#limit_validation_errors' => array(), // No validation.
  1475. * '#submit' => array('some_submit_function'), // #submit required.
  1476. * );
  1477. * @endcode
  1478. *
  1479. * Example 2: Require some, but not all, user input to be valid to process the
  1480. * submission of a "Previous" button.
  1481. *
  1482. * @code
  1483. * $form['actions']['previous'] = array(
  1484. * '#type' => 'submit',
  1485. * '#value' => t('Previous'),
  1486. * '#limit_validation_errors' => array(
  1487. * array('step1'), // Validate $form_state['values']['step1'].
  1488. * array('foo', 'bar'), // Validate $form_state['values']['foo']['bar'].
  1489. * ),
  1490. * '#submit' => array('some_submit_function'), // #submit required.
  1491. * );
  1492. * @endcode
  1493. *
  1494. * This will require $form_state['values']['step1'] and everything within it
  1495. * (for example, $form_state['values']['step1']['choice']) to be valid, so
  1496. * calls to form_set_error('step1', $message) or
  1497. * form_set_error('step1][choice', $message) will prevent the submit handlers
  1498. * from running, and result in the error message being displayed to the user.
  1499. * However, calls to form_set_error('step2', $message) and
  1500. * form_set_error('step2][groupX][choiceY', $message) will be suppressed,
  1501. * resulting in the message not being displayed to the user, and the submit
  1502. * handlers will run despite $form_state['values']['step2'] and
  1503. * $form_state['values']['step2']['groupX']['choiceY'] containing invalid
  1504. * values. Errors for an invalid $form_state['values']['foo'] will be
  1505. * suppressed, but errors flagging invalid values for
  1506. * $form_state['values']['foo']['bar'] and everything within it will be
  1507. * flagged and submission prevented.
  1508. *
  1509. * Partial form validation is implemented by suppressing errors rather than by
  1510. * skipping the input processing and validation steps entirely, because some
  1511. * forms have button-level submit handlers that call Drupal API functions that
  1512. * assume that certain data exists within $form_state['values'], and while not
  1513. * doing anything with that data that requires it to be valid, PHP errors
  1514. * would be triggered if the input processing and validation steps were fully
  1515. * skipped.
  1516. *
  1517. * @param $name
  1518. * The name of the form element. If the #parents property of your form
  1519. * element is array('foo', 'bar', 'baz') then you may set an error on 'foo'
  1520. * or 'foo][bar][baz'. Setting an error on 'foo' sets an error for every
  1521. * element where the #parents array starts with 'foo'.
  1522. * @param $message
  1523. * The error message to present to the user.
  1524. * @param $limit_validation_errors
  1525. * Internal use only. The #limit_validation_errors property of the clicked
  1526. * button, if it exists.
  1527. *
  1528. * @return
  1529. * Return value is for internal use only. To get a list of errors, use
  1530. * form_get_errors() or form_get_error().
  1531. *
  1532. * @see http://drupal.org/node/370537
  1533. * @see http://drupal.org/node/763376
  1534. */
  1535. function form_set_error($name = NULL, $message = '', $limit_validation_errors = NULL) {
  1536. $form = &drupal_static(__FUNCTION__, array());
  1537. $sections = &drupal_static(__FUNCTION__ . ':limit_validation_errors');
  1538. if (isset($limit_validation_errors)) {
  1539. $sections = $limit_validation_errors;
  1540. }
  1541. if (isset($name) && !isset($form[$name])) {
  1542. $record = TRUE;
  1543. if (isset($sections)) {
  1544. // #limit_validation_errors is an array of "sections" within which user
  1545. // input must be valid. If the element is within one of these sections,
  1546. // the error must be recorded. Otherwise, it can be suppressed.
  1547. // #limit_validation_errors can be an empty array, in which case all
  1548. // errors are suppressed. For example, a "Previous" button might want its
  1549. // submit action to be triggered even if none of the submitted values are
  1550. // valid.
  1551. $record = FALSE;
  1552. foreach ($sections as $section) {
  1553. // Exploding by '][' reconstructs the element's #parents. If the
  1554. // reconstructed #parents begin with the same keys as the specified
  1555. // section, then the element's values are within the part of
  1556. // $form_state['values'] that the clicked button requires to be valid,
  1557. // so errors for this element must be recorded. As the exploded array
  1558. // will all be strings, we need to cast every value of the section
  1559. // array to string.
  1560. if (array_slice(explode('][', $name), 0, count($section)) === array_map('strval', $section)) {
  1561. $record = TRUE;
  1562. break;
  1563. }
  1564. }
  1565. }
  1566. if ($record) {
  1567. $form[$name] = $message;
  1568. if ($message) {
  1569. drupal_set_message($message, 'error');
  1570. }
  1571. }
  1572. }
  1573. return $form;
  1574. }
  1575. /**
  1576. * Clears all errors against all form elements made by form_set_error().
  1577. */
  1578. function form_clear_error() {
  1579. drupal_static_reset('form_set_error');
  1580. }
  1581. /**
  1582. * Returns an associative array of all errors.
  1583. */
  1584. function form_get_errors() {
  1585. $form = form_set_error();
  1586. if (!empty($form)) {
  1587. return $form;
  1588. }
  1589. }
  1590. /**
  1591. * Returns the error message filed against the given form element.
  1592. *
  1593. * Form errors higher up in the form structure override deeper errors as well as
  1594. * errors on the element itself.
  1595. */
  1596. function form_get_error($element) {
  1597. $form = form_set_error();
  1598. $parents = array();
  1599. foreach ($element['#parents'] as $parent) {
  1600. $parents[] = $parent;
  1601. $key = implode('][', $parents);
  1602. if (isset($form[$key])) {
  1603. return $form[$key];
  1604. }
  1605. }
  1606. }
  1607. /**
  1608. * Flags an element as having an error.
  1609. */
  1610. function form_error(&$element, $message = '') {
  1611. form_set_error(implode('][', $element['#parents']), $message);
  1612. }
  1613. /**
  1614. * Builds and processes all elements in the structured form array.
  1615. *
  1616. * Adds any required properties to each element, maps the incoming input data
  1617. * to the proper elements, and executes any #process handlers attached to a
  1618. * specific element.
  1619. *
  1620. * This is one of the three primary functions that recursively iterates a form
  1621. * array. This one does it for completing the form building process. The other
  1622. * two are _form_validate() (invoked via drupal_validate_form() and used to
  1623. * invoke validation logic for each element) and drupal_render() (for rendering
  1624. * each element). Each of these three pipelines provides ample opportunity for
  1625. * modules to customize what happens. For example, during this function's life
  1626. * cycle, the following functions get called for each element:
  1627. * - $element['#value_callback']: A function that implements how user input is
  1628. * mapped to an element's #value property. This defaults to a function named
  1629. * 'form_type_TYPE_value' where TYPE is $element['#type'].
  1630. * - $element['#process']: An array of functions called after user input has
  1631. * been mapped to the element's #value property. These functions can be used
  1632. * to dynamically add child elements: for example, for the 'date' element
  1633. * type, one of the functions in this array is form_process_date(), which adds
  1634. * the individual 'year', 'month', 'day', etc. child elements. These functions
  1635. * can also be used to set additional properties or implement special logic
  1636. * other than adding child elements: for example, for the 'fieldset' element
  1637. * type, one of the functions in this array is form_process_fieldset(), which
  1638. * adds the attributes and JavaScript needed to make the fieldset collapsible
  1639. * if the #collapsible property is set. The #process functions are called in
  1640. * preorder traversal, meaning they are called for the parent element first,
  1641. * then for the child elements.
  1642. * - $element['#after_build']: An array of functions called after form_builder()
  1643. * is done with its processing of the element. These are called in postorder
  1644. * traversal, meaning they are called for the child elements first, then for
  1645. * the parent element.
  1646. * There are similar properties containing callback functions invoked by
  1647. * _form_validate() and drupal_render(), appropriate for those operations.
  1648. *
  1649. * Developers are strongly encouraged to integrate the functionality needed by
  1650. * their form or module within one of these three pipelines, using the
  1651. * appropriate callback property, rather than implementing their own recursive
  1652. * traversal of a form array. This facilitates proper integration between
  1653. * multiple modules. For example, module developers are familiar with the
  1654. * relative order in which hook_form_alter() implementations and #process
  1655. * functions run. A custom traversal function that affects the building of a
  1656. * form is likely to not integrate with hook_form_alter() and #process in the
  1657. * expected way. Also, deep recursion within PHP is both slow and memory
  1658. * intensive, so it is best to minimize how often it's done.
  1659. *
  1660. * As stated above, each element's #process functions are executed after its
  1661. * #value has been set. This enables those functions to execute conditional
  1662. * logic based on the current value. However, all of form_builder() runs before
  1663. * drupal_validate_form() is called, so during #process function execution, the
  1664. * element's #value has not yet been validated, so any code that requires
  1665. * validated values must reside within a submit handler.
  1666. *
  1667. * As a security measure, user input is used for an element's #value only if the
  1668. * element exists within $form, is not disabled (as per the #disabled property),
  1669. * and can be accessed (as per the #access property, except that forms submitted
  1670. * using drupal_form_submit() bypass #access restrictions). When user input is
  1671. * ignored due to #disabled and #access restrictions, the element's default
  1672. * value is used.
  1673. *
  1674. * Because of the preorder traversal, where #process functions of an element run
  1675. * before user input for its child elements is processed, and because of the
  1676. * Form API security of user input processing with respect to #access and
  1677. * #disabled described above, this generally means that #process functions
  1678. * should not use an element's (unvalidated) #value to affect the #disabled or
  1679. * #access of child elements. Use-cases where a developer may be tempted to
  1680. * implement such conditional logic usually fall into one of two categories:
  1681. * - Where user input from the current submission must affect the structure of a
  1682. * form, including properties like #access and #disabled that affect how the
  1683. * next submission needs to be processed, a multi-step workflow is needed.
  1684. * This is most commonly implemented with a submit handler setting persistent
  1685. * data within $form_state based on *validated* values in
  1686. * $form_state['values'] and setting $form_state['rebuild']. The form building
  1687. * functions must then be implemented to use the $form_state data to rebuild
  1688. * the form with the structure appropriate for the new state.
  1689. * - Where user input must affect the rendering of the form without affecting
  1690. * its structure, the necessary conditional rendering logic should reside
  1691. * within functions that run during the rendering phase (#pre_render, #theme,
  1692. * #theme_wrappers, and #post_render).
  1693. *
  1694. * @param $form_id
  1695. * A unique string identifying the form for validation, submission,
  1696. * theming, and hook_form_alter functions.
  1697. * @param $element
  1698. * An associative array containing the structure of the current element.
  1699. * @param $form_state
  1700. * A keyed array containing the current state of the form. In this
  1701. * context, it is used to accumulate information about which button
  1702. * was clicked when the form was submitted, as well as the sanitized
  1703. * $_POST data.
  1704. */
  1705. function form_builder($form_id, &$element, &$form_state) {
  1706. // Initialize as unprocessed.
  1707. $element['#processed'] = FALSE;
  1708. // Use element defaults.
  1709. if (isset($element['#type']) && empty($element['#defaults_loaded']) && ($info = element_info($element['#type']))) {
  1710. // Overlay $info onto $element, retaining preexisting keys in $element.
  1711. $element += $info;
  1712. $element['#defaults_loaded'] = TRUE;
  1713. }
  1714. // Assign basic defaults common for all form elements.
  1715. $element += array(
  1716. '#required' => FALSE,
  1717. '#attributes' => array(),
  1718. '#title_display' => 'before',
  1719. );
  1720. // Special handling if we're on the top level form element.
  1721. if (isset($element['#type']) && $element['#type'] == 'form') {
  1722. if (!empty($element['#https']) && variable_get('https', FALSE) &&
  1723. !url_is_external($element['#action'])) {
  1724. global $base_root;
  1725. // Not an external URL so ensure that it is secure.
  1726. $element['#action'] = str_replace('http://', 'https://', $base_root) . $element['#action'];
  1727. }
  1728. // Store a reference to the complete form in $form_state prior to building
  1729. // the form. This allows advanced #process and #after_build callbacks to
  1730. // perform changes elsewhere in the form.
  1731. $form_state['complete form'] = &$element;
  1732. // Set a flag if we have a correct form submission. This is always TRUE for
  1733. // programmed forms coming from drupal_form_submit(), or if the form_id coming
  1734. // from the POST data is set and matches the current form_id.
  1735. if ($form_state['programmed'] || (!empty($form_state['input']) && (isset($form_state['input']['form_id']) && ($form_state['input']['form_id'] == $form_id)))) {
  1736. $form_state['process_input'] = TRUE;
  1737. // If the session token was set by drupal_prepare_form(), ensure that it
  1738. // matches the current user's session.
  1739. $form_state['invalid_token'] = FALSE;
  1740. if (!empty($element['#token'])) {
  1741. if (empty($form_state['input']['form_token']) || !drupal_valid_token($form_state['input']['form_token'], $element['#token'])) {
  1742. // Set an early form error to block certain input processing since that
  1743. // opens the door for CSRF vulnerabilities.
  1744. _drupal_invalid_token_set_form_error();
  1745. // This value is checked in _form_builder_handle_input_element().
  1746. $form_state['invalid_token'] = TRUE;
  1747. // Make sure file uploads do not get processed.
  1748. $_FILES = array();
  1749. }
  1750. }
  1751. }
  1752. else {
  1753. $form_state['process_input'] = FALSE;
  1754. }
  1755. // All form elements should have an #array_parents property.
  1756. $element['#array_parents'] = array();
  1757. }
  1758. if (!isset($element['#id'])) {
  1759. $element['#id'] = drupal_html_id('edit-' . implode('-', $element['#parents']));
  1760. }
  1761. // Handle input elements.
  1762. if (!empty($element['#input'])) {
  1763. _form_builder_handle_input_element($form_id, $element, $form_state);
  1764. }
  1765. // Allow for elements to expand to multiple elements, e.g., radios,
  1766. // checkboxes and files.
  1767. if (isset($element['#process']) && !$element['#processed']) {
  1768. foreach ($element['#process'] as $process) {
  1769. $element = $process($element, $form_state, $form_state['complete form']);
  1770. }
  1771. $element['#processed'] = TRUE;
  1772. }
  1773. // We start off assuming all form elements are in the correct order.
  1774. $element['#sorted'] = TRUE;
  1775. // Recurse through all child elements.
  1776. $count = 0;
  1777. foreach (element_children($element) as $key) {
  1778. // Prior to checking properties of child elements, their default properties
  1779. // need to be loaded.
  1780. if (isset($element[$key]['#type']) && empty($element[$key]['#defaults_loaded']) && ($info = element_info($element[$key]['#type']))) {
  1781. $element[$key] += $info;
  1782. $element[$key]['#defaults_loaded'] = TRUE;
  1783. }
  1784. // Don't squash an existing tree value.
  1785. if (!isset($element[$key]['#tree'])) {
  1786. $element[$key]['#tree'] = $element['#tree'];
  1787. }
  1788. // Deny access to child elements if parent is denied.
  1789. if (isset($element['#access']) && !$element['#access']) {
  1790. $element[$key]['#access'] = FALSE;
  1791. }
  1792. // Make child elements inherit their parent's #disabled and #allow_focus
  1793. // values unless they specify their own.
  1794. foreach (array('#disabled', '#allow_focus') as $property) {
  1795. if (isset($element[$property]) && !isset($element[$key][$property])) {
  1796. $element[$key][$property] = $element[$property];
  1797. }
  1798. }
  1799. // Don't squash existing parents value.
  1800. if (!isset($element[$key]['#parents'])) {
  1801. // Check to see if a tree of child elements is present. If so,
  1802. // continue down the tree if required.
  1803. $element[$key]['#parents'] = $element[$key]['#tree'] && $element['#tree'] ? array_merge($element['#parents'], array($key)) : array($key);
  1804. }
  1805. // Ensure #array_parents follows the actual form structure.
  1806. $array_parents = $element['#array_parents'];
  1807. $array_parents[] = $key;
  1808. $element[$key]['#array_parents'] = $array_parents;
  1809. // Assign a decimal placeholder weight to preserve original array order.
  1810. if (!isset($element[$key]['#weight'])) {
  1811. $element[$key]['#weight'] = $count/1000;
  1812. }
  1813. else {
  1814. // If one of the child elements has a weight then we will need to sort
  1815. // later.
  1816. unset($element['#sorted']);
  1817. }
  1818. $element[$key] = form_builder($form_id, $element[$key], $form_state);
  1819. $count++;
  1820. }
  1821. // The #after_build flag allows any piece of a form to be altered
  1822. // after normal input parsing has been completed.
  1823. if (isset($element['#after_build']) && !isset($element['#after_build_done'])) {
  1824. foreach ($element['#after_build'] as $function) {
  1825. $element = $function($element, $form_state);
  1826. }
  1827. $element['#after_build_done'] = TRUE;
  1828. }
  1829. // If there is a file element, we need to flip a flag so later the
  1830. // form encoding can be set.
  1831. if (isset($element['#type']) && $element['#type'] == 'file') {
  1832. $form_state['has_file_element'] = TRUE;
  1833. }
  1834. // Final tasks for the form element after form_builder() has run for all other
  1835. // elements.
  1836. if (isset($element['#type']) && $element['#type'] == 'form') {
  1837. // If there is a file element, we set the form encoding.
  1838. if (isset($form_state['has_file_element'])) {
  1839. $element['#attributes']['enctype'] = 'multipart/form-data';
  1840. }
  1841. // Allow Ajax submissions to the form action to bypass verification. This is
  1842. // especially useful for multipart forms, which cannot be verified via a
  1843. // response header.
  1844. $element['#attached']['js'][] = array(
  1845. 'type' => 'setting',
  1846. 'data' => array(
  1847. 'urlIsAjaxTrusted' => array(
  1848. $element['#action'] => TRUE,
  1849. ),
  1850. ),
  1851. );
  1852. // If a form contains a single textfield, and the ENTER key is pressed
  1853. // within it, Internet Explorer submits the form with no POST data
  1854. // identifying any submit button. Other browsers submit POST data as though
  1855. // the user clicked the first button. Therefore, to be as consistent as we
  1856. // can be across browsers, if no 'triggering_element' has been identified
  1857. // yet, default it to the first button.
  1858. if (!$form_state['programmed'] && !isset($form_state['triggering_element']) && !empty($form_state['buttons'])) {
  1859. $form_state['triggering_element'] = $form_state['buttons'][0];
  1860. }
  1861. // If the triggering element specifies "button-level" validation and submit
  1862. // handlers to run instead of the default form-level ones, then add those to
  1863. // the form state.
  1864. foreach (array('validate', 'submit') as $type) {
  1865. if (isset($form_state['triggering_element']['#' . $type])) {
  1866. $form_state[$type . '_handlers'] = $form_state['triggering_element']['#' . $type];
  1867. }
  1868. }
  1869. // If the triggering element executes submit handlers, then set the form
  1870. // state key that's needed for those handlers to run.
  1871. if (!empty($form_state['triggering_element']['#executes_submit_callback'])) {
  1872. $form_state['submitted'] = TRUE;
  1873. }
  1874. // Special processing if the triggering element is a button.
  1875. if (isset($form_state['triggering_element']['#button_type'])) {
  1876. // Because there are several ways in which the triggering element could
  1877. // have been determined (including from input variables set by JavaScript
  1878. // or fallback behavior implemented for IE), and because buttons often
  1879. // have their #name property not derived from their #parents property, we
  1880. // can't assume that input processing that's happened up until here has
  1881. // resulted in $form_state['values'][BUTTON_NAME] being set. But it's
  1882. // common for forms to have several buttons named 'op' and switch on
  1883. // $form_state['values']['op'] during submit handler execution.
  1884. $form_state['values'][$form_state['triggering_element']['#name']] = $form_state['triggering_element']['#value'];
  1885. // @todo Legacy support. Remove in Drupal 8.
  1886. $form_state['clicked_button'] = $form_state['triggering_element'];
  1887. }
  1888. }
  1889. return $element;
  1890. }
  1891. /**
  1892. * Adds the #name and #value properties of an input element before rendering.
  1893. */
  1894. function _form_builder_handle_input_element($form_id, &$element, &$form_state) {
  1895. static $safe_core_value_callbacks = array(
  1896. 'form_type_token_value',
  1897. 'form_type_textarea_value',
  1898. 'form_type_textfield_value',
  1899. 'form_type_checkbox_value',
  1900. 'form_type_checkboxes_value',
  1901. 'form_type_radios_value',
  1902. 'form_type_password_confirm_value',
  1903. 'form_type_select_value',
  1904. 'form_type_tableselect_value',
  1905. 'list_boolean_allowed_values_callback',
  1906. );
  1907. if (!isset($element['#name'])) {
  1908. $name = array_shift($element['#parents']);
  1909. $element['#name'] = $name;
  1910. if ($element['#type'] == 'file') {
  1911. // To make it easier to handle $_FILES in file.inc, we place all
  1912. // file fields in the 'files' array. Also, we do not support
  1913. // nested file names.
  1914. $element['#name'] = 'files[' . $element['#name'] . ']';
  1915. }
  1916. elseif (count($element['#parents'])) {
  1917. $element['#name'] .= '[' . implode('][', $element['#parents']) . ']';
  1918. }
  1919. array_unshift($element['#parents'], $name);
  1920. }
  1921. // Setting #disabled to TRUE results in user input being ignored, regardless
  1922. // of how the element is themed or whether JavaScript is used to change the
  1923. // control's attributes. However, it's good UI to let the user know that input
  1924. // is not wanted for the control. HTML supports two attributes for this:
  1925. // http://www.w3.org/TR/html401/interact/forms.html#h-17.12. If a form wants
  1926. // to start a control off with one of these attributes for UI purposes only,
  1927. // but still allow input to be processed if it's sumitted, it can set the
  1928. // desired attribute in #attributes directly rather than using #disabled.
  1929. // However, developers should think carefully about the accessibility
  1930. // implications of doing so: if the form expects input to be enterable under
  1931. // some condition triggered by JavaScript, how would someone who has
  1932. // JavaScript disabled trigger that condition? Instead, developers should
  1933. // consider whether a multi-step form would be more appropriate (#disabled can
  1934. // be changed from step to step). If one still decides to use JavaScript to
  1935. // affect when a control is enabled, then it is best for accessibility for the
  1936. // control to be enabled in the HTML, and disabled by JavaScript on document
  1937. // ready.
  1938. if (!empty($element['#disabled'])) {
  1939. if (!empty($element['#allow_focus'])) {
  1940. $element['#attributes']['readonly'] = 'readonly';
  1941. }
  1942. else {
  1943. $element['#attributes']['disabled'] = 'disabled';
  1944. }
  1945. }
  1946. // With JavaScript or other easy hacking, input can be submitted even for
  1947. // elements with #access=FALSE or #disabled=TRUE. For security, these must
  1948. // not be processed. Forms that set #disabled=TRUE on an element do not
  1949. // expect input for the element, and even forms submitted with
  1950. // drupal_form_submit() must not be able to get around this. Forms that set
  1951. // #access=FALSE on an element usually allow access for some users, so forms
  1952. // submitted with drupal_form_submit() may bypass access restriction and be
  1953. // treated as high-privilege users instead.
  1954. $process_input = empty($element['#disabled']) && (($form_state['programmed'] && $form_state['programmed_bypass_access_check']) || ($form_state['process_input'] && (!isset($element['#access']) || $element['#access'])));
  1955. // Set the element's #value property.
  1956. if (!isset($element['#value']) && !array_key_exists('#value', $element)) {
  1957. $value_callback = !empty($element['#value_callback']) ? $element['#value_callback'] : 'form_type_' . $element['#type'] . '_value';
  1958. if ($process_input) {
  1959. // Get the input for the current element. NULL values in the input need to
  1960. // be explicitly distinguished from missing input. (see below)
  1961. $input_exists = NULL;
  1962. $input = drupal_array_get_nested_value($form_state['input'], $element['#parents'], $input_exists);
  1963. // For browser-submitted forms, the submitted values do not contain values
  1964. // for certain elements (empty multiple select, unchecked checkbox).
  1965. // During initial form processing, we add explicit NULL values for such
  1966. // elements in $form_state['input']. When rebuilding the form, we can
  1967. // distinguish elements having NULL input from elements that were not part
  1968. // of the initially submitted form and can therefore use default values
  1969. // for the latter, if required. Programmatically submitted forms can
  1970. // submit explicit NULL values when calling drupal_form_submit(), so we do
  1971. // not modify $form_state['input'] for them.
  1972. if (!$input_exists && !$form_state['rebuild'] && !$form_state['programmed']) {
  1973. // Add the necessary parent keys to $form_state['input'] and sets the
  1974. // element's input value to NULL.
  1975. drupal_array_set_nested_value($form_state['input'], $element['#parents'], NULL);
  1976. $input_exists = TRUE;
  1977. }
  1978. // If we have input for the current element, assign it to the #value
  1979. // property, optionally filtered through $value_callback.
  1980. if ($input_exists) {
  1981. if (function_exists($value_callback)) {
  1982. // Skip all value callbacks except safe ones like text if the CSRF
  1983. // token was invalid.
  1984. if (empty($form_state['invalid_token']) || in_array($value_callback, $safe_core_value_callbacks)) {
  1985. $element['#value'] = $value_callback($element, $input, $form_state);
  1986. }
  1987. else {
  1988. $input = NULL;
  1989. }
  1990. }
  1991. if (!isset($element['#value']) && isset($input)) {
  1992. $element['#value'] = $input;
  1993. }
  1994. }
  1995. // Mark all posted values for validation.
  1996. if (isset($element['#value']) || (!empty($element['#required']))) {
  1997. $element['#needs_validation'] = TRUE;
  1998. }
  1999. }
  2000. // Load defaults.
  2001. if (!isset($element['#value'])) {
  2002. // Call #type_value without a second argument to request default_value handling.
  2003. if (function_exists($value_callback)) {
  2004. $element['#value'] = $value_callback($element, FALSE, $form_state);
  2005. }
  2006. // Final catch. If we haven't set a value yet, use the explicit default value.
  2007. // Avoid image buttons (which come with garbage value), so we only get value
  2008. // for the button actually clicked.
  2009. if (!isset($element['#value']) && empty($element['#has_garbage_value'])) {
  2010. $element['#value'] = isset($element['#default_value']) ? $element['#default_value'] : '';
  2011. }
  2012. }
  2013. }
  2014. // Determine which element (if any) triggered the submission of the form and
  2015. // keep track of all the clickable buttons in the form for
  2016. // form_state_values_clean(). Enforce the same input processing restrictions
  2017. // as above.
  2018. if ($process_input) {
  2019. // Detect if the element triggered the submission via Ajax.
  2020. if (_form_element_triggered_scripted_submission($element, $form_state)) {
  2021. $form_state['triggering_element'] = $element;
  2022. }
  2023. // If the form was submitted by the browser rather than via Ajax, then it
  2024. // can only have been triggered by a button, and we need to determine which
  2025. // button within the constraints of how browsers provide this information.
  2026. if (isset($element['#button_type'])) {
  2027. // All buttons in the form need to be tracked for
  2028. // form_state_values_clean() and for the form_builder() code that handles
  2029. // a form submission containing no button information in $_POST.
  2030. $form_state['buttons'][] = $element;
  2031. if (_form_button_was_clicked($element, $form_state)) {
  2032. $form_state['triggering_element'] = $element;
  2033. }
  2034. }
  2035. }
  2036. // Set the element's value in $form_state['values'], but only, if its key
  2037. // does not exist yet (a #value_callback may have already populated it).
  2038. if (!drupal_array_nested_key_exists($form_state['values'], $element['#parents'])) {
  2039. form_set_value($element, $element['#value'], $form_state);
  2040. }
  2041. }
  2042. /**
  2043. * Detects if an element triggered the form submission via Ajax.
  2044. *
  2045. * This detects button or non-button controls that trigger a form submission via
  2046. * Ajax or some other scriptable environment. These environments can set the
  2047. * special input key '_triggering_element_name' to identify the triggering
  2048. * element. If the name alone doesn't identify the element uniquely, the input
  2049. * key '_triggering_element_value' may also be set to require a match on element
  2050. * value. An example where this is needed is if there are several buttons all
  2051. * named 'op', and only differing in their value.
  2052. */
  2053. function _form_element_triggered_scripted_submission($element, &$form_state) {
  2054. if (!empty($form_state['input']['_triggering_element_name']) && $element['#name'] == $form_state['input']['_triggering_element_name']) {
  2055. if (empty($form_state['input']['_triggering_element_value']) || $form_state['input']['_triggering_element_value'] == $element['#value']) {
  2056. return TRUE;
  2057. }
  2058. }
  2059. return FALSE;
  2060. }
  2061. /**
  2062. * Determines if a given button triggered the form submission.
  2063. *
  2064. * This detects button controls that trigger a form submission by being clicked
  2065. * and having the click processed by the browser rather than being captured by
  2066. * JavaScript. Essentially, it detects if the button's name and value are part
  2067. * of the POST data, but with extra code to deal with the convoluted way in
  2068. * which browsers submit data for image button clicks.
  2069. *
  2070. * This does not detect button clicks processed by Ajax (that is done in
  2071. * _form_element_triggered_scripted_submission()) and it does not detect form
  2072. * submissions from Internet Explorer in response to an ENTER key pressed in a
  2073. * textfield (form_builder() has extra code for that).
  2074. *
  2075. * Because this function contains only part of the logic needed to determine
  2076. * $form_state['triggering_element'], it should not be called from anywhere
  2077. * other than within the Form API. Form validation and submit handlers needing
  2078. * to know which button was clicked should get that information from
  2079. * $form_state['triggering_element'].
  2080. */
  2081. function _form_button_was_clicked($element, &$form_state) {
  2082. // First detect normal 'vanilla' button clicks. Traditionally, all
  2083. // standard buttons on a form share the same name (usually 'op'),
  2084. // and the specific return value is used to determine which was
  2085. // clicked. This ONLY works as long as $form['#name'] puts the
  2086. // value at the top level of the tree of $_POST data.
  2087. if (isset($form_state['input'][$element['#name']]) && $form_state['input'][$element['#name']] == $element['#value']) {
  2088. return TRUE;
  2089. }
  2090. // When image buttons are clicked, browsers do NOT pass the form element
  2091. // value in $_POST. Instead they pass an integer representing the
  2092. // coordinates of the click on the button image. This means that image
  2093. // buttons MUST have unique $form['#name'] values, but the details of
  2094. // their $_POST data should be ignored.
  2095. elseif (!empty($element['#has_garbage_value']) && isset($element['#value']) && $element['#value'] !== '') {
  2096. return TRUE;
  2097. }
  2098. return FALSE;
  2099. }
  2100. /**
  2101. * Removes internal Form API elements and buttons from submitted form values.
  2102. *
  2103. * This function can be used when a module wants to store all submitted form
  2104. * values, for example, by serializing them into a single database column. In
  2105. * such cases, all internal Form API values and all form button elements should
  2106. * not be contained, and this function allows to remove them before the module
  2107. * proceeds to storage. Next to button elements, the following internal values
  2108. * are removed:
  2109. * - form_id
  2110. * - form_token
  2111. * - form_build_id
  2112. * - op
  2113. *
  2114. * @param $form_state
  2115. * A keyed array containing the current state of the form, including
  2116. * submitted form values; altered by reference.
  2117. */
  2118. function form_state_values_clean(&$form_state) {
  2119. // Remove internal Form API values.
  2120. unset($form_state['values']['form_id'], $form_state['values']['form_token'], $form_state['values']['form_build_id'], $form_state['values']['op']);
  2121. // Remove button values.
  2122. // form_builder() collects all button elements in a form. We remove the button
  2123. // value separately for each button element.
  2124. foreach ($form_state['buttons'] as $button) {
  2125. // Remove this button's value from the submitted form values by finding
  2126. // the value corresponding to this button.
  2127. // We iterate over the #parents of this button and move a reference to
  2128. // each parent in $form_state['values']. For example, if #parents is:
  2129. // array('foo', 'bar', 'baz')
  2130. // then the corresponding $form_state['values'] part will look like this:
  2131. // array(
  2132. // 'foo' => array(
  2133. // 'bar' => array(
  2134. // 'baz' => 'button_value',
  2135. // ),
  2136. // ),
  2137. // )
  2138. // We start by (re)moving 'baz' to $last_parent, so we are able unset it
  2139. // at the end of the iteration. Initially, $values will contain a
  2140. // reference to $form_state['values'], but in the iteration we move the
  2141. // reference to $form_state['values']['foo'], and finally to
  2142. // $form_state['values']['foo']['bar'], which is the level where we can
  2143. // unset 'baz' (that is stored in $last_parent).
  2144. $parents = $button['#parents'];
  2145. $last_parent = array_pop($parents);
  2146. $key_exists = NULL;
  2147. $values = &drupal_array_get_nested_value($form_state['values'], $parents, $key_exists);
  2148. if ($key_exists && is_array($values)) {
  2149. unset($values[$last_parent]);
  2150. }
  2151. }
  2152. }
  2153. /**
  2154. * Determines the value for an image button form element.
  2155. *
  2156. * @param $form
  2157. * The form element whose value is being populated.
  2158. * @param $input
  2159. * The incoming input to populate the form element. If this is FALSE,
  2160. * the element's default value should be returned.
  2161. * @param $form_state
  2162. * A keyed array containing the current state of the form.
  2163. *
  2164. * @return
  2165. * The data that will appear in the $form_state['values'] collection
  2166. * for this element. Return nothing to use the default.
  2167. */
  2168. function form_type_image_button_value($form, $input, $form_state) {
  2169. if ($input !== FALSE) {
  2170. if (!empty($input)) {
  2171. // If we're dealing with Mozilla or Opera, we're lucky. It will
  2172. // return a proper value, and we can get on with things.
  2173. return $form['#return_value'];
  2174. }
  2175. else {
  2176. // Unfortunately, in IE we never get back a proper value for THIS
  2177. // form element. Instead, we get back two split values: one for the
  2178. // X and one for the Y coordinates on which the user clicked the
  2179. // button. We'll find this element in the #post data, and search
  2180. // in the same spot for its name, with '_x'.
  2181. $input = $form_state['input'];
  2182. foreach (explode('[', $form['#name']) as $element_name) {
  2183. // chop off the ] that may exist.
  2184. if (substr($element_name, -1) == ']') {
  2185. $element_name = substr($element_name, 0, -1);
  2186. }
  2187. if (!isset($input[$element_name])) {
  2188. if (isset($input[$element_name . '_x'])) {
  2189. return $form['#return_value'];
  2190. }
  2191. return NULL;
  2192. }
  2193. $input = $input[$element_name];
  2194. }
  2195. return $form['#return_value'];
  2196. }
  2197. }
  2198. }
  2199. /**
  2200. * Determines the value for a checkbox form element.
  2201. *
  2202. * @param $form
  2203. * The form element whose value is being populated.
  2204. * @param $input
  2205. * The incoming input to populate the form element. If this is FALSE,
  2206. * the element's default value should be returned.
  2207. *
  2208. * @return
  2209. * The data that will appear in the $element_state['values'] collection
  2210. * for this element. Return nothing to use the default.
  2211. */
  2212. function form_type_checkbox_value($element, $input = FALSE) {
  2213. if ($input === FALSE) {
  2214. // Use #default_value as the default value of a checkbox, except change
  2215. // NULL to 0, because _form_builder_handle_input_element() would otherwise
  2216. // replace NULL with empty string, but an empty string is a potentially
  2217. // valid value for a checked checkbox.
  2218. return isset($element['#default_value']) ? $element['#default_value'] : 0;
  2219. }
  2220. else {
  2221. // Checked checkboxes are submitted with a value (possibly '0' or ''):
  2222. // http://www.w3.org/TR/html401/interact/forms.html#successful-controls.
  2223. // For checked checkboxes, browsers submit the string version of
  2224. // #return_value, but we return the original #return_value. For unchecked
  2225. // checkboxes, browsers submit nothing at all, but
  2226. // _form_builder_handle_input_element() detects this, and calls this
  2227. // function with $input=NULL. Returning NULL from a value callback means to
  2228. // use the default value, which is not what is wanted when an unchecked
  2229. // checkbox is submitted, so we use integer 0 as the value indicating an
  2230. // unchecked checkbox. Therefore, modules must not use integer 0 as a
  2231. // #return_value, as doing so results in the checkbox always being treated
  2232. // as unchecked. The string '0' is allowed for #return_value. The most
  2233. // common use-case for setting #return_value to either 0 or '0' is for the
  2234. // first option within a 0-indexed array of checkboxes, and for this,
  2235. // form_process_checkboxes() uses the string rather than the integer.
  2236. return isset($input) ? $element['#return_value'] : 0;
  2237. }
  2238. }
  2239. /**
  2240. * Determines the value for a checkboxes form element.
  2241. *
  2242. * @param $element
  2243. * The form element whose value is being populated.
  2244. * @param $input
  2245. * The incoming input to populate the form element. If this is FALSE,
  2246. * the element's default value should be returned.
  2247. *
  2248. * @return
  2249. * The data that will appear in the $element_state['values'] collection
  2250. * for this element. Return nothing to use the default.
  2251. */
  2252. function form_type_checkboxes_value($element, $input = FALSE) {
  2253. if ($input === FALSE) {
  2254. $value = array();
  2255. $element += array('#default_value' => array());
  2256. foreach ($element['#default_value'] as $key) {
  2257. $value[$key] = $key;
  2258. }
  2259. return $value;
  2260. }
  2261. elseif (is_array($input)) {
  2262. // Programmatic form submissions use NULL to indicate that a checkbox
  2263. // should be unchecked; see drupal_form_submit(). We therefore remove all
  2264. // NULL elements from the array before constructing the return value, to
  2265. // simulate the behavior of web browsers (which do not send unchecked
  2266. // checkboxes to the server at all). This will not affect non-programmatic
  2267. // form submissions, since all values in $_POST are strings.
  2268. foreach ($input as $key => $value) {
  2269. if (!isset($value)) {
  2270. unset($input[$key]);
  2271. }
  2272. }
  2273. return drupal_map_assoc($input);
  2274. }
  2275. else {
  2276. return array();
  2277. }
  2278. }
  2279. /**
  2280. * Determines the value for a tableselect form element.
  2281. *
  2282. * @param $element
  2283. * The form element whose value is being populated.
  2284. * @param $input
  2285. * The incoming input to populate the form element. If this is FALSE,
  2286. * the element's default value should be returned.
  2287. *
  2288. * @return
  2289. * The data that will appear in the $element_state['values'] collection
  2290. * for this element. Return nothing to use the default.
  2291. */
  2292. function form_type_tableselect_value($element, $input = FALSE) {
  2293. // If $element['#multiple'] == FALSE, then radio buttons are displayed and
  2294. // the default value handling is used.
  2295. if (isset($element['#multiple']) && $element['#multiple']) {
  2296. // Checkboxes are being displayed with the default value coming from the
  2297. // keys of the #default_value property. This differs from the checkboxes
  2298. // element which uses the array values.
  2299. if ($input === FALSE) {
  2300. $value = array();
  2301. $element += array('#default_value' => array());
  2302. foreach ($element['#default_value'] as $key => $flag) {
  2303. if ($flag) {
  2304. $value[$key] = $key;
  2305. }
  2306. }
  2307. return $value;
  2308. }
  2309. else {
  2310. return is_array($input) ? drupal_map_assoc($input) : array();
  2311. }
  2312. }
  2313. }
  2314. /**
  2315. * Form value callback: Determines the value for a #type radios form element.
  2316. *
  2317. * @param $element
  2318. * The form element whose value is being populated.
  2319. * @param $input
  2320. * (optional) The incoming input to populate the form element. If FALSE, the
  2321. * element's default value is returned. Defaults to FALSE.
  2322. *
  2323. * @return
  2324. * The data that will appear in the $element_state['values'] collection for
  2325. * this element.
  2326. */
  2327. function form_type_radios_value(&$element, $input = FALSE) {
  2328. if ($input !== FALSE) {
  2329. // When there's user input (including NULL), return it as the value.
  2330. // However, if NULL is submitted, _form_builder_handle_input_element() will
  2331. // apply the default value, and we want that validated against #options
  2332. // unless it's empty. (An empty #default_value, such as NULL or FALSE, can
  2333. // be used to indicate that no radio button is selected by default.)
  2334. if (!isset($input) && !empty($element['#default_value'])) {
  2335. $element['#needs_validation'] = TRUE;
  2336. }
  2337. return $input;
  2338. }
  2339. else {
  2340. // For default value handling, simply return #default_value. Additionally,
  2341. // for a NULL default value, set #has_garbage_value to prevent
  2342. // _form_builder_handle_input_element() converting the NULL to an empty
  2343. // string, so that code can distinguish between nothing selected and the
  2344. // selection of a radio button whose value is an empty string.
  2345. $value = isset($element['#default_value']) ? $element['#default_value'] : NULL;
  2346. if (!isset($value)) {
  2347. $element['#has_garbage_value'] = TRUE;
  2348. }
  2349. return $value;
  2350. }
  2351. }
  2352. /**
  2353. * Determines the value for a password_confirm form element.
  2354. *
  2355. * @param $element
  2356. * The form element whose value is being populated.
  2357. * @param $input
  2358. * The incoming input to populate the form element. If this is FALSE,
  2359. * the element's default value should be returned.
  2360. *
  2361. * @return
  2362. * The data that will appear in the $element_state['values'] collection
  2363. * for this element. Return nothing to use the default.
  2364. */
  2365. function form_type_password_confirm_value($element, $input = FALSE) {
  2366. if ($input === FALSE) {
  2367. $element += array('#default_value' => array());
  2368. return $element['#default_value'] + array('pass1' => '', 'pass2' => '');
  2369. }
  2370. $value = array('pass1' => '', 'pass2' => '');
  2371. // Throw out all invalid array keys; we only allow pass1 and pass2.
  2372. foreach ($value as $allowed_key => $default) {
  2373. // These should be strings, but allow other scalars since they might be
  2374. // valid input in programmatic form submissions. Any nested array values
  2375. // are ignored.
  2376. if (isset($input[$allowed_key]) && is_scalar($input[$allowed_key])) {
  2377. $value[$allowed_key] = (string) $input[$allowed_key];
  2378. }
  2379. }
  2380. return $value;
  2381. }
  2382. /**
  2383. * Determines the value for a select form element.
  2384. *
  2385. * @param $element
  2386. * The form element whose value is being populated.
  2387. * @param $input
  2388. * The incoming input to populate the form element. If this is FALSE,
  2389. * the element's default value should be returned.
  2390. *
  2391. * @return
  2392. * The data that will appear in the $element_state['values'] collection
  2393. * for this element. Return nothing to use the default.
  2394. */
  2395. function form_type_select_value($element, $input = FALSE) {
  2396. if ($input !== FALSE) {
  2397. if (isset($element['#multiple']) && $element['#multiple']) {
  2398. // If an enabled multi-select submits NULL, it means all items are
  2399. // unselected. A disabled multi-select always submits NULL, and the
  2400. // default value should be used.
  2401. if (empty($element['#disabled'])) {
  2402. return (is_array($input)) ? drupal_map_assoc($input) : array();
  2403. }
  2404. else {
  2405. return (isset($element['#default_value']) && is_array($element['#default_value'])) ? $element['#default_value'] : array();
  2406. }
  2407. }
  2408. // Non-multiple select elements may have an empty option preprended to them
  2409. // (see form_process_select()). When this occurs, usually #empty_value is
  2410. // an empty string, but some forms set #empty_value to integer 0 or some
  2411. // other non-string constant. PHP receives all submitted form input as
  2412. // strings, but if the empty option is selected, set the value to match the
  2413. // empty value exactly.
  2414. elseif (isset($element['#empty_value']) && $input === (string) $element['#empty_value']) {
  2415. return $element['#empty_value'];
  2416. }
  2417. else {
  2418. return $input;
  2419. }
  2420. }
  2421. }
  2422. /**
  2423. * Determines the value for a textarea form element.
  2424. *
  2425. * @param array $element
  2426. * The form element whose value is being populated.
  2427. * @param mixed $input
  2428. * The incoming input to populate the form element. If this is FALSE,
  2429. * the element's default value should be returned.
  2430. *
  2431. * @return string
  2432. * The data that will appear in the $element_state['values'] collection
  2433. * for this element. Return nothing to use the default.
  2434. */
  2435. function form_type_textarea_value($element, $input = FALSE) {
  2436. if ($input !== FALSE && $input !== NULL) {
  2437. // This should be a string, but allow other scalars since they might be
  2438. // valid input in programmatic form submissions.
  2439. return is_scalar($input) ? (string) $input : '';
  2440. }
  2441. }
  2442. /**
  2443. * Determines the value for a textfield form element.
  2444. *
  2445. * @param $element
  2446. * The form element whose value is being populated.
  2447. * @param $input
  2448. * The incoming input to populate the form element. If this is FALSE,
  2449. * the element's default value should be returned.
  2450. *
  2451. * @return
  2452. * The data that will appear in the $element_state['values'] collection
  2453. * for this element. Return nothing to use the default.
  2454. */
  2455. function form_type_textfield_value($element, $input = FALSE) {
  2456. if ($input !== FALSE && $input !== NULL) {
  2457. // This should be a string, but allow other scalars since they might be
  2458. // valid input in programmatic form submissions.
  2459. if (!is_scalar($input)) {
  2460. $input = '';
  2461. }
  2462. return str_replace(array("\r", "\n"), '', (string) $input);
  2463. }
  2464. }
  2465. /**
  2466. * Determines the value for form's token value.
  2467. *
  2468. * @param $element
  2469. * The form element whose value is being populated.
  2470. * @param $input
  2471. * The incoming input to populate the form element. If this is FALSE,
  2472. * the element's default value should be returned.
  2473. *
  2474. * @return
  2475. * The data that will appear in the $element_state['values'] collection
  2476. * for this element. Return nothing to use the default.
  2477. */
  2478. function form_type_token_value($element, $input = FALSE) {
  2479. if ($input !== FALSE) {
  2480. return (string) $input;
  2481. }
  2482. }
  2483. /**
  2484. * Changes submitted form values during form validation.
  2485. *
  2486. * Use this function to change the submitted value of a form element in a form
  2487. * validation function, so that the changed value persists in $form_state
  2488. * through the remaining validation and submission handlers. It does not change
  2489. * the value in $element['#value'], only in $form_state['values'], which is
  2490. * where submitted values are always stored.
  2491. *
  2492. * Note that form validation functions are specified in the '#validate'
  2493. * component of the form array (the value of $form['#validate'] is an array of
  2494. * validation function names). If the form does not originate in your module,
  2495. * you can implement hook_form_FORM_ID_alter() to add a validation function
  2496. * to $form['#validate'].
  2497. *
  2498. * @param $element
  2499. * The form element that should have its value updated; in most cases you can
  2500. * just pass in the element from the $form array, although the only component
  2501. * that is actually used is '#parents'. If constructing yourself, set
  2502. * $element['#parents'] to be an array giving the path through the form
  2503. * array's keys to the element whose value you want to update. For instance,
  2504. * if you want to update the value of $form['elem1']['elem2'], which should be
  2505. * stored in $form_state['values']['elem1']['elem2'], you would set
  2506. * $element['#parents'] = array('elem1','elem2').
  2507. * @param $value
  2508. * The new value for the form element.
  2509. * @param $form_state
  2510. * Form state array where the value change should be recorded.
  2511. */
  2512. function form_set_value($element, $value, &$form_state) {
  2513. drupal_array_set_nested_value($form_state['values'], $element['#parents'], $value, TRUE);
  2514. }
  2515. /**
  2516. * Allows PHP array processing of multiple select options with the same value.
  2517. *
  2518. * Used for form select elements which need to validate HTML option groups
  2519. * and multiple options which may return the same value. Associative PHP arrays
  2520. * cannot handle these structures, since they share a common key.
  2521. *
  2522. * @param $array
  2523. * The form options array to process.
  2524. *
  2525. * @return
  2526. * An array with all hierarchical elements flattened to a single array.
  2527. */
  2528. function form_options_flatten($array) {
  2529. // Always reset static var when first entering the recursion.
  2530. drupal_static_reset('_form_options_flatten');
  2531. return _form_options_flatten($array);
  2532. }
  2533. /**
  2534. * Iterates over an array and returns a flat array with duplicate keys removed.
  2535. *
  2536. * This function also handles cases where objects are passed as array values.
  2537. */
  2538. function _form_options_flatten($array) {
  2539. $return = &drupal_static(__FUNCTION__);
  2540. foreach ($array as $key => $value) {
  2541. if (is_object($value)) {
  2542. _form_options_flatten($value->option);
  2543. }
  2544. elseif (is_array($value)) {
  2545. _form_options_flatten($value);
  2546. }
  2547. else {
  2548. $return[$key] = 1;
  2549. }
  2550. }
  2551. return $return;
  2552. }
  2553. /**
  2554. * Processes a select list form element.
  2555. *
  2556. * This process callback is mandatory for select fields, since all user agents
  2557. * automatically preselect the first available option of single (non-multiple)
  2558. * select lists.
  2559. *
  2560. * @param $element
  2561. * The form element to process. Properties used:
  2562. * - #multiple: (optional) Indicates whether one or more options can be
  2563. * selected. Defaults to FALSE.
  2564. * - #default_value: Must be NULL or not set in case there is no value for the
  2565. * element yet, in which case a first default option is inserted by default.
  2566. * Whether this first option is a valid option depends on whether the field
  2567. * is #required or not.
  2568. * - #required: (optional) Whether the user needs to select an option (TRUE)
  2569. * or not (FALSE). Defaults to FALSE.
  2570. * - #empty_option: (optional) The label to show for the first default option.
  2571. * By default, the label is automatically set to "- Select -" for a required
  2572. * field and "- None -" for an optional field.
  2573. * - #empty_value: (optional) The value for the first default option, which is
  2574. * used to determine whether the user submitted a value or not.
  2575. * - If #required is TRUE, this defaults to '' (an empty string).
  2576. * - If #required is not TRUE and this value isn't set, then no extra option
  2577. * is added to the select control, leaving the control in a slightly
  2578. * illogical state, because there's no way for the user to select nothing,
  2579. * since all user agents automatically preselect the first available
  2580. * option. But people are used to this being the behavior of select
  2581. * controls.
  2582. * @todo Address the above issue in Drupal 8.
  2583. * - If #required is not TRUE and this value is set (most commonly to an
  2584. * empty string), then an extra option (see #empty_option above)
  2585. * representing a "non-selection" is added with this as its value.
  2586. *
  2587. * @see _form_validate()
  2588. */
  2589. function form_process_select($element) {
  2590. // #multiple select fields need a special #name.
  2591. if ($element['#multiple']) {
  2592. $element['#attributes']['multiple'] = 'multiple';
  2593. $element['#attributes']['name'] = $element['#name'] . '[]';
  2594. }
  2595. // A non-#multiple select needs special handling to prevent user agents from
  2596. // preselecting the first option without intention. #multiple select lists do
  2597. // not get an empty option, as it would not make sense, user interface-wise.
  2598. else {
  2599. $required = $element['#required'];
  2600. // If the element is required and there is no #default_value, then add an
  2601. // empty option that will fail validation, so that the user is required to
  2602. // make a choice. Also, if there's a value for #empty_value or
  2603. // #empty_option, then add an option that represents emptiness.
  2604. if (($required && !isset($element['#default_value'])) || isset($element['#empty_value']) || isset($element['#empty_option'])) {
  2605. $element += array(
  2606. '#empty_value' => '',
  2607. '#empty_option' => $required ? t('- Select -') : t('- None -'),
  2608. );
  2609. // The empty option is prepended to #options and purposively not merged
  2610. // to prevent another option in #options mistakenly using the same value
  2611. // as #empty_value.
  2612. $empty_option = array($element['#empty_value'] => $element['#empty_option']);
  2613. $element['#options'] = $empty_option + $element['#options'];
  2614. }
  2615. }
  2616. return $element;
  2617. }
  2618. /**
  2619. * Returns HTML for a select form element.
  2620. *
  2621. * It is possible to group options together; to do this, change the format of
  2622. * $options to an associative array in which the keys are group labels, and the
  2623. * values are associative arrays in the normal $options format.
  2624. *
  2625. * @param $variables
  2626. * An associative array containing:
  2627. * - element: An associative array containing the properties of the element.
  2628. * Properties used: #title, #value, #options, #description, #extra,
  2629. * #multiple, #required, #name, #attributes, #size.
  2630. *
  2631. * @ingroup themeable
  2632. */
  2633. function theme_select($variables) {
  2634. $element = $variables['element'];
  2635. element_set_attributes($element, array('id', 'name', 'size'));
  2636. _form_set_class($element, array('form-select'));
  2637. return '<select' . drupal_attributes($element['#attributes']) . '>' . form_select_options($element) . '</select>';
  2638. }
  2639. /**
  2640. * Converts an array of options into HTML, for use in select list form elements.
  2641. *
  2642. * This function calls itself recursively to obtain the values for each optgroup
  2643. * within the list of options and when the function encounters an object with
  2644. * an 'options' property inside $element['#options'].
  2645. *
  2646. * @param array $element
  2647. * An associative array containing the following key-value pairs:
  2648. * - #multiple: Optional Boolean indicating if the user may select more than
  2649. * one item.
  2650. * - #options: An associative array of options to render as HTML. Each array
  2651. * value can be a string, an array, or an object with an 'option' property:
  2652. * - A string or integer key whose value is a translated string is
  2653. * interpreted as a single HTML option element. Do not use placeholders
  2654. * that sanitize data: doing so will lead to double-escaping. Note that
  2655. * the key will be visible in the HTML and could be modified by malicious
  2656. * users, so don't put sensitive information in it.
  2657. * - A translated string key whose value is an array indicates a group of
  2658. * options. The translated string is used as the label attribute for the
  2659. * optgroup. Do not use placeholders to sanitize data: doing so will lead
  2660. * to double-escaping. The array should contain the options you wish to
  2661. * group and should follow the syntax of $element['#options'].
  2662. * - If the function encounters a string or integer key whose value is an
  2663. * object with an 'option' property, the key is ignored, the contents of
  2664. * the option property are interpreted as $element['#options'], and the
  2665. * resulting HTML is added to the output.
  2666. * - #value: Optional integer, string, or array representing which option(s)
  2667. * to pre-select when the list is first displayed. The integer or string
  2668. * must match the key of an option in the '#options' list. If '#multiple' is
  2669. * TRUE, this can be an array of integers or strings.
  2670. * @param array|null $choices
  2671. * (optional) Either an associative array of options in the same format as
  2672. * $element['#options'] above, or NULL. This parameter is only used internally
  2673. * and is not intended to be passed in to the initial function call.
  2674. *
  2675. * @return string
  2676. * An HTML string of options and optgroups for use in a select form element.
  2677. */
  2678. function form_select_options($element, $choices = NULL) {
  2679. if (!isset($choices)) {
  2680. $choices = $element['#options'];
  2681. }
  2682. // array_key_exists() accommodates the rare event where $element['#value'] is NULL.
  2683. // isset() fails in this situation.
  2684. $value_valid = isset($element['#value']) || array_key_exists('#value', $element);
  2685. $value_is_array = $value_valid && is_array($element['#value']);
  2686. $options = '';
  2687. foreach ($choices as $key => $choice) {
  2688. if (is_array($choice)) {
  2689. $options .= '<optgroup label="' . check_plain($key) . '">';
  2690. $options .= form_select_options($element, $choice);
  2691. $options .= '</optgroup>';
  2692. }
  2693. elseif (is_object($choice)) {
  2694. $options .= form_select_options($element, $choice->option);
  2695. }
  2696. else {
  2697. $key = (string) $key;
  2698. if ($value_valid && (!$value_is_array && (string) $element['#value'] === $key || ($value_is_array && in_array($key, $element['#value'])))) {
  2699. $selected = ' selected="selected"';
  2700. }
  2701. else {
  2702. $selected = '';
  2703. }
  2704. $options .= '<option value="' . check_plain($key) . '"' . $selected . '>' . check_plain($choice) . '</option>';
  2705. }
  2706. }
  2707. return $options;
  2708. }
  2709. /**
  2710. * Returns the indexes of a select element's options matching a given key.
  2711. *
  2712. * This function is useful if you need to modify the options that are
  2713. * already in a form element; for example, to remove choices which are
  2714. * not valid because of additional filters imposed by another module.
  2715. * One example might be altering the choices in a taxonomy selector.
  2716. * To correctly handle the case of a multiple hierarchy taxonomy,
  2717. * #options arrays can now hold an array of objects, instead of a
  2718. * direct mapping of keys to labels, so that multiple choices in the
  2719. * selector can have the same key (and label). This makes it difficult
  2720. * to manipulate directly, which is why this helper function exists.
  2721. *
  2722. * This function does not support optgroups (when the elements of the
  2723. * #options array are themselves arrays), and will return FALSE if
  2724. * arrays are found. The caller must either flatten/restore or
  2725. * manually do their manipulations in this case, since returning the
  2726. * index is not sufficient, and supporting this would make the
  2727. * "helper" too complicated and cumbersome to be of any help.
  2728. *
  2729. * As usual with functions that can return array() or FALSE, do not
  2730. * forget to use === and !== if needed.
  2731. *
  2732. * @param $element
  2733. * The select element to search.
  2734. * @param $key
  2735. * The key to look for.
  2736. *
  2737. * @return
  2738. * An array of indexes that match the given $key. Array will be
  2739. * empty if no elements were found. FALSE if optgroups were found.
  2740. */
  2741. function form_get_options($element, $key) {
  2742. $keys = array();
  2743. foreach ($element['#options'] as $index => $choice) {
  2744. if (is_array($choice)) {
  2745. return FALSE;
  2746. }
  2747. elseif (is_object($choice)) {
  2748. if (isset($choice->option[$key])) {
  2749. $keys[] = $index;
  2750. }
  2751. }
  2752. elseif ($index == $key) {
  2753. $keys[] = $index;
  2754. }
  2755. }
  2756. return $keys;
  2757. }
  2758. /**
  2759. * Returns HTML for a fieldset form element and its children.
  2760. *
  2761. * @param $variables
  2762. * An associative array containing:
  2763. * - element: An associative array containing the properties of the element.
  2764. * Properties used: #attributes, #children, #collapsed, #collapsible,
  2765. * #description, #id, #title, #value.
  2766. *
  2767. * @ingroup themeable
  2768. */
  2769. function theme_fieldset($variables) {
  2770. $element = $variables['element'];
  2771. element_set_attributes($element, array('id'));
  2772. _form_set_class($element, array('form-wrapper'));
  2773. $output = '<fieldset' . drupal_attributes($element['#attributes']) . '>';
  2774. if (!empty($element['#title'])) {
  2775. // Always wrap fieldset legends in a SPAN for CSS positioning.
  2776. $output .= '<legend><span class="fieldset-legend">' . $element['#title'] . '</span></legend>';
  2777. }
  2778. $output .= '<div class="fieldset-wrapper">';
  2779. if (!empty($element['#description'])) {
  2780. $output .= '<div class="fieldset-description">' . $element['#description'] . '</div>';
  2781. }
  2782. $output .= $element['#children'];
  2783. if (isset($element['#value'])) {
  2784. $output .= $element['#value'];
  2785. }
  2786. $output .= '</div>';
  2787. $output .= "</fieldset>\n";
  2788. return $output;
  2789. }
  2790. /**
  2791. * Returns HTML for a radio button form element.
  2792. *
  2793. * Note: The input "name" attribute needs to be sanitized before output, which
  2794. * is currently done by passing all attributes to drupal_attributes().
  2795. *
  2796. * @param $variables
  2797. * An associative array containing:
  2798. * - element: An associative array containing the properties of the element.
  2799. * Properties used: #required, #return_value, #value, #attributes, #title,
  2800. * #description
  2801. *
  2802. * @ingroup themeable
  2803. */
  2804. function theme_radio($variables) {
  2805. $element = $variables['element'];
  2806. $element['#attributes']['type'] = 'radio';
  2807. element_set_attributes($element, array('id', 'name', '#return_value' => 'value'));
  2808. if (isset($element['#return_value']) && $element['#value'] !== FALSE && $element['#value'] == $element['#return_value']) {
  2809. $element['#attributes']['checked'] = 'checked';
  2810. }
  2811. _form_set_class($element, array('form-radio'));
  2812. return '<input' . drupal_attributes($element['#attributes']) . ' />';
  2813. }
  2814. /**
  2815. * Returns HTML for a set of radio button form elements.
  2816. *
  2817. * @param $variables
  2818. * An associative array containing:
  2819. * - element: An associative array containing the properties of the element.
  2820. * Properties used: #title, #value, #options, #description, #required,
  2821. * #attributes, #children.
  2822. *
  2823. * @ingroup themeable
  2824. */
  2825. function theme_radios($variables) {
  2826. $element = $variables['element'];
  2827. $attributes = array();
  2828. if (isset($element['#id'])) {
  2829. $attributes['id'] = $element['#id'];
  2830. }
  2831. $attributes['class'] = 'form-radios';
  2832. if (!empty($element['#attributes']['class'])) {
  2833. $attributes['class'] .= ' ' . implode(' ', $element['#attributes']['class']);
  2834. }
  2835. if (isset($element['#attributes']['title'])) {
  2836. $attributes['title'] = $element['#attributes']['title'];
  2837. }
  2838. return '<div' . drupal_attributes($attributes) . '>' . (!empty($element['#children']) ? $element['#children'] : '') . '</div>';
  2839. }
  2840. /**
  2841. * Expand a password_confirm field into two text boxes.
  2842. */
  2843. function form_process_password_confirm($element) {
  2844. $element['pass1'] = array(
  2845. '#type' => 'password',
  2846. '#title' => t('Password'),
  2847. '#value' => empty($element['#value']) ? NULL : $element['#value']['pass1'],
  2848. '#required' => $element['#required'],
  2849. '#attributes' => array('class' => array('password-field')),
  2850. );
  2851. $element['pass2'] = array(
  2852. '#type' => 'password',
  2853. '#title' => t('Confirm password'),
  2854. '#value' => empty($element['#value']) ? NULL : $element['#value']['pass2'],
  2855. '#required' => $element['#required'],
  2856. '#attributes' => array('class' => array('password-confirm')),
  2857. );
  2858. $element['#element_validate'] = array('password_confirm_validate');
  2859. $element['#tree'] = TRUE;
  2860. if (isset($element['#size'])) {
  2861. $element['pass1']['#size'] = $element['pass2']['#size'] = $element['#size'];
  2862. }
  2863. return $element;
  2864. }
  2865. /**
  2866. * Validates a password_confirm element.
  2867. */
  2868. function password_confirm_validate($element, &$element_state) {
  2869. $pass1 = trim($element['pass1']['#value']);
  2870. $pass2 = trim($element['pass2']['#value']);
  2871. if (strlen($pass1) > 0 || strlen($pass2) > 0) {
  2872. if (strcmp($pass1, $pass2)) {
  2873. form_error($element, t('The specified passwords do not match.'));
  2874. }
  2875. }
  2876. elseif ($element['#required'] && !empty($element_state['input'])) {
  2877. form_error($element, t('Password field is required.'));
  2878. }
  2879. // Password field must be converted from a two-element array into a single
  2880. // string regardless of validation results.
  2881. form_set_value($element['pass1'], NULL, $element_state);
  2882. form_set_value($element['pass2'], NULL, $element_state);
  2883. form_set_value($element, $pass1, $element_state);
  2884. return $element;
  2885. }
  2886. /**
  2887. * Returns HTML for a date selection form element.
  2888. *
  2889. * @param $variables
  2890. * An associative array containing:
  2891. * - element: An associative array containing the properties of the element.
  2892. * Properties used: #title, #value, #options, #description, #required,
  2893. * #attributes.
  2894. *
  2895. * @ingroup themeable
  2896. */
  2897. function theme_date($variables) {
  2898. $element = $variables['element'];
  2899. $attributes = array();
  2900. if (isset($element['#id'])) {
  2901. $attributes['id'] = $element['#id'];
  2902. }
  2903. if (!empty($element['#attributes']['class'])) {
  2904. $attributes['class'] = (array) $element['#attributes']['class'];
  2905. }
  2906. $attributes['class'][] = 'container-inline';
  2907. return '<div' . drupal_attributes($attributes) . '>' . drupal_render_children($element) . '</div>';
  2908. }
  2909. /**
  2910. * Expands a date element into year, month, and day select elements.
  2911. */
  2912. function form_process_date($element) {
  2913. // Default to current date
  2914. if (empty($element['#value'])) {
  2915. $element['#value'] = array(
  2916. 'day' => format_date(REQUEST_TIME, 'custom', 'j'),
  2917. 'month' => format_date(REQUEST_TIME, 'custom', 'n'),
  2918. 'year' => format_date(REQUEST_TIME, 'custom', 'Y'),
  2919. );
  2920. }
  2921. $element['#tree'] = TRUE;
  2922. // Determine the order of day, month, year in the site's chosen date format.
  2923. $format = variable_get('date_format_short', 'm/d/Y - H:i');
  2924. $sort = array();
  2925. $sort['day'] = max(strpos($format, 'd'), strpos($format, 'j'));
  2926. $sort['month'] = max(strpos($format, 'm'), strpos($format, 'M'));
  2927. $sort['year'] = strpos($format, 'Y');
  2928. asort($sort);
  2929. $order = array_keys($sort);
  2930. // Output multi-selector for date.
  2931. foreach ($order as $type) {
  2932. switch ($type) {
  2933. case 'day':
  2934. $options = drupal_map_assoc(range(1, 31));
  2935. $title = t('Day');
  2936. break;
  2937. case 'month':
  2938. $options = drupal_map_assoc(range(1, 12), 'map_month');
  2939. $title = t('Month');
  2940. break;
  2941. case 'year':
  2942. $options = drupal_map_assoc(range(1900, 2050));
  2943. $title = t('Year');
  2944. break;
  2945. }
  2946. $element[$type] = array(
  2947. '#type' => 'select',
  2948. '#title' => $title,
  2949. '#title_display' => 'invisible',
  2950. '#value' => $element['#value'][$type],
  2951. '#attributes' => $element['#attributes'],
  2952. '#options' => $options,
  2953. );
  2954. }
  2955. return $element;
  2956. }
  2957. /**
  2958. * Validates the date type to prevent invalid dates (e.g., February 30, 2006).
  2959. */
  2960. function date_validate($element) {
  2961. if (!checkdate($element['#value']['month'], $element['#value']['day'], $element['#value']['year'])) {
  2962. form_error($element, t('The specified date is invalid.'));
  2963. }
  2964. }
  2965. /**
  2966. * Helper function for usage with drupal_map_assoc to display month names.
  2967. */
  2968. function map_month($month) {
  2969. $months = &drupal_static(__FUNCTION__, array(
  2970. 1 => 'Jan',
  2971. 2 => 'Feb',
  2972. 3 => 'Mar',
  2973. 4 => 'Apr',
  2974. 5 => 'May',
  2975. 6 => 'Jun',
  2976. 7 => 'Jul',
  2977. 8 => 'Aug',
  2978. 9 => 'Sep',
  2979. 10 => 'Oct',
  2980. 11 => 'Nov',
  2981. 12 => 'Dec',
  2982. ));
  2983. return t($months[$month]);
  2984. }
  2985. /**
  2986. * Sets the value for a weight element, with zero as a default.
  2987. */
  2988. function weight_value(&$form) {
  2989. if (isset($form['#default_value'])) {
  2990. $form['#value'] = $form['#default_value'];
  2991. }
  2992. else {
  2993. $form['#value'] = 0;
  2994. }
  2995. }
  2996. /**
  2997. * Expands a radios element into individual radio elements.
  2998. */
  2999. function form_process_radios($element) {
  3000. if (count($element['#options']) > 0) {
  3001. $weight = 0;
  3002. foreach ($element['#options'] as $key => $choice) {
  3003. // Maintain order of options as defined in #options, in case the element
  3004. // defines custom option sub-elements, but does not define all option
  3005. // sub-elements.
  3006. $weight += 0.001;
  3007. $element += array($key => array());
  3008. // Generate the parents as the autogenerator does, so we will have a
  3009. // unique id for each radio button.
  3010. $parents_for_id = array_merge($element['#parents'], array($key));
  3011. $element[$key] += array(
  3012. '#type' => 'radio',
  3013. '#title' => $choice,
  3014. // The key is sanitized in drupal_attributes() during output from the
  3015. // theme function.
  3016. '#return_value' => $key,
  3017. // Use default or FALSE. A value of FALSE means that the radio button is
  3018. // not 'checked'.
  3019. '#default_value' => isset($element['#default_value']) ? $element['#default_value'] : FALSE,
  3020. '#attributes' => $element['#attributes'],
  3021. '#parents' => $element['#parents'],
  3022. '#id' => drupal_html_id('edit-' . implode('-', $parents_for_id)),
  3023. '#ajax' => isset($element['#ajax']) ? $element['#ajax'] : NULL,
  3024. '#weight' => $weight,
  3025. );
  3026. }
  3027. }
  3028. return $element;
  3029. }
  3030. /**
  3031. * Returns HTML for a checkbox form element.
  3032. *
  3033. * @param $variables
  3034. * An associative array containing:
  3035. * - element: An associative array containing the properties of the element.
  3036. * Properties used: #id, #name, #attributes, #checked, #return_value.
  3037. *
  3038. * @ingroup themeable
  3039. */
  3040. function theme_checkbox($variables) {
  3041. $element = $variables['element'];
  3042. $element['#attributes']['type'] = 'checkbox';
  3043. element_set_attributes($element, array('id', 'name', '#return_value' => 'value'));
  3044. // Unchecked checkbox has #value of integer 0.
  3045. if (!empty($element['#checked'])) {
  3046. $element['#attributes']['checked'] = 'checked';
  3047. }
  3048. _form_set_class($element, array('form-checkbox'));
  3049. return '<input' . drupal_attributes($element['#attributes']) . ' />';
  3050. }
  3051. /**
  3052. * Returns HTML for a set of checkbox form elements.
  3053. *
  3054. * @param $variables
  3055. * An associative array containing:
  3056. * - element: An associative array containing the properties of the element.
  3057. * Properties used: #children, #attributes.
  3058. *
  3059. * @ingroup themeable
  3060. */
  3061. function theme_checkboxes($variables) {
  3062. $element = $variables['element'];
  3063. $attributes = array();
  3064. if (isset($element['#id'])) {
  3065. $attributes['id'] = $element['#id'];
  3066. }
  3067. $attributes['class'][] = 'form-checkboxes';
  3068. if (!empty($element['#attributes']['class'])) {
  3069. $attributes['class'] = array_merge($attributes['class'], $element['#attributes']['class']);
  3070. }
  3071. if (isset($element['#attributes']['title'])) {
  3072. $attributes['title'] = $element['#attributes']['title'];
  3073. }
  3074. return '<div' . drupal_attributes($attributes) . '>' . (!empty($element['#children']) ? $element['#children'] : '') . '</div>';
  3075. }
  3076. /**
  3077. * Adds form element theming to an element if its title or description is set.
  3078. *
  3079. * This is used as a pre render function for checkboxes and radios.
  3080. */
  3081. function form_pre_render_conditional_form_element($element) {
  3082. $t = get_t();
  3083. // Set the element's title attribute to show #title as a tooltip, if needed.
  3084. if (isset($element['#title']) && $element['#title_display'] == 'attribute') {
  3085. $element['#attributes']['title'] = $element['#title'];
  3086. if (!empty($element['#required'])) {
  3087. // Append an indication that this field is required.
  3088. $element['#attributes']['title'] .= ' (' . $t('Required') . ')';
  3089. }
  3090. }
  3091. if (isset($element['#title']) || isset($element['#description'])) {
  3092. $element['#theme_wrappers'][] = 'form_element';
  3093. }
  3094. return $element;
  3095. }
  3096. /**
  3097. * Sets the #checked property of a checkbox element.
  3098. */
  3099. function form_process_checkbox($element, $form_state) {
  3100. $value = $element['#value'];
  3101. $return_value = $element['#return_value'];
  3102. // On form submission, the #value of an available and enabled checked
  3103. // checkbox is #return_value, and the #value of an available and enabled
  3104. // unchecked checkbox is integer 0. On not submitted forms, and for
  3105. // checkboxes with #access=FALSE or #disabled=TRUE, the #value is
  3106. // #default_value (integer 0 if #default_value is NULL). Most of the time,
  3107. // a string comparison of #value and #return_value is sufficient for
  3108. // determining the "checked" state, but a value of TRUE always means checked
  3109. // (even if #return_value is 'foo'), and a value of FALSE or integer 0 always
  3110. // means unchecked (even if #return_value is '' or '0').
  3111. if ($value === TRUE || $value === FALSE || $value === 0) {
  3112. $element['#checked'] = (bool) $value;
  3113. }
  3114. else {
  3115. // Compare as strings, so that 15 is not considered equal to '15foo', but 1
  3116. // is considered equal to '1'. This cast does not imply that either #value
  3117. // or #return_value is expected to be a string.
  3118. $element['#checked'] = ((string) $value === (string) $return_value);
  3119. }
  3120. return $element;
  3121. }
  3122. /**
  3123. * Processes a checkboxes form element.
  3124. */
  3125. function form_process_checkboxes($element) {
  3126. $value = is_array($element['#value']) ? $element['#value'] : array();
  3127. $element['#tree'] = TRUE;
  3128. if (count($element['#options']) > 0) {
  3129. if (!isset($element['#default_value']) || $element['#default_value'] == 0) {
  3130. $element['#default_value'] = array();
  3131. }
  3132. $weight = 0;
  3133. foreach ($element['#options'] as $key => $choice) {
  3134. // Integer 0 is not a valid #return_value, so use '0' instead.
  3135. // @see form_type_checkbox_value().
  3136. // @todo For Drupal 8, cast all integer keys to strings for consistency
  3137. // with form_process_radios().
  3138. if ($key === 0) {
  3139. $key = '0';
  3140. }
  3141. // Maintain order of options as defined in #options, in case the element
  3142. // defines custom option sub-elements, but does not define all option
  3143. // sub-elements.
  3144. $weight += 0.001;
  3145. $element += array($key => array());
  3146. $element[$key] += array(
  3147. '#type' => 'checkbox',
  3148. '#title' => $choice,
  3149. '#return_value' => $key,
  3150. '#default_value' => isset($value[$key]) ? $key : NULL,
  3151. '#attributes' => $element['#attributes'],
  3152. '#ajax' => isset($element['#ajax']) ? $element['#ajax'] : NULL,
  3153. '#weight' => $weight,
  3154. );
  3155. }
  3156. }
  3157. return $element;
  3158. }
  3159. /**
  3160. * Processes a form actions container element.
  3161. *
  3162. * @param $element
  3163. * An associative array containing the properties and children of the
  3164. * form actions container.
  3165. * @param $form_state
  3166. * The $form_state array for the form this element belongs to.
  3167. *
  3168. * @return
  3169. * The processed element.
  3170. */
  3171. function form_process_actions($element, &$form_state) {
  3172. $element['#attributes']['class'][] = 'form-actions';
  3173. return $element;
  3174. }
  3175. /**
  3176. * Processes a container element.
  3177. *
  3178. * @param $element
  3179. * An associative array containing the properties and children of the
  3180. * container.
  3181. * @param $form_state
  3182. * The $form_state array for the form this element belongs to.
  3183. *
  3184. * @return
  3185. * The processed element.
  3186. */
  3187. function form_process_container($element, &$form_state) {
  3188. // Generate the ID of the element if it's not explicitly given.
  3189. if (!isset($element['#id'])) {
  3190. $element['#id'] = drupal_html_id(implode('-', $element['#parents']) . '-wrapper');
  3191. }
  3192. return $element;
  3193. }
  3194. /**
  3195. * Returns HTML to wrap child elements in a container.
  3196. *
  3197. * Used for grouped form items. Can also be used as a theme wrapper for any
  3198. * renderable element, to surround it with a <div> and add attributes such as
  3199. * classes or an HTML ID.
  3200. *
  3201. * See the @link forms_api_reference.html Form API reference @endlink for more
  3202. * information on the #theme_wrappers render array property.
  3203. *
  3204. * @param $variables
  3205. * An associative array containing:
  3206. * - element: An associative array containing the properties of the element.
  3207. * Properties used: #id, #attributes, #children.
  3208. *
  3209. * @ingroup themeable
  3210. */
  3211. function theme_container($variables) {
  3212. $element = $variables['element'];
  3213. // Ensure #attributes is set.
  3214. $element += array('#attributes' => array());
  3215. // Special handling for form elements.
  3216. if (isset($element['#array_parents'])) {
  3217. // Assign an html ID.
  3218. if (!isset($element['#attributes']['id'])) {
  3219. $element['#attributes']['id'] = $element['#id'];
  3220. }
  3221. // Add the 'form-wrapper' class.
  3222. $element['#attributes']['class'][] = 'form-wrapper';
  3223. }
  3224. return '<div' . drupal_attributes($element['#attributes']) . '>' . $element['#children'] . '</div>';
  3225. }
  3226. /**
  3227. * Returns HTML for a table with radio buttons or checkboxes.
  3228. *
  3229. * @param $variables
  3230. * An associative array containing:
  3231. * - element: An associative array containing the properties and children of
  3232. * the tableselect element. Properties used: #header, #options, #empty,
  3233. * and #js_select. The #options property is an array of selection options;
  3234. * each array element of #options is an array of properties. These
  3235. * properties can include #attributes, which is added to the
  3236. * table row's HTML attributes; see theme_table(). An example of per-row
  3237. * options:
  3238. * @code
  3239. * $options = array(
  3240. * array(
  3241. * 'title' => 'How to Learn Drupal',
  3242. * 'content_type' => 'Article',
  3243. * 'status' => 'published',
  3244. * '#attributes' => array('class' => array('article-row')),
  3245. * ),
  3246. * array(
  3247. * 'title' => 'Privacy Policy',
  3248. * 'content_type' => 'Page',
  3249. * 'status' => 'published',
  3250. * '#attributes' => array('class' => array('page-row')),
  3251. * ),
  3252. * );
  3253. * $header = array(
  3254. * 'title' => t('Title'),
  3255. * 'content_type' => t('Content type'),
  3256. * 'status' => t('Status'),
  3257. * );
  3258. * $form['table'] = array(
  3259. * '#type' => 'tableselect',
  3260. * '#header' => $header,
  3261. * '#options' => $options,
  3262. * '#empty' => t('No content available.'),
  3263. * );
  3264. * @endcode
  3265. *
  3266. * @ingroup themeable
  3267. */
  3268. function theme_tableselect($variables) {
  3269. $element = $variables['element'];
  3270. $rows = array();
  3271. $header = $element['#header'];
  3272. if (!empty($element['#options'])) {
  3273. // Generate a table row for each selectable item in #options.
  3274. foreach (element_children($element) as $key) {
  3275. $row = array();
  3276. $row['data'] = array();
  3277. if (isset($element['#options'][$key]['#attributes'])) {
  3278. $row += $element['#options'][$key]['#attributes'];
  3279. }
  3280. // Render the checkbox / radio element.
  3281. $row['data'][] = drupal_render($element[$key]);
  3282. // As theme_table only maps header and row columns by order, create the
  3283. // correct order by iterating over the header fields.
  3284. foreach ($element['#header'] as $fieldname => $title) {
  3285. $row['data'][] = $element['#options'][$key][$fieldname];
  3286. }
  3287. $rows[] = $row;
  3288. }
  3289. // Add an empty header or a "Select all" checkbox to provide room for the
  3290. // checkboxes/radios in the first table column.
  3291. if ($element['#js_select']) {
  3292. // Add a "Select all" checkbox.
  3293. drupal_add_js('misc/tableselect.js');
  3294. array_unshift($header, array('class' => array('select-all')));
  3295. }
  3296. else {
  3297. // Add an empty header when radio buttons are displayed or a "Select all"
  3298. // checkbox is not desired.
  3299. array_unshift($header, '');
  3300. }
  3301. }
  3302. return theme('table', array('header' => $header, 'rows' => $rows, 'empty' => $element['#empty'], 'attributes' => $element['#attributes']));
  3303. }
  3304. /**
  3305. * Creates checkbox or radio elements to populate a tableselect table.
  3306. *
  3307. * @param $element
  3308. * An associative array containing the properties and children of the
  3309. * tableselect element.
  3310. *
  3311. * @return
  3312. * The processed element.
  3313. */
  3314. function form_process_tableselect($element) {
  3315. if ($element['#multiple']) {
  3316. $value = is_array($element['#value']) ? $element['#value'] : array();
  3317. }
  3318. else {
  3319. // Advanced selection behavior makes no sense for radios.
  3320. $element['#js_select'] = FALSE;
  3321. }
  3322. $element['#tree'] = TRUE;
  3323. if (count($element['#options']) > 0) {
  3324. if (!isset($element['#default_value']) || $element['#default_value'] === 0) {
  3325. $element['#default_value'] = array();
  3326. }
  3327. // Create a checkbox or radio for each item in #options in such a way that
  3328. // the value of the tableselect element behaves as if it had been of type
  3329. // checkboxes or radios.
  3330. foreach ($element['#options'] as $key => $choice) {
  3331. // Do not overwrite manually created children.
  3332. if (!isset($element[$key])) {
  3333. if ($element['#multiple']) {
  3334. $title = '';
  3335. if (!empty($element['#options'][$key]['title']['data']['#title'])) {
  3336. $title = t('Update @title', array(
  3337. '@title' => $element['#options'][$key]['title']['data']['#title'],
  3338. ));
  3339. }
  3340. $element[$key] = array(
  3341. '#type' => 'checkbox',
  3342. '#title' => $title,
  3343. '#title_display' => 'invisible',
  3344. '#return_value' => $key,
  3345. '#default_value' => isset($value[$key]) ? $key : NULL,
  3346. '#attributes' => $element['#attributes'],
  3347. '#ajax' => isset($element['#ajax']) ? $element['#ajax'] : NULL,
  3348. );
  3349. }
  3350. else {
  3351. // Generate the parents as the autogenerator does, so we will have a
  3352. // unique id for each radio button.
  3353. $parents_for_id = array_merge($element['#parents'], array($key));
  3354. $element[$key] = array(
  3355. '#type' => 'radio',
  3356. '#title' => '',
  3357. '#return_value' => $key,
  3358. '#default_value' => ($element['#default_value'] == $key) ? $key : NULL,
  3359. '#attributes' => $element['#attributes'],
  3360. '#parents' => $element['#parents'],
  3361. '#id' => drupal_html_id('edit-' . implode('-', $parents_for_id)),
  3362. '#ajax' => isset($element['#ajax']) ? $element['#ajax'] : NULL,
  3363. );
  3364. }
  3365. if (isset($element['#options'][$key]['#weight'])) {
  3366. $element[$key]['#weight'] = $element['#options'][$key]['#weight'];
  3367. }
  3368. }
  3369. }
  3370. }
  3371. else {
  3372. $element['#value'] = array();
  3373. }
  3374. return $element;
  3375. }
  3376. /**
  3377. * Processes a machine-readable name form element.
  3378. *
  3379. * @param $element
  3380. * The form element to process. Properties used:
  3381. * - #machine_name: An associative array containing:
  3382. * - exists: A function name to invoke for checking whether a submitted
  3383. * machine name value already exists. The submitted value is passed as
  3384. * argument. In most cases, an existing API or menu argument loader
  3385. * function can be re-used. The callback is only invoked, if the submitted
  3386. * value differs from the element's #default_value.
  3387. * - source: (optional) The #array_parents of the form element containing
  3388. * the human-readable name (i.e., as contained in the $form structure) to
  3389. * use as source for the machine name. Defaults to array('name').
  3390. * - label: (optional) A text to display as label for the machine name value
  3391. * after the human-readable name form element. Defaults to "Machine name".
  3392. * - replace_pattern: (optional) A regular expression (without delimiters)
  3393. * matching disallowed characters in the machine name. Defaults to
  3394. * '[^a-z0-9_]+'.
  3395. * - replace: (optional) A character to replace disallowed characters in the
  3396. * machine name via JavaScript. Defaults to '_' (underscore). When using a
  3397. * different character, 'replace_pattern' needs to be set accordingly.
  3398. * - error: (optional) A custom form error message string to show, if the
  3399. * machine name contains disallowed characters.
  3400. * - standalone: (optional) Whether the live preview should stay in its own
  3401. * form element rather than in the suffix of the source element. Defaults
  3402. * to FALSE.
  3403. * - #maxlength: (optional) Should be set to the maximum allowed length of the
  3404. * machine name. Defaults to 64.
  3405. * - #disabled: (optional) Should be set to TRUE in case an existing machine
  3406. * name must not be changed after initial creation.
  3407. */
  3408. function form_process_machine_name($element, &$form_state) {
  3409. // Apply default form element properties.
  3410. $element += array(
  3411. '#title' => t('Machine-readable name'),
  3412. '#description' => t('A unique machine-readable name. Can only contain lowercase letters, numbers, and underscores.'),
  3413. '#machine_name' => array(),
  3414. '#field_prefix' => '',
  3415. '#field_suffix' => '',
  3416. '#suffix' => '',
  3417. );
  3418. // A form element that only wants to set one #machine_name property (usually
  3419. // 'source' only) would leave all other properties undefined, if the defaults
  3420. // were defined in hook_element_info(). Therefore, we apply the defaults here.
  3421. $element['#machine_name'] += array(
  3422. 'source' => array('name'),
  3423. 'target' => '#' . $element['#id'],
  3424. 'label' => t('Machine name'),
  3425. 'replace_pattern' => '[^a-z0-9_]+',
  3426. 'replace' => '_',
  3427. 'standalone' => FALSE,
  3428. 'field_prefix' => $element['#field_prefix'],
  3429. 'field_suffix' => $element['#field_suffix'],
  3430. );
  3431. // By default, machine names are restricted to Latin alphanumeric characters.
  3432. // So, default to LTR directionality.
  3433. if (!isset($element['#attributes'])) {
  3434. $element['#attributes'] = array();
  3435. }
  3436. $element['#attributes'] += array('dir' => 'ltr');
  3437. // The source element defaults to array('name'), but may have been overidden.
  3438. if (empty($element['#machine_name']['source'])) {
  3439. return $element;
  3440. }
  3441. // Retrieve the form element containing the human-readable name from the
  3442. // complete form in $form_state. By reference, because we may need to append
  3443. // a #field_suffix that will hold the live preview.
  3444. $key_exists = NULL;
  3445. $source = drupal_array_get_nested_value($form_state['complete form'], $element['#machine_name']['source'], $key_exists);
  3446. if (!$key_exists) {
  3447. return $element;
  3448. }
  3449. $suffix_id = $source['#id'] . '-machine-name-suffix';
  3450. $element['#machine_name']['suffix'] = '#' . $suffix_id;
  3451. if ($element['#machine_name']['standalone']) {
  3452. $element['#suffix'] .= ' <small id="' . $suffix_id . '">&nbsp;</small>';
  3453. }
  3454. else {
  3455. // Append a field suffix to the source form element, which will contain
  3456. // the live preview of the machine name.
  3457. $source += array('#field_suffix' => '');
  3458. $source['#field_suffix'] .= ' <small id="' . $suffix_id . '">&nbsp;</small>';
  3459. $parents = array_merge($element['#machine_name']['source'], array('#field_suffix'));
  3460. drupal_array_set_nested_value($form_state['complete form'], $parents, $source['#field_suffix']);
  3461. }
  3462. $js_settings = array(
  3463. 'type' => 'setting',
  3464. 'data' => array(
  3465. 'machineName' => array(
  3466. '#' . $source['#id'] => $element['#machine_name'],
  3467. ),
  3468. ),
  3469. );
  3470. $element['#attached']['js'][] = 'misc/machine-name.js';
  3471. $element['#attached']['js'][] = $js_settings;
  3472. return $element;
  3473. }
  3474. /**
  3475. * Form element validation handler for machine_name elements.
  3476. *
  3477. * Note that #maxlength is validated by _form_validate() already.
  3478. */
  3479. function form_validate_machine_name(&$element, &$form_state) {
  3480. // Verify that the machine name not only consists of replacement tokens.
  3481. if (preg_match('@^' . $element['#machine_name']['replace'] . '+$@', $element['#value'])) {
  3482. form_error($element, t('The machine-readable name must contain unique characters.'));
  3483. }
  3484. // Verify that the machine name contains no disallowed characters.
  3485. if (preg_match('@' . $element['#machine_name']['replace_pattern'] . '@', $element['#value'])) {
  3486. if (!isset($element['#machine_name']['error'])) {
  3487. // Since a hyphen is the most common alternative replacement character,
  3488. // a corresponding validation error message is supported here.
  3489. if ($element['#machine_name']['replace'] == '-') {
  3490. form_error($element, t('The machine-readable name must contain only lowercase letters, numbers, and hyphens.'));
  3491. }
  3492. // Otherwise, we assume the default (underscore).
  3493. else {
  3494. form_error($element, t('The machine-readable name must contain only lowercase letters, numbers, and underscores.'));
  3495. }
  3496. }
  3497. else {
  3498. form_error($element, $element['#machine_name']['error']);
  3499. }
  3500. }
  3501. // Verify that the machine name is unique.
  3502. if ($element['#default_value'] !== $element['#value']) {
  3503. $function = $element['#machine_name']['exists'];
  3504. if ($function($element['#value'], $element, $form_state)) {
  3505. form_error($element, t('The machine-readable name is already in use. It must be unique.'));
  3506. }
  3507. }
  3508. }
  3509. /**
  3510. * Arranges fieldsets into groups.
  3511. *
  3512. * @param $element
  3513. * An associative array containing the properties and children of the
  3514. * fieldset. Note that $element must be taken by reference here, so processed
  3515. * child elements are taken over into $form_state.
  3516. * @param $form_state
  3517. * The $form_state array for the form this fieldset belongs to.
  3518. *
  3519. * @return
  3520. * The processed element.
  3521. */
  3522. function form_process_fieldset(&$element, &$form_state) {
  3523. $parents = implode('][', $element['#parents']);
  3524. // Each fieldset forms a new group. The #type 'vertical_tabs' basically only
  3525. // injects a new fieldset.
  3526. $form_state['groups'][$parents]['#group_exists'] = TRUE;
  3527. $element['#groups'] = &$form_state['groups'];
  3528. // Process vertical tabs group member fieldsets.
  3529. if (isset($element['#group'])) {
  3530. // Add this fieldset to the defined group (by reference).
  3531. $group = $element['#group'];
  3532. $form_state['groups'][$group][] = &$element;
  3533. }
  3534. // Contains form element summary functionalities.
  3535. $element['#attached']['library'][] = array('system', 'drupal.form');
  3536. // The .form-wrapper class is required for #states to treat fieldsets like
  3537. // containers.
  3538. if (!isset($element['#attributes']['class'])) {
  3539. $element['#attributes']['class'] = array();
  3540. }
  3541. // Collapsible fieldsets
  3542. if (!empty($element['#collapsible'])) {
  3543. $element['#attached']['library'][] = array('system', 'drupal.collapse');
  3544. $element['#attributes']['class'][] = 'collapsible';
  3545. if (!empty($element['#collapsed'])) {
  3546. $element['#attributes']['class'][] = 'collapsed';
  3547. }
  3548. }
  3549. return $element;
  3550. }
  3551. /**
  3552. * Adds members of this group as actual elements for rendering.
  3553. *
  3554. * @param $element
  3555. * An associative array containing the properties and children of the
  3556. * fieldset.
  3557. *
  3558. * @return
  3559. * The modified element with all group members.
  3560. */
  3561. function form_pre_render_fieldset($element) {
  3562. // Fieldsets may be rendered outside of a Form API context.
  3563. if (!isset($element['#parents']) || !isset($element['#groups'])) {
  3564. return $element;
  3565. }
  3566. // Inject group member elements belonging to this group.
  3567. $parents = implode('][', $element['#parents']);
  3568. $children = element_children($element['#groups'][$parents]);
  3569. if (!empty($children)) {
  3570. foreach ($children as $key) {
  3571. // Break references and indicate that the element should be rendered as
  3572. // group member.
  3573. $child = (array) $element['#groups'][$parents][$key];
  3574. $child['#group_fieldset'] = TRUE;
  3575. // Inject the element as new child element.
  3576. $element[] = $child;
  3577. $sort = TRUE;
  3578. }
  3579. // Re-sort the element's children if we injected group member elements.
  3580. if (isset($sort)) {
  3581. $element['#sorted'] = FALSE;
  3582. }
  3583. }
  3584. if (isset($element['#group'])) {
  3585. $group = $element['#group'];
  3586. // If this element belongs to a group, but the group-holding element does
  3587. // not exist, we need to render it (at its original location).
  3588. if (!isset($element['#groups'][$group]['#group_exists'])) {
  3589. // Intentionally empty to clarify the flow; we simply return $element.
  3590. }
  3591. // If we injected this element into the group, then we want to render it.
  3592. elseif (!empty($element['#group_fieldset'])) {
  3593. // Intentionally empty to clarify the flow; we simply return $element.
  3594. }
  3595. // Otherwise, this element belongs to a group and the group exists, so we do
  3596. // not render it.
  3597. elseif (element_children($element['#groups'][$group])) {
  3598. $element['#printed'] = TRUE;
  3599. }
  3600. }
  3601. return $element;
  3602. }
  3603. /**
  3604. * Creates a group formatted as vertical tabs.
  3605. *
  3606. * @param $element
  3607. * An associative array containing the properties and children of the
  3608. * fieldset.
  3609. * @param $form_state
  3610. * The $form_state array for the form this vertical tab widget belongs to.
  3611. *
  3612. * @return
  3613. * The processed element.
  3614. */
  3615. function form_process_vertical_tabs($element, &$form_state) {
  3616. // Inject a new fieldset as child, so that form_process_fieldset() processes
  3617. // this fieldset like any other fieldset.
  3618. $element['group'] = array(
  3619. '#type' => 'fieldset',
  3620. '#theme_wrappers' => array(),
  3621. '#parents' => $element['#parents'],
  3622. );
  3623. // The JavaScript stores the currently selected tab in this hidden
  3624. // field so that the active tab can be restored the next time the
  3625. // form is rendered, e.g. on preview pages or when form validation
  3626. // fails.
  3627. $name = implode('__', $element['#parents']);
  3628. if (isset($form_state['values'][$name . '__active_tab'])) {
  3629. $element['#default_tab'] = $form_state['values'][$name . '__active_tab'];
  3630. }
  3631. $element[$name . '__active_tab'] = array(
  3632. '#type' => 'hidden',
  3633. '#default_value' => $element['#default_tab'],
  3634. '#attributes' => array('class' => array('vertical-tabs-active-tab')),
  3635. );
  3636. return $element;
  3637. }
  3638. /**
  3639. * Returns HTML for an element's children fieldsets as vertical tabs.
  3640. *
  3641. * @param $variables
  3642. * An associative array containing:
  3643. * - element: An associative array containing the properties and children of
  3644. * the fieldset. Properties used: #children.
  3645. *
  3646. * @ingroup themeable
  3647. */
  3648. function theme_vertical_tabs($variables) {
  3649. $element = $variables['element'];
  3650. // Add required JavaScript and Stylesheet.
  3651. drupal_add_library('system', 'drupal.vertical-tabs');
  3652. $output = '<h2 class="element-invisible">' . t('Vertical Tabs') . '</h2>';
  3653. $output .= '<div class="vertical-tabs-panes">' . $element['#children'] . '</div>';
  3654. return $output;
  3655. }
  3656. /**
  3657. * Returns HTML for a submit button form element.
  3658. *
  3659. * @param $variables
  3660. * An associative array containing:
  3661. * - element: An associative array containing the properties of the element.
  3662. * Properties used: #attributes, #button_type, #name, #value.
  3663. *
  3664. * @ingroup themeable
  3665. */
  3666. function theme_submit($variables) {
  3667. return theme('button', $variables['element']);
  3668. }
  3669. /**
  3670. * Returns HTML for a button form element.
  3671. *
  3672. * @param $variables
  3673. * An associative array containing:
  3674. * - element: An associative array containing the properties of the element.
  3675. * Properties used: #attributes, #button_type, #name, #value.
  3676. *
  3677. * @ingroup themeable
  3678. */
  3679. function theme_button($variables) {
  3680. $element = $variables['element'];
  3681. $element['#attributes']['type'] = 'submit';
  3682. element_set_attributes($element, array('id', 'name', 'value'));
  3683. $element['#attributes']['class'][] = 'form-' . $element['#button_type'];
  3684. if (!empty($element['#attributes']['disabled'])) {
  3685. $element['#attributes']['class'][] = 'form-button-disabled';
  3686. }
  3687. return '<input' . drupal_attributes($element['#attributes']) . ' />';
  3688. }
  3689. /**
  3690. * Returns HTML for an image button form element.
  3691. *
  3692. * @param $variables
  3693. * An associative array containing:
  3694. * - element: An associative array containing the properties of the element.
  3695. * Properties used: #attributes, #button_type, #name, #value, #title, #src.
  3696. *
  3697. * @ingroup themeable
  3698. */
  3699. function theme_image_button($variables) {
  3700. $element = $variables['element'];
  3701. $element['#attributes']['type'] = 'image';
  3702. element_set_attributes($element, array('id', 'name', 'value'));
  3703. $element['#attributes']['src'] = file_create_url($element['#src']);
  3704. if (!empty($element['#title'])) {
  3705. $element['#attributes']['alt'] = $element['#title'];
  3706. $element['#attributes']['title'] = $element['#title'];
  3707. }
  3708. $element['#attributes']['class'][] = 'form-' . $element['#button_type'];
  3709. if (!empty($element['#attributes']['disabled'])) {
  3710. $element['#attributes']['class'][] = 'form-button-disabled';
  3711. }
  3712. return '<input' . drupal_attributes($element['#attributes']) . ' />';
  3713. }
  3714. /**
  3715. * Returns HTML for a hidden form element.
  3716. *
  3717. * @param $variables
  3718. * An associative array containing:
  3719. * - element: An associative array containing the properties of the element.
  3720. * Properties used: #name, #value, #attributes.
  3721. *
  3722. * @ingroup themeable
  3723. */
  3724. function theme_hidden($variables) {
  3725. $element = $variables['element'];
  3726. $element['#attributes']['type'] = 'hidden';
  3727. element_set_attributes($element, array('name', 'value'));
  3728. return '<input' . drupal_attributes($element['#attributes']) . " />\n";
  3729. }
  3730. /**
  3731. * Process function to prepare autocomplete data.
  3732. *
  3733. * @param $element
  3734. * A textfield or other element with a #autocomplete_path.
  3735. *
  3736. * @return array
  3737. * The processed form element.
  3738. */
  3739. function form_process_autocomplete($element) {
  3740. $element['#autocomplete_input'] = array();
  3741. if ($element['#autocomplete_path'] && drupal_valid_path($element['#autocomplete_path'])) {
  3742. $element['#autocomplete_input']['#id'] = $element['#id'] .'-autocomplete';
  3743. // Force autocomplete to use non-clean URLs since this protects against the
  3744. // browser interpreting the path plus search string as an actual file.
  3745. $current_clean_url = isset($GLOBALS['conf']['clean_url']) ? $GLOBALS['conf']['clean_url'] : NULL;
  3746. $GLOBALS['conf']['clean_url'] = 0;
  3747. // Force the script path to 'index.php', in case the server is not
  3748. // configured to find it automatically. Normally it is the responsibility
  3749. // of the site to do this themselves using hook_url_outbound_alter() (see
  3750. // url()) but since this code is forcing non-clean URLs on sites that don't
  3751. // normally use them, it is done here instead.
  3752. $element['#autocomplete_input']['#url_value'] = url($element['#autocomplete_path'], array('absolute' => TRUE, 'script' => 'index.php'));
  3753. $GLOBALS['conf']['clean_url'] = $current_clean_url;
  3754. }
  3755. return $element;
  3756. }
  3757. /**
  3758. * Returns HTML for a textfield form element.
  3759. *
  3760. * @param $variables
  3761. * An associative array containing:
  3762. * - element: An associative array containing the properties of the element.
  3763. * Properties used: #title, #value, #description, #size, #maxlength,
  3764. * #required, #attributes, #autocomplete_path.
  3765. *
  3766. * @ingroup themeable
  3767. */
  3768. function theme_textfield($variables) {
  3769. $element = $variables['element'];
  3770. $element['#attributes']['type'] = 'text';
  3771. element_set_attributes($element, array('id', 'name', 'value', 'size', 'maxlength'));
  3772. _form_set_class($element, array('form-text'));
  3773. $extra = '';
  3774. if ($element['#autocomplete_path'] && !empty($element['#autocomplete_input'])) {
  3775. drupal_add_library('system', 'drupal.autocomplete');
  3776. $element['#attributes']['class'][] = 'form-autocomplete';
  3777. $attributes = array();
  3778. $attributes['type'] = 'hidden';
  3779. $attributes['id'] = $element['#autocomplete_input']['#id'];
  3780. $attributes['value'] = $element['#autocomplete_input']['#url_value'];
  3781. $attributes['disabled'] = 'disabled';
  3782. $attributes['class'][] = 'autocomplete';
  3783. $extra = '<input' . drupal_attributes($attributes) . ' />';
  3784. }
  3785. $output = '<input' . drupal_attributes($element['#attributes']) . ' />';
  3786. return $output . $extra;
  3787. }
  3788. /**
  3789. * Returns HTML for a form.
  3790. *
  3791. * @param $variables
  3792. * An associative array containing:
  3793. * - element: An associative array containing the properties of the element.
  3794. * Properties used: #action, #method, #attributes, #children
  3795. *
  3796. * @ingroup themeable
  3797. */
  3798. function theme_form($variables) {
  3799. $element = $variables['element'];
  3800. if (isset($element['#action'])) {
  3801. $element['#attributes']['action'] = drupal_strip_dangerous_protocols($element['#action']);
  3802. }
  3803. element_set_attributes($element, array('method', 'id'));
  3804. if (empty($element['#attributes']['accept-charset'])) {
  3805. $element['#attributes']['accept-charset'] = "UTF-8";
  3806. }
  3807. // Anonymous DIV to satisfy XHTML compliance.
  3808. return '<form' . drupal_attributes($element['#attributes']) . '><div>' . $element['#children'] . '</div></form>';
  3809. }
  3810. /**
  3811. * Returns HTML for a textarea form element.
  3812. *
  3813. * @param $variables
  3814. * An associative array containing:
  3815. * - element: An associative array containing the properties of the element.
  3816. * Properties used: #title, #value, #description, #rows, #cols, #required,
  3817. * #attributes
  3818. *
  3819. * @ingroup themeable
  3820. */
  3821. function theme_textarea($variables) {
  3822. $element = $variables['element'];
  3823. element_set_attributes($element, array('id', 'name', 'cols', 'rows'));
  3824. _form_set_class($element, array('form-textarea'));
  3825. $wrapper_attributes = array(
  3826. 'class' => array('form-textarea-wrapper'),
  3827. );
  3828. // Add resizable behavior.
  3829. if (!empty($element['#resizable'])) {
  3830. drupal_add_library('system', 'drupal.textarea');
  3831. $wrapper_attributes['class'][] = 'resizable';
  3832. }
  3833. $output = '<div' . drupal_attributes($wrapper_attributes) . '>';
  3834. $output .= '<textarea' . drupal_attributes($element['#attributes']) . '>' . check_plain($element['#value']) . '</textarea>';
  3835. $output .= '</div>';
  3836. return $output;
  3837. }
  3838. /**
  3839. * Returns HTML for a password form element.
  3840. *
  3841. * @param $variables
  3842. * An associative array containing:
  3843. * - element: An associative array containing the properties of the element.
  3844. * Properties used: #title, #value, #description, #size, #maxlength,
  3845. * #required, #attributes.
  3846. *
  3847. * @ingroup themeable
  3848. */
  3849. function theme_password($variables) {
  3850. $element = $variables['element'];
  3851. $element['#attributes']['type'] = 'password';
  3852. element_set_attributes($element, array('id', 'name', 'size', 'maxlength'));
  3853. _form_set_class($element, array('form-text'));
  3854. return '<input' . drupal_attributes($element['#attributes']) . ' />';
  3855. }
  3856. /**
  3857. * Expands a weight element into a select element.
  3858. */
  3859. function form_process_weight($element) {
  3860. $element['#is_weight'] = TRUE;
  3861. // If the number of options is small enough, use a select field.
  3862. $max_elements = variable_get('drupal_weight_select_max', DRUPAL_WEIGHT_SELECT_MAX);
  3863. if ($element['#delta'] <= $max_elements) {
  3864. $element['#type'] = 'select';
  3865. for ($n = (-1 * $element['#delta']); $n <= $element['#delta']; $n++) {
  3866. $weights[$n] = $n;
  3867. }
  3868. $element['#options'] = $weights;
  3869. $element += element_info('select');
  3870. }
  3871. // Otherwise, use a text field.
  3872. else {
  3873. $element['#type'] = 'textfield';
  3874. // Use a field big enough to fit most weights.
  3875. $element['#size'] = 10;
  3876. $element['#element_validate'] = array('element_validate_integer');
  3877. $element += element_info('textfield');
  3878. }
  3879. return $element;
  3880. }
  3881. /**
  3882. * Returns HTML for a file upload form element.
  3883. *
  3884. * For assistance with handling the uploaded file correctly, see the API
  3885. * provided by file.inc.
  3886. *
  3887. * @param $variables
  3888. * An associative array containing:
  3889. * - element: An associative array containing the properties of the element.
  3890. * Properties used: #title, #name, #size, #description, #required,
  3891. * #attributes.
  3892. *
  3893. * @ingroup themeable
  3894. */
  3895. function theme_file($variables) {
  3896. $element = $variables['element'];
  3897. $element['#attributes']['type'] = 'file';
  3898. element_set_attributes($element, array('id', 'name', 'size'));
  3899. _form_set_class($element, array('form-file'));
  3900. return '<input' . drupal_attributes($element['#attributes']) . ' />';
  3901. }
  3902. /**
  3903. * Returns HTML for a form element.
  3904. *
  3905. * Each form element is wrapped in a DIV container having the following CSS
  3906. * classes:
  3907. * - form-item: Generic for all form elements.
  3908. * - form-type-#type: The internal element #type.
  3909. * - form-item-#name: The internal form element #name (usually derived from the
  3910. * $form structure and set via form_builder()).
  3911. * - form-disabled: Only set if the form element is #disabled.
  3912. *
  3913. * In addition to the element itself, the DIV contains a label for the element
  3914. * based on the optional #title_display property, and an optional #description.
  3915. *
  3916. * The optional #title_display property can have these values:
  3917. * - before: The label is output before the element. This is the default.
  3918. * The label includes the #title and the required marker, if #required.
  3919. * - after: The label is output after the element. For example, this is used
  3920. * for radio and checkbox #type elements as set in system_element_info().
  3921. * If the #title is empty but the field is #required, the label will
  3922. * contain only the required marker.
  3923. * - invisible: Labels are critical for screen readers to enable them to
  3924. * properly navigate through forms but can be visually distracting. This
  3925. * property hides the label for everyone except screen readers.
  3926. * - attribute: Set the title attribute on the element to create a tooltip
  3927. * but output no label element. This is supported only for checkboxes
  3928. * and radios in form_pre_render_conditional_form_element(). It is used
  3929. * where a visual label is not needed, such as a table of checkboxes where
  3930. * the row and column provide the context. The tooltip will include the
  3931. * title and required marker.
  3932. *
  3933. * If the #title property is not set, then the label and any required marker
  3934. * will not be output, regardless of the #title_display or #required values.
  3935. * This can be useful in cases such as the password_confirm element, which
  3936. * creates children elements that have their own labels and required markers,
  3937. * but the parent element should have neither. Use this carefully because a
  3938. * field without an associated label can cause accessibility challenges.
  3939. *
  3940. * @param $variables
  3941. * An associative array containing:
  3942. * - element: An associative array containing the properties of the element.
  3943. * Properties used: #title, #title_display, #description, #id, #required,
  3944. * #children, #type, #name.
  3945. *
  3946. * @ingroup themeable
  3947. */
  3948. function theme_form_element($variables) {
  3949. $element = &$variables['element'];
  3950. // This function is invoked as theme wrapper, but the rendered form element
  3951. // may not necessarily have been processed by form_builder().
  3952. $element += array(
  3953. '#title_display' => 'before',
  3954. );
  3955. // Add element #id for #type 'item'.
  3956. if (isset($element['#markup']) && !empty($element['#id'])) {
  3957. $attributes['id'] = $element['#id'];
  3958. }
  3959. // Add element's #type and #name as class to aid with JS/CSS selectors.
  3960. $attributes['class'] = array('form-item');
  3961. if (!empty($element['#type'])) {
  3962. $attributes['class'][] = 'form-type-' . strtr($element['#type'], '_', '-');
  3963. }
  3964. if (!empty($element['#name'])) {
  3965. $attributes['class'][] = 'form-item-' . strtr($element['#name'], array(' ' => '-', '_' => '-', '[' => '-', ']' => ''));
  3966. }
  3967. // Add a class for disabled elements to facilitate cross-browser styling.
  3968. if (!empty($element['#attributes']['disabled'])) {
  3969. $attributes['class'][] = 'form-disabled';
  3970. }
  3971. $output = '<div' . drupal_attributes($attributes) . '>' . "\n";
  3972. // If #title is not set, we don't display any label or required marker.
  3973. if (!isset($element['#title'])) {
  3974. $element['#title_display'] = 'none';
  3975. }
  3976. $prefix = isset($element['#field_prefix']) ? '<span class="field-prefix">' . $element['#field_prefix'] . '</span> ' : '';
  3977. $suffix = isset($element['#field_suffix']) ? ' <span class="field-suffix">' . $element['#field_suffix'] . '</span>' : '';
  3978. switch ($element['#title_display']) {
  3979. case 'before':
  3980. case 'invisible':
  3981. $output .= ' ' . theme('form_element_label', $variables);
  3982. $output .= ' ' . $prefix . $element['#children'] . $suffix . "\n";
  3983. break;
  3984. case 'after':
  3985. $output .= ' ' . $prefix . $element['#children'] . $suffix;
  3986. $output .= ' ' . theme('form_element_label', $variables) . "\n";
  3987. break;
  3988. case 'none':
  3989. case 'attribute':
  3990. // Output no label and no required marker, only the children.
  3991. $output .= ' ' . $prefix . $element['#children'] . $suffix . "\n";
  3992. break;
  3993. }
  3994. if (!empty($element['#description'])) {
  3995. $output .= '<div class="description">' . $element['#description'] . "</div>\n";
  3996. }
  3997. $output .= "</div>\n";
  3998. return $output;
  3999. }
  4000. /**
  4001. * Returns HTML for a marker for required form elements.
  4002. *
  4003. * @param $variables
  4004. * An associative array containing:
  4005. * - element: An associative array containing the properties of the element.
  4006. *
  4007. * @ingroup themeable
  4008. */
  4009. function theme_form_required_marker($variables) {
  4010. // This is also used in the installer, pre-database setup.
  4011. $t = get_t();
  4012. $attributes = array(
  4013. 'class' => 'form-required',
  4014. 'title' => $t('This field is required.'),
  4015. );
  4016. return '<span' . drupal_attributes($attributes) . '>*</span>';
  4017. }
  4018. /**
  4019. * Returns HTML for a form element label and required marker.
  4020. *
  4021. * Form element labels include the #title and a #required marker. The label is
  4022. * associated with the element itself by the element #id. Labels may appear
  4023. * before or after elements, depending on theme_form_element() and
  4024. * #title_display.
  4025. *
  4026. * This function will not be called for elements with no labels, depending on
  4027. * #title_display. For elements that have an empty #title and are not required,
  4028. * this function will output no label (''). For required elements that have an
  4029. * empty #title, this will output the required marker alone within the label.
  4030. * The label will use the #id to associate the marker with the field that is
  4031. * required. That is especially important for screenreader users to know
  4032. * which field is required.
  4033. *
  4034. * @param $variables
  4035. * An associative array containing:
  4036. * - element: An associative array containing the properties of the element.
  4037. * Properties used: #required, #title, #id, #value, #description.
  4038. *
  4039. * @ingroup themeable
  4040. */
  4041. function theme_form_element_label($variables) {
  4042. $element = $variables['element'];
  4043. // This is also used in the installer, pre-database setup.
  4044. $t = get_t();
  4045. // If title and required marker are both empty, output no label.
  4046. if ((!isset($element['#title']) || $element['#title'] === '') && empty($element['#required'])) {
  4047. return '';
  4048. }
  4049. // If the element is required, a required marker is appended to the label.
  4050. $required = !empty($element['#required']) ? theme('form_required_marker', array('element' => $element)) : '';
  4051. $title = filter_xss_admin($element['#title']);
  4052. $attributes = array();
  4053. // Style the label as class option to display inline with the element.
  4054. if ($element['#title_display'] == 'after') {
  4055. $attributes['class'] = 'option';
  4056. }
  4057. // Show label only to screen readers to avoid disruption in visual flows.
  4058. elseif ($element['#title_display'] == 'invisible') {
  4059. $attributes['class'] = 'element-invisible';
  4060. }
  4061. if (!empty($element['#id'])) {
  4062. $attributes['for'] = $element['#id'];
  4063. }
  4064. // The leading whitespace helps visually separate fields from inline labels.
  4065. return ' <label' . drupal_attributes($attributes) . '>' . $t('!title !required', array('!title' => $title, '!required' => $required)) . "</label>\n";
  4066. }
  4067. /**
  4068. * Sets a form element's class attribute.
  4069. *
  4070. * Adds 'required' and 'error' classes as needed.
  4071. *
  4072. * @param $element
  4073. * The form element.
  4074. * @param $name
  4075. * Array of new class names to be added.
  4076. */
  4077. function _form_set_class(&$element, $class = array()) {
  4078. if (!empty($class)) {
  4079. if (!isset($element['#attributes']['class'])) {
  4080. $element['#attributes']['class'] = array();
  4081. }
  4082. $element['#attributes']['class'] = array_merge($element['#attributes']['class'], $class);
  4083. }
  4084. // This function is invoked from form element theme functions, but the
  4085. // rendered form element may not necessarily have been processed by
  4086. // form_builder().
  4087. if (!empty($element['#required'])) {
  4088. $element['#attributes']['class'][] = 'required';
  4089. }
  4090. if (isset($element['#parents']) && form_get_error($element) !== NULL && !empty($element['#validated'])) {
  4091. $element['#attributes']['class'][] = 'error';
  4092. }
  4093. }
  4094. /**
  4095. * Form element validation handler for integer elements.
  4096. */
  4097. function element_validate_integer($element, &$form_state) {
  4098. $value = $element['#value'];
  4099. if ($value !== '' && (!is_numeric($value) || intval($value) != $value)) {
  4100. form_error($element, t('%name must be an integer.', array('%name' => $element['#title'])));
  4101. }
  4102. }
  4103. /**
  4104. * Form element validation handler for integer elements that must be positive.
  4105. */
  4106. function element_validate_integer_positive($element, &$form_state) {
  4107. $value = $element['#value'];
  4108. if ($value !== '' && (!is_numeric($value) || intval($value) != $value || $value <= 0)) {
  4109. form_error($element, t('%name must be a positive integer.', array('%name' => $element['#title'])));
  4110. }
  4111. }
  4112. /**
  4113. * Form element validation handler for number elements.
  4114. */
  4115. function element_validate_number($element, &$form_state) {
  4116. $value = $element['#value'];
  4117. if ($value != '' && !is_numeric($value)) {
  4118. form_error($element, t('%name must be a number.', array('%name' => $element['#title'])));
  4119. }
  4120. }
  4121. /**
  4122. * @} End of "defgroup form_api".
  4123. */
  4124. /**
  4125. * @defgroup batch Batch operations
  4126. * @{
  4127. * Creates and processes batch operations.
  4128. *
  4129. * Functions allowing forms processing to be spread out over several page
  4130. * requests, thus ensuring that the processing does not get interrupted
  4131. * because of a PHP timeout, while allowing the user to receive feedback
  4132. * on the progress of the ongoing operations.
  4133. *
  4134. * The API is primarily designed to integrate nicely with the Form API
  4135. * workflow, but can also be used by non-Form API scripts (like update.php)
  4136. * or even simple page callbacks (which should probably be used sparingly).
  4137. *
  4138. * Example:
  4139. * @code
  4140. * $batch = array(
  4141. * 'title' => t('Exporting'),
  4142. * 'operations' => array(
  4143. * array('my_function_1', array($account->uid, 'story')),
  4144. * array('my_function_2', array()),
  4145. * ),
  4146. * 'finished' => 'my_finished_callback',
  4147. * 'file' => 'path_to_file_containing_myfunctions',
  4148. * );
  4149. * batch_set($batch);
  4150. * // Only needed if not inside a form _submit handler.
  4151. * // Setting redirect in batch_process.
  4152. * batch_process('node/1');
  4153. * @endcode
  4154. *
  4155. * Note: if the batch 'title', 'init_message', 'progress_message', or
  4156. * 'error_message' could contain any user input, it is the responsibility of
  4157. * the code calling batch_set() to sanitize them first with a function like
  4158. * check_plain() or filter_xss(). Furthermore, if the batch operation
  4159. * returns any user input in the 'results' or 'message' keys of $context,
  4160. * it must also sanitize them first.
  4161. *
  4162. * Sample callback_batch_operation():
  4163. * @code
  4164. * // Simple and artificial: load a node of a given type for a given user
  4165. * function my_function_1($uid, $type, &$context) {
  4166. * // The $context array gathers batch context information about the execution (read),
  4167. * // as well as 'return values' for the current operation (write)
  4168. * // The following keys are provided :
  4169. * // 'results' (read / write): The array of results gathered so far by
  4170. * // the batch processing, for the current operation to append its own.
  4171. * // 'message' (write): A text message displayed in the progress page.
  4172. * // The following keys allow for multi-step operations :
  4173. * // 'sandbox' (read / write): An array that can be freely used to
  4174. * // store persistent data between iterations. It is recommended to
  4175. * // use this instead of $_SESSION, which is unsafe if the user
  4176. * // continues browsing in a separate window while the batch is processing.
  4177. * // 'finished' (write): A float number between 0 and 1 informing
  4178. * // the processing engine of the completion level for the operation.
  4179. * // 1 (or no value explicitly set) means the operation is finished
  4180. * // and the batch processing can continue to the next operation.
  4181. *
  4182. * $node = node_load(array('uid' => $uid, 'type' => $type));
  4183. * $context['results'][] = $node->nid . ' : ' . check_plain($node->title);
  4184. * $context['message'] = check_plain($node->title);
  4185. * }
  4186. *
  4187. * // More advanced example: multi-step operation - load all nodes, five by five
  4188. * function my_function_2(&$context) {
  4189. * if (empty($context['sandbox'])) {
  4190. * $context['sandbox']['progress'] = 0;
  4191. * $context['sandbox']['current_node'] = 0;
  4192. * $context['sandbox']['max'] = db_query('SELECT COUNT(DISTINCT nid) FROM {node}')->fetchField();
  4193. * }
  4194. * $limit = 5;
  4195. * $result = db_select('node')
  4196. * ->fields('node', array('nid'))
  4197. * ->condition('nid', $context['sandbox']['current_node'], '>')
  4198. * ->orderBy('nid')
  4199. * ->range(0, $limit)
  4200. * ->execute();
  4201. * foreach ($result as $row) {
  4202. * $node = node_load($row->nid, NULL, TRUE);
  4203. * $context['results'][] = $node->nid . ' : ' . check_plain($node->title);
  4204. * $context['sandbox']['progress']++;
  4205. * $context['sandbox']['current_node'] = $node->nid;
  4206. * $context['message'] = check_plain($node->title);
  4207. * }
  4208. * if ($context['sandbox']['progress'] != $context['sandbox']['max']) {
  4209. * $context['finished'] = $context['sandbox']['progress'] / $context['sandbox']['max'];
  4210. * }
  4211. * }
  4212. * @endcode
  4213. *
  4214. * Sample callback_batch_finished():
  4215. * @code
  4216. * function my_finished_callback($success, $results, $operations) {
  4217. * // The 'success' parameter means no fatal PHP errors were detected. All
  4218. * // other error management should be handled using 'results'.
  4219. * if ($success) {
  4220. * $message = format_plural(count($results), 'One post processed.', '@count posts processed.');
  4221. * }
  4222. * else {
  4223. * $message = t('Finished with an error.');
  4224. * }
  4225. * drupal_set_message($message);
  4226. * // Providing data for the redirected page is done through $_SESSION.
  4227. * foreach ($results as $result) {
  4228. * $items[] = t('Loaded node %title.', array('%title' => $result));
  4229. * }
  4230. * $_SESSION['my_batch_results'] = $items;
  4231. * }
  4232. * @endcode
  4233. */
  4234. /**
  4235. * Adds a new batch.
  4236. *
  4237. * Batch operations are added as new batch sets. Batch sets are used to spread
  4238. * processing (primarily, but not exclusively, forms processing) over several
  4239. * page requests. This helps to ensure that the processing is not interrupted
  4240. * due to PHP timeouts, while users are still able to receive feedback on the
  4241. * progress of the ongoing operations. Combining related operations into
  4242. * distinct batch sets provides clean code independence for each batch set,
  4243. * ensuring that two or more batches, submitted independently, can be processed
  4244. * without mutual interference. Each batch set may specify its own set of
  4245. * operations and results, produce its own UI messages, and trigger its own
  4246. * 'finished' callback. Batch sets are processed sequentially, with the progress
  4247. * bar starting afresh for each new set.
  4248. *
  4249. * @param $batch_definition
  4250. * An associative array defining the batch, with the following elements (all
  4251. * are optional except as noted):
  4252. * - operations: (required) Array of operations to be performed, where each
  4253. * item is an array consisting of the name of an implementation of
  4254. * callback_batch_operation() and an array of parameter.
  4255. * Example:
  4256. * @code
  4257. * array(
  4258. * array('callback_batch_operation_1', array($arg1)),
  4259. * array('callback_batch_operation_2', array($arg2_1, $arg2_2)),
  4260. * )
  4261. * @endcode
  4262. * - title: A safe, translated string to use as the title for the progress
  4263. * page. Defaults to t('Processing').
  4264. * - init_message: Message displayed while the processing is initialized.
  4265. * Defaults to t('Initializing.').
  4266. * - progress_message: Message displayed while processing the batch. Available
  4267. * placeholders are @current, @remaining, @total, @percentage, @estimate and
  4268. * @elapsed. Defaults to t('Completed @current of @total.').
  4269. * - error_message: Message displayed if an error occurred while processing
  4270. * the batch. Defaults to t('An error has occurred.').
  4271. * - finished: Name of an implementation of callback_batch_finished(). This is
  4272. * executed after the batch has completed. This should be used to perform
  4273. * any result massaging that may be needed, and possibly save data in
  4274. * $_SESSION for display after final page redirection.
  4275. * - file: Path to the file containing the definitions of the 'operations' and
  4276. * 'finished' functions, for instance if they don't reside in the main
  4277. * .module file. The path should be relative to base_path(), and thus should
  4278. * be built using drupal_get_path().
  4279. * - css: Array of paths to CSS files to be used on the progress page.
  4280. * - url_options: options passed to url() when constructing redirect URLs for
  4281. * the batch.
  4282. */
  4283. function batch_set($batch_definition) {
  4284. if ($batch_definition) {
  4285. $batch =& batch_get();
  4286. // Initialize the batch if needed.
  4287. if (empty($batch)) {
  4288. $batch = array(
  4289. 'sets' => array(),
  4290. 'has_form_submits' => FALSE,
  4291. );
  4292. }
  4293. // Base and default properties for the batch set.
  4294. // Use get_t() to allow batches during installation.
  4295. $t = get_t();
  4296. $init = array(
  4297. 'sandbox' => array(),
  4298. 'results' => array(),
  4299. 'success' => FALSE,
  4300. 'start' => 0,
  4301. 'elapsed' => 0,
  4302. );
  4303. $defaults = array(
  4304. 'title' => $t('Processing'),
  4305. 'init_message' => $t('Initializing.'),
  4306. 'progress_message' => $t('Completed @current of @total.'),
  4307. 'error_message' => $t('An error has occurred.'),
  4308. 'css' => array(),
  4309. );
  4310. $batch_set = $init + $batch_definition + $defaults;
  4311. // Tweak init_message to avoid the bottom of the page flickering down after
  4312. // init phase.
  4313. $batch_set['init_message'] .= '<br/>&nbsp;';
  4314. // The non-concurrent workflow of batch execution allows us to save
  4315. // numberOfItems() queries by handling our own counter.
  4316. $batch_set['total'] = count($batch_set['operations']);
  4317. $batch_set['count'] = $batch_set['total'];
  4318. // Add the set to the batch.
  4319. if (empty($batch['id'])) {
  4320. // The batch is not running yet. Simply add the new set.
  4321. $batch['sets'][] = $batch_set;
  4322. }
  4323. else {
  4324. // The set is being added while the batch is running. Insert the new set
  4325. // right after the current one to ensure execution order, and store its
  4326. // operations in a queue.
  4327. $index = $batch['current_set'] + 1;
  4328. $slice1 = array_slice($batch['sets'], 0, $index);
  4329. $slice2 = array_slice($batch['sets'], $index);
  4330. $batch['sets'] = array_merge($slice1, array($batch_set), $slice2);
  4331. _batch_populate_queue($batch, $index);
  4332. }
  4333. }
  4334. }
  4335. /**
  4336. * Processes the batch.
  4337. *
  4338. * Unless the batch has been marked with 'progressive' = FALSE, the function
  4339. * issues a drupal_goto and thus ends page execution.
  4340. *
  4341. * This function is generally not needed in form submit handlers;
  4342. * Form API takes care of batches that were set during form submission.
  4343. *
  4344. * @param $redirect
  4345. * (optional) Path to redirect to when the batch has finished processing.
  4346. * @param $url
  4347. * (optional - should only be used for separate scripts like update.php)
  4348. * URL of the batch processing page.
  4349. * @param $redirect_callback
  4350. * (optional) Specify a function to be called to redirect to the progressive
  4351. * processing page. By default drupal_goto() will be used to redirect to a
  4352. * page which will do the progressive page. Specifying another function will
  4353. * allow the progressive processing to be processed differently.
  4354. */
  4355. function batch_process($redirect = NULL, $url = 'batch', $redirect_callback = 'drupal_goto') {
  4356. $batch =& batch_get();
  4357. drupal_theme_initialize();
  4358. if (isset($batch)) {
  4359. // Add process information
  4360. $process_info = array(
  4361. 'current_set' => 0,
  4362. 'progressive' => TRUE,
  4363. 'url' => $url,
  4364. 'url_options' => array(),
  4365. 'source_url' => $_GET['q'],
  4366. 'redirect' => $redirect,
  4367. 'theme' => $GLOBALS['theme_key'],
  4368. 'redirect_callback' => $redirect_callback,
  4369. );
  4370. $batch += $process_info;
  4371. // The batch is now completely built. Allow other modules to make changes
  4372. // to the batch so that it is easier to reuse batch processes in other
  4373. // environments.
  4374. drupal_alter('batch', $batch);
  4375. // Assign an arbitrary id: don't rely on a serial column in the 'batch'
  4376. // table, since non-progressive batches skip database storage completely.
  4377. $batch['id'] = db_next_id();
  4378. // Move operations to a job queue. Non-progressive batches will use a
  4379. // memory-based queue.
  4380. foreach ($batch['sets'] as $key => $batch_set) {
  4381. _batch_populate_queue($batch, $key);
  4382. }
  4383. // Initiate processing.
  4384. if ($batch['progressive']) {
  4385. // Now that we have a batch id, we can generate the redirection link in
  4386. // the generic error message.
  4387. $t = get_t();
  4388. $batch['error_message'] = $t('Please continue to <a href="@error_url">the error page</a>', array('@error_url' => url($url, array('query' => array('id' => $batch['id'], 'op' => 'finished')))));
  4389. // Clear the way for the drupal_goto() redirection to the batch processing
  4390. // page, by saving and unsetting the 'destination', if there is any.
  4391. if (isset($_GET['destination'])) {
  4392. $batch['destination'] = $_GET['destination'];
  4393. unset($_GET['destination']);
  4394. }
  4395. // Store the batch.
  4396. db_insert('batch')
  4397. ->fields(array(
  4398. 'bid' => $batch['id'],
  4399. 'timestamp' => REQUEST_TIME,
  4400. 'token' => drupal_get_token($batch['id']),
  4401. 'batch' => serialize($batch),
  4402. ))
  4403. ->execute();
  4404. // Set the batch number in the session to guarantee that it will stay alive.
  4405. $_SESSION['batches'][$batch['id']] = TRUE;
  4406. // Redirect for processing.
  4407. $function = $batch['redirect_callback'];
  4408. if (function_exists($function)) {
  4409. $function($batch['url'], array('query' => array('op' => 'start', 'id' => $batch['id'])));
  4410. }
  4411. }
  4412. else {
  4413. // Non-progressive execution: bypass the whole progressbar workflow
  4414. // and execute the batch in one pass.
  4415. require_once DRUPAL_ROOT . '/includes/batch.inc';
  4416. _batch_process();
  4417. }
  4418. }
  4419. }
  4420. /**
  4421. * Retrieves the current batch.
  4422. */
  4423. function &batch_get() {
  4424. // Not drupal_static(), because Batch API operates at a lower level than most
  4425. // use-cases for resetting static variables, and we specifically do not want a
  4426. // global drupal_static_reset() resetting the batch information. Functions
  4427. // that are part of the Batch API and need to reset the batch information may
  4428. // call batch_get() and manipulate the result by reference. Functions that are
  4429. // not part of the Batch API can also do this, but shouldn't.
  4430. static $batch = array();
  4431. return $batch;
  4432. }
  4433. /**
  4434. * Populates a job queue with the operations of a batch set.
  4435. *
  4436. * Depending on whether the batch is progressive or not, the BatchQueue or
  4437. * BatchMemoryQueue handler classes will be used.
  4438. *
  4439. * @param $batch
  4440. * The batch array.
  4441. * @param $set_id
  4442. * The id of the set to process.
  4443. *
  4444. * @return
  4445. * The name and class of the queue are added by reference to the batch set.
  4446. */
  4447. function _batch_populate_queue(&$batch, $set_id) {
  4448. $batch_set = &$batch['sets'][$set_id];
  4449. if (isset($batch_set['operations'])) {
  4450. $batch_set += array(
  4451. 'queue' => array(
  4452. 'name' => 'drupal_batch:' . $batch['id'] . ':' . $set_id,
  4453. 'class' => $batch['progressive'] ? 'BatchQueue' : 'BatchMemoryQueue',
  4454. ),
  4455. );
  4456. $queue = _batch_queue($batch_set);
  4457. $queue->createQueue();
  4458. foreach ($batch_set['operations'] as $operation) {
  4459. $queue->createItem($operation);
  4460. }
  4461. unset($batch_set['operations']);
  4462. }
  4463. }
  4464. /**
  4465. * Returns a queue object for a batch set.
  4466. *
  4467. * @param $batch_set
  4468. * The batch set.
  4469. *
  4470. * @return
  4471. * The queue object.
  4472. */
  4473. function _batch_queue($batch_set) {
  4474. static $queues;
  4475. // The class autoloader is not available when running update.php, so make
  4476. // sure the files are manually included.
  4477. if (!isset($queues)) {
  4478. $queues = array();
  4479. require_once DRUPAL_ROOT . '/modules/system/system.queue.inc';
  4480. require_once DRUPAL_ROOT . '/includes/batch.queue.inc';
  4481. }
  4482. if (isset($batch_set['queue'])) {
  4483. $name = $batch_set['queue']['name'];
  4484. $class = $batch_set['queue']['class'];
  4485. if (!isset($queues[$class][$name])) {
  4486. $queues[$class][$name] = new $class($name);
  4487. }
  4488. return $queues[$class][$name];
  4489. }
  4490. }
  4491. /**
  4492. * @} End of "defgroup batch".
  4493. */