form.inc 187 KB

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