Model.php 111 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764
  1. <?php
  2. /**
  3. * Object-relational mapper.
  4. *
  5. * DBO-backed object data model, for mapping database tables to CakePHP objects.
  6. *
  7. * CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
  8. * Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
  9. *
  10. * Licensed under The MIT License
  11. * For full copyright and license information, please see the LICENSE.txt
  12. * Redistributions of files must retain the above copyright notice.
  13. *
  14. * @copyright Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
  15. * @link http://cakephp.org CakePHP(tm) Project
  16. * @package Cake.Model
  17. * @since CakePHP(tm) v 0.10.0.0
  18. * @license http://www.opensource.org/licenses/mit-license.php MIT License
  19. */
  20. App::uses('ClassRegistry', 'Utility');
  21. App::uses('Validation', 'Utility');
  22. App::uses('String', 'Utility');
  23. App::uses('Hash', 'Utility');
  24. App::uses('BehaviorCollection', 'Model');
  25. App::uses('ModelBehavior', 'Model');
  26. App::uses('ModelValidator', 'Model');
  27. App::uses('ConnectionManager', 'Model');
  28. App::uses('Xml', 'Utility');
  29. App::uses('CakeEvent', 'Event');
  30. App::uses('CakeEventListener', 'Event');
  31. App::uses('CakeEventManager', 'Event');
  32. /**
  33. * Object-relational mapper.
  34. *
  35. * DBO-backed object data model.
  36. * Automatically selects a database table name based on a pluralized lowercase object class name
  37. * (i.e. class 'User' => table 'users'; class 'Man' => table 'men')
  38. * The table is required to have at least 'id auto_increment' primary key.
  39. *
  40. * @package Cake.Model
  41. * @link http://book.cakephp.org/2.0/en/models.html
  42. */
  43. class Model extends Object implements CakeEventListener {
  44. /**
  45. * The name of the DataSource connection that this Model uses
  46. *
  47. * The value must be an attribute name that you defined in `app/Config/database.php`
  48. * or created using `ConnectionManager::create()`.
  49. *
  50. * @var string
  51. * @link http://book.cakephp.org/2.0/en/models/model-attributes.html#usedbconfig
  52. */
  53. public $useDbConfig = 'default';
  54. /**
  55. * Custom database table name, or null/false if no table association is desired.
  56. *
  57. * @var string
  58. * @link http://book.cakephp.org/2.0/en/models/model-attributes.html#usetable
  59. */
  60. public $useTable = null;
  61. /**
  62. * Custom display field name. Display fields are used by Scaffold, in SELECT boxes' OPTION elements.
  63. *
  64. * This field is also used in `find('list')` when called with no extra parameters in the fields list
  65. *
  66. * @var string
  67. * @link http://book.cakephp.org/2.0/en/models/model-attributes.html#displayfield
  68. */
  69. public $displayField = null;
  70. /**
  71. * Value of the primary key ID of the record that this model is currently pointing to.
  72. * Automatically set after database insertions.
  73. *
  74. * @var mixed
  75. */
  76. public $id = false;
  77. /**
  78. * Container for the data that this model gets from persistent storage (usually, a database).
  79. *
  80. * @var array
  81. * @link http://book.cakephp.org/2.0/en/models/model-attributes.html#data
  82. */
  83. public $data = array();
  84. /**
  85. * Holds physical schema/database name for this model. Automatically set during Model creation.
  86. *
  87. * @var string
  88. */
  89. public $schemaName = null;
  90. /**
  91. * Table name for this Model.
  92. *
  93. * @var string
  94. */
  95. public $table = false;
  96. /**
  97. * The name of the primary key field for this model.
  98. *
  99. * @var string
  100. * @link http://book.cakephp.org/2.0/en/models/model-attributes.html#primarykey
  101. */
  102. public $primaryKey = null;
  103. /**
  104. * Field-by-field table metadata.
  105. *
  106. * @var array
  107. */
  108. protected $_schema = null;
  109. /**
  110. * List of validation rules. It must be an array with the field name as key and using
  111. * as value one of the following possibilities
  112. *
  113. * ### Validating using regular expressions
  114. *
  115. * {{{
  116. * public $validate = array(
  117. * 'name' => '/^[a-z].+$/i'
  118. * );
  119. * }}}
  120. *
  121. * ### Validating using methods (no parameters)
  122. *
  123. * {{{
  124. * public $validate = array(
  125. * 'name' => 'notEmpty'
  126. * );
  127. * }}}
  128. *
  129. * ### Validating using methods (with parameters)
  130. *
  131. * {{{
  132. * public $validate = array(
  133. * 'age' => array(
  134. * 'rule' => array('between', 5, 25)
  135. * )
  136. * );
  137. * }}}
  138. *
  139. * ### Validating using custom method
  140. *
  141. * {{{
  142. * public $validate = array(
  143. * 'password' => array(
  144. * 'rule' => array('customValidation')
  145. * )
  146. * );
  147. * public function customValidation($data) {
  148. * // $data will contain array('password' => 'value')
  149. * if (isset($this->data[$this->alias]['password2'])) {
  150. * return $this->data[$this->alias]['password2'] === current($data);
  151. * }
  152. * return true;
  153. * }
  154. * }}}
  155. *
  156. * ### Validations with messages
  157. *
  158. * The messages will be used in Model::$validationErrors and can be used in the FormHelper
  159. *
  160. * {{{
  161. * public $validate = array(
  162. * 'age' => array(
  163. * 'rule' => array('between', 5, 25),
  164. * 'message' => array('The age must be between %d and %d.')
  165. * )
  166. * );
  167. * }}}
  168. *
  169. * ### Multiple validations to the same field
  170. *
  171. * {{{
  172. * public $validate = array(
  173. * 'login' => array(
  174. * array(
  175. * 'rule' => 'alphaNumeric',
  176. * 'message' => 'Only alphabets and numbers allowed',
  177. * 'last' => true
  178. * ),
  179. * array(
  180. * 'rule' => array('minLength', 8),
  181. * 'message' => array('Minimum length of %d characters')
  182. * )
  183. * )
  184. * );
  185. * }}}
  186. *
  187. * ### Valid keys in validations
  188. *
  189. * - `rule`: String with method name, regular expression (started by slash) or array with method and parameters
  190. * - `message`: String with the message or array if have multiple parameters. See http://php.net/sprintf
  191. * - `last`: Boolean value to indicate if continue validating the others rules if the current fail [Default: true]
  192. * - `required`: Boolean value to indicate if the field must be present on save
  193. * - `allowEmpty`: Boolean value to indicate if the field can be empty
  194. * - `on`: Possible values: `update`, `create`. Indicate to apply this rule only on update or create
  195. *
  196. * @var array
  197. * @link http://book.cakephp.org/2.0/en/models/model-attributes.html#validate
  198. * @link http://book.cakephp.org/2.0/en/models/data-validation.html
  199. */
  200. public $validate = array();
  201. /**
  202. * List of validation errors.
  203. *
  204. * @var array
  205. */
  206. public $validationErrors = array();
  207. /**
  208. * Name of the validation string domain to use when translating validation errors.
  209. *
  210. * @var string
  211. */
  212. public $validationDomain = null;
  213. /**
  214. * Database table prefix for tables in model.
  215. *
  216. * @var string
  217. * @link http://book.cakephp.org/2.0/en/models/model-attributes.html#tableprefix
  218. */
  219. public $tablePrefix = null;
  220. /**
  221. * Plugin model belongs to.
  222. *
  223. * @var string
  224. */
  225. public $plugin = null;
  226. /**
  227. * Name of the model.
  228. *
  229. * @var string
  230. * @link http://book.cakephp.org/2.0/en/models/model-attributes.html#name
  231. */
  232. public $name = null;
  233. /**
  234. * Alias name for model.
  235. *
  236. * @var string
  237. */
  238. public $alias = null;
  239. /**
  240. * List of table names included in the model description. Used for associations.
  241. *
  242. * @var array
  243. */
  244. public $tableToModel = array();
  245. /**
  246. * Whether or not to cache queries for this model. This enables in-memory
  247. * caching only, the results are not stored beyond the current request.
  248. *
  249. * @var bool
  250. * @link http://book.cakephp.org/2.0/en/models/model-attributes.html#cachequeries
  251. */
  252. public $cacheQueries = false;
  253. /**
  254. * Detailed list of belongsTo associations.
  255. *
  256. * ### Basic usage
  257. *
  258. * `public $belongsTo = array('Group', 'Department');`
  259. *
  260. * ### Detailed configuration
  261. *
  262. * {{{
  263. * public $belongsTo = array(
  264. * 'Group',
  265. * 'Department' => array(
  266. * 'className' => 'Department',
  267. * 'foreignKey' => 'department_id'
  268. * )
  269. * );
  270. * }}}
  271. *
  272. * ### Possible keys in association
  273. *
  274. * - `className`: the class name of the model being associated to the current model.
  275. * If you're defining a 'Profile belongsTo User' relationship, the className key should equal 'User.'
  276. * - `foreignKey`: the name of the foreign key found in the current model. This is
  277. * especially handy if you need to define multiple belongsTo relationships. The default
  278. * value for this key is the underscored, singular name of the other model, suffixed with '_id'.
  279. * - `conditions`: An SQL fragment used to filter related model records. It's good
  280. * practice to use model names in SQL fragments: 'User.active = 1' is always
  281. * better than just 'active = 1.'
  282. * - `type`: the type of the join to use in the SQL query, default is LEFT which
  283. * may not fit your needs in all situations, INNER may be helpful when you want
  284. * everything from your main and associated models or nothing at all!(effective
  285. * when used with some conditions of course). (NB: type value is in lower case - i.e. left, inner)
  286. * - `fields`: A list of fields to be retrieved when the associated model data is
  287. * fetched. Returns all fields by default.
  288. * - `order`: An SQL fragment that defines the sorting order for the returned associated rows.
  289. * - `counterCache`: If set to true the associated Model will automatically increase or
  290. * decrease the "[singular_model_name]_count" field in the foreign table whenever you do
  291. * a save() or delete(). If its a string then its the field name to use. The value in the
  292. * counter field represents the number of related rows.
  293. * - `counterScope`: Optional conditions array to use for updating counter cache field.
  294. *
  295. * @var array
  296. * @link http://book.cakephp.org/2.0/en/models/associations-linking-models-together.html#belongsto
  297. */
  298. public $belongsTo = array();
  299. /**
  300. * Detailed list of hasOne associations.
  301. *
  302. * ### Basic usage
  303. *
  304. * `public $hasOne = array('Profile', 'Address');`
  305. *
  306. * ### Detailed configuration
  307. *
  308. * {{{
  309. * public $hasOne = array(
  310. * 'Profile',
  311. * 'Address' => array(
  312. * 'className' => 'Address',
  313. * 'foreignKey' => 'user_id'
  314. * )
  315. * );
  316. * }}}
  317. *
  318. * ### Possible keys in association
  319. *
  320. * - `className`: the class name of the model being associated to the current model.
  321. * If you're defining a 'User hasOne Profile' relationship, the className key should equal 'Profile.'
  322. * - `foreignKey`: the name of the foreign key found in the other model. This is
  323. * especially handy if you need to define multiple hasOne relationships.
  324. * The default value for this key is the underscored, singular name of the
  325. * current model, suffixed with '_id'. In the example above it would default to 'user_id'.
  326. * - `conditions`: An SQL fragment used to filter related model records. It's good
  327. * practice to use model names in SQL fragments: "Profile.approved = 1" is
  328. * always better than just "approved = 1."
  329. * - `fields`: A list of fields to be retrieved when the associated model data is
  330. * fetched. Returns all fields by default.
  331. * - `order`: An SQL fragment that defines the sorting order for the returned associated rows.
  332. * - `dependent`: When the dependent key is set to true, and the model's delete()
  333. * method is called with the cascade parameter set to true, associated model
  334. * records are also deleted. In this case we set it true so that deleting a
  335. * User will also delete her associated Profile.
  336. *
  337. * @var array
  338. * @link http://book.cakephp.org/2.0/en/models/associations-linking-models-together.html#hasone
  339. */
  340. public $hasOne = array();
  341. /**
  342. * Detailed list of hasMany associations.
  343. *
  344. * ### Basic usage
  345. *
  346. * `public $hasMany = array('Comment', 'Task');`
  347. *
  348. * ### Detailed configuration
  349. *
  350. * {{{
  351. * public $hasMany = array(
  352. * 'Comment',
  353. * 'Task' => array(
  354. * 'className' => 'Task',
  355. * 'foreignKey' => 'user_id'
  356. * )
  357. * );
  358. * }}}
  359. *
  360. * ### Possible keys in association
  361. *
  362. * - `className`: the class name of the model being associated to the current model.
  363. * If you're defining a 'User hasMany Comment' relationship, the className key should equal 'Comment.'
  364. * - `foreignKey`: the name of the foreign key found in the other model. This is
  365. * especially handy if you need to define multiple hasMany relationships. The default
  366. * value for this key is the underscored, singular name of the actual model, suffixed with '_id'.
  367. * - `conditions`: An SQL fragment used to filter related model records. It's good
  368. * practice to use model names in SQL fragments: "Comment.status = 1" is always
  369. * better than just "status = 1."
  370. * - `fields`: A list of fields to be retrieved when the associated model data is
  371. * fetched. Returns all fields by default.
  372. * - `order`: An SQL fragment that defines the sorting order for the returned associated rows.
  373. * - `limit`: The maximum number of associated rows you want returned.
  374. * - `offset`: The number of associated rows to skip over (given the current
  375. * conditions and order) before fetching and associating.
  376. * - `dependent`: When dependent is set to true, recursive model deletion is
  377. * possible. In this example, Comment records will be deleted when their
  378. * associated User record has been deleted.
  379. * - `exclusive`: When exclusive is set to true, recursive model deletion does
  380. * the delete with a deleteAll() call, instead of deleting each entity separately.
  381. * This greatly improves performance, but may not be ideal for all circumstances.
  382. * - `finderQuery`: A complete SQL query CakePHP can use to fetch associated model
  383. * records. This should be used in situations that require very custom results.
  384. *
  385. * @var array
  386. * @link http://book.cakephp.org/2.0/en/models/associations-linking-models-together.html#hasmany
  387. */
  388. public $hasMany = array();
  389. /**
  390. * Detailed list of hasAndBelongsToMany associations.
  391. *
  392. * ### Basic usage
  393. *
  394. * `public $hasAndBelongsToMany = array('Role', 'Address');`
  395. *
  396. * ### Detailed configuration
  397. *
  398. * {{{
  399. * public $hasAndBelongsToMany = array(
  400. * 'Role',
  401. * 'Address' => array(
  402. * 'className' => 'Address',
  403. * 'foreignKey' => 'user_id',
  404. * 'associationForeignKey' => 'address_id',
  405. * 'joinTable' => 'addresses_users'
  406. * )
  407. * );
  408. * }}}
  409. *
  410. * ### Possible keys in association
  411. *
  412. * - `className`: the class name of the model being associated to the current model.
  413. * If you're defining a 'Recipe HABTM Tag' relationship, the className key should equal 'Tag.'
  414. * - `joinTable`: The name of the join table used in this association (if the
  415. * current table doesn't adhere to the naming convention for HABTM join tables).
  416. * - `with`: Defines the name of the model for the join table. By default CakePHP
  417. * will auto-create a model for you. Using the example above it would be called
  418. * RecipesTag. By using this key you can override this default name. The join
  419. * table model can be used just like any "regular" model to access the join table directly.
  420. * - `foreignKey`: the name of the foreign key found in the current model.
  421. * This is especially handy if you need to define multiple HABTM relationships.
  422. * The default value for this key is the underscored, singular name of the
  423. * current model, suffixed with '_id'.
  424. * - `associationForeignKey`: the name of the foreign key found in the other model.
  425. * This is especially handy if you need to define multiple HABTM relationships.
  426. * The default value for this key is the underscored, singular name of the other
  427. * model, suffixed with '_id'.
  428. * - `unique`: If true (default value) cake will first delete existing relationship
  429. * records in the foreign keys table before inserting new ones, when updating a
  430. * record. So existing associations need to be passed again when updating.
  431. * To prevent deletion of existing relationship records, set this key to a string 'keepExisting'.
  432. * - `conditions`: An SQL fragment used to filter related model records. It's good
  433. * practice to use model names in SQL fragments: "Comment.status = 1" is always
  434. * better than just "status = 1."
  435. * - `fields`: A list of fields to be retrieved when the associated model data is
  436. * fetched. Returns all fields by default.
  437. * - `order`: An SQL fragment that defines the sorting order for the returned associated rows.
  438. * - `limit`: The maximum number of associated rows you want returned.
  439. * - `offset`: The number of associated rows to skip over (given the current
  440. * conditions and order) before fetching and associating.
  441. * - `finderQuery`, A complete SQL query CakePHP
  442. * can use to fetch associated model records. This should
  443. * be used in situations that require very custom results.
  444. *
  445. * @var array
  446. * @link http://book.cakephp.org/2.0/en/models/associations-linking-models-together.html#hasandbelongstomany-habtm
  447. */
  448. public $hasAndBelongsToMany = array();
  449. /**
  450. * List of behaviors to load when the model object is initialized. Settings can be
  451. * passed to behaviors by using the behavior name as index. Eg:
  452. *
  453. * public $actsAs = array('Translate', 'MyBehavior' => array('setting1' => 'value1'))
  454. *
  455. * @var array
  456. * @link http://book.cakephp.org/2.0/en/models/behaviors.html#using-behaviors
  457. */
  458. public $actsAs = null;
  459. /**
  460. * Holds the Behavior objects currently bound to this model.
  461. *
  462. * @var BehaviorCollection
  463. */
  464. public $Behaviors = null;
  465. /**
  466. * Whitelist of fields allowed to be saved.
  467. *
  468. * @var array
  469. */
  470. public $whitelist = array();
  471. /**
  472. * Whether or not to cache sources for this model.
  473. *
  474. * @var bool
  475. */
  476. public $cacheSources = true;
  477. /**
  478. * Type of find query currently executing.
  479. *
  480. * @var string
  481. */
  482. public $findQueryType = null;
  483. /**
  484. * Number of associations to recurse through during find calls. Fetches only
  485. * the first level by default.
  486. *
  487. * @var int
  488. * @link http://book.cakephp.org/2.0/en/models/model-attributes.html#recursive
  489. */
  490. public $recursive = 1;
  491. /**
  492. * The column name(s) and direction(s) to order find results by default.
  493. *
  494. * public $order = "Post.created DESC";
  495. * public $order = array("Post.view_count DESC", "Post.rating DESC");
  496. *
  497. * @var string
  498. * @link http://book.cakephp.org/2.0/en/models/model-attributes.html#order
  499. */
  500. public $order = null;
  501. /**
  502. * Array of virtual fields this model has. Virtual fields are aliased
  503. * SQL expressions. Fields added to this property will be read as other fields in a model
  504. * but will not be saveable.
  505. *
  506. * `public $virtualFields = array('two' => '1 + 1');`
  507. *
  508. * Is a simplistic example of how to set virtualFields
  509. *
  510. * @var array
  511. * @link http://book.cakephp.org/2.0/en/models/model-attributes.html#virtualfields
  512. */
  513. public $virtualFields = array();
  514. /**
  515. * Default list of association keys.
  516. *
  517. * @var array
  518. */
  519. protected $_associationKeys = array(
  520. 'belongsTo' => array('className', 'foreignKey', 'conditions', 'fields', 'order', 'counterCache'),
  521. 'hasOne' => array('className', 'foreignKey', 'conditions', 'fields', 'order', 'dependent'),
  522. 'hasMany' => array('className', 'foreignKey', 'conditions', 'fields', 'order', 'limit', 'offset', 'dependent', 'exclusive', 'finderQuery', 'counterQuery'),
  523. 'hasAndBelongsToMany' => array('className', 'joinTable', 'with', 'foreignKey', 'associationForeignKey', 'conditions', 'fields', 'order', 'limit', 'offset', 'unique', 'finderQuery')
  524. );
  525. /**
  526. * Holds provided/generated association key names and other data for all associations.
  527. *
  528. * @var array
  529. */
  530. protected $_associations = array('belongsTo', 'hasOne', 'hasMany', 'hasAndBelongsToMany');
  531. // @codingStandardsIgnoreStart
  532. /**
  533. * Holds model associations temporarily to allow for dynamic (un)binding.
  534. *
  535. * @var array
  536. */
  537. public $__backAssociation = array();
  538. /**
  539. * Back inner association
  540. *
  541. * @var array
  542. */
  543. public $__backInnerAssociation = array();
  544. /**
  545. * Back original association
  546. *
  547. * @var array
  548. */
  549. public $__backOriginalAssociation = array();
  550. /**
  551. * Back containable association
  552. *
  553. * @var array
  554. */
  555. public $__backContainableAssociation = array();
  556. /**
  557. * Safe update mode
  558. * If true, this prevents Model::save() from generating a query with WHERE 1 = 1 on race condition.
  559. *
  560. * @var bool
  561. */
  562. public $__safeUpdateMode = false;
  563. // @codingStandardsIgnoreEnd
  564. /**
  565. * The ID of the model record that was last inserted.
  566. *
  567. * @var int
  568. */
  569. protected $_insertID = null;
  570. /**
  571. * Has the datasource been configured.
  572. *
  573. * @var bool
  574. * @see Model::getDataSource
  575. */
  576. protected $_sourceConfigured = false;
  577. /**
  578. * List of valid finder method options, supplied as the first parameter to find().
  579. *
  580. * @var array
  581. */
  582. public $findMethods = array(
  583. 'all' => true, 'first' => true, 'count' => true,
  584. 'neighbors' => true, 'list' => true, 'threaded' => true
  585. );
  586. /**
  587. * Instance of the CakeEventManager this model is using
  588. * to dispatch inner events.
  589. *
  590. * @var CakeEventManager
  591. */
  592. protected $_eventManager = null;
  593. /**
  594. * Instance of the ModelValidator
  595. *
  596. * @var ModelValidator
  597. */
  598. protected $_validator = null;
  599. /**
  600. * Constructor. Binds the model's database table to the object.
  601. *
  602. * If `$id` is an array it can be used to pass several options into the model.
  603. *
  604. * - `id`: The id to start the model on.
  605. * - `table`: The table to use for this model.
  606. * - `ds`: The connection name this model is connected to.
  607. * - `name`: The name of the model eg. Post.
  608. * - `alias`: The alias of the model, this is used for registering the instance in the `ClassRegistry`.
  609. * eg. `ParentThread`
  610. *
  611. * ### Overriding Model's __construct method.
  612. *
  613. * When overriding Model::__construct() be careful to include and pass in all 3 of the
  614. * arguments to `parent::__construct($id, $table, $ds);`
  615. *
  616. * ### Dynamically creating models
  617. *
  618. * You can dynamically create model instances using the $id array syntax.
  619. *
  620. * {{{
  621. * $Post = new Model(array('table' => 'posts', 'name' => 'Post', 'ds' => 'connection2'));
  622. * }}}
  623. *
  624. * Would create a model attached to the posts table on connection2. Dynamic model creation is useful
  625. * when you want a model object that contains no associations or attached behaviors.
  626. *
  627. * @param bool|int|string|array $id Set this ID for this model on startup,
  628. * can also be an array of options, see above.
  629. * @param string $table Name of database table to use.
  630. * @param string $ds DataSource connection name.
  631. */
  632. public function __construct($id = false, $table = null, $ds = null) {
  633. parent::__construct();
  634. if (is_array($id)) {
  635. extract(array_merge(
  636. array(
  637. 'id' => $this->id, 'table' => $this->useTable, 'ds' => $this->useDbConfig,
  638. 'name' => $this->name, 'alias' => $this->alias, 'plugin' => $this->plugin
  639. ),
  640. $id
  641. ));
  642. }
  643. if ($this->plugin === null) {
  644. $this->plugin = (isset($plugin) ? $plugin : $this->plugin);
  645. }
  646. if ($this->name === null) {
  647. $this->name = (isset($name) ? $name : get_class($this));
  648. }
  649. if ($this->alias === null) {
  650. $this->alias = (isset($alias) ? $alias : $this->name);
  651. }
  652. if ($this->primaryKey === null) {
  653. $this->primaryKey = 'id';
  654. }
  655. ClassRegistry::addObject($this->alias, $this);
  656. $this->id = $id;
  657. unset($id);
  658. if ($table === false) {
  659. $this->useTable = false;
  660. } elseif ($table) {
  661. $this->useTable = $table;
  662. }
  663. if ($ds !== null) {
  664. $this->useDbConfig = $ds;
  665. }
  666. if (is_subclass_of($this, 'AppModel')) {
  667. $merge = array('actsAs', 'findMethods');
  668. $parentClass = get_parent_class($this);
  669. if ($parentClass !== 'AppModel') {
  670. $this->_mergeVars($merge, $parentClass);
  671. }
  672. $this->_mergeVars($merge, 'AppModel');
  673. }
  674. $this->_mergeVars(array('findMethods'), 'Model');
  675. $this->Behaviors = new BehaviorCollection();
  676. if ($this->useTable !== false) {
  677. if ($this->useTable === null) {
  678. $this->useTable = Inflector::tableize($this->name);
  679. }
  680. if (!$this->displayField) {
  681. unset($this->displayField);
  682. }
  683. $this->table = $this->useTable;
  684. $this->tableToModel[$this->table] = $this->alias;
  685. } elseif ($this->table === false) {
  686. $this->table = Inflector::tableize($this->name);
  687. }
  688. if ($this->tablePrefix === null) {
  689. unset($this->tablePrefix);
  690. }
  691. $this->_createLinks();
  692. $this->Behaviors->init($this->alias, $this->actsAs);
  693. }
  694. /**
  695. * Returns a list of all events that will fire in the model during it's lifecycle.
  696. * You can override this function to add you own listener callbacks
  697. *
  698. * @return array
  699. */
  700. public function implementedEvents() {
  701. return array(
  702. 'Model.beforeFind' => array('callable' => 'beforeFind', 'passParams' => true),
  703. 'Model.afterFind' => array('callable' => 'afterFind', 'passParams' => true),
  704. 'Model.beforeValidate' => array('callable' => 'beforeValidate', 'passParams' => true),
  705. 'Model.afterValidate' => array('callable' => 'afterValidate'),
  706. 'Model.beforeSave' => array('callable' => 'beforeSave', 'passParams' => true),
  707. 'Model.afterSave' => array('callable' => 'afterSave', 'passParams' => true),
  708. 'Model.beforeDelete' => array('callable' => 'beforeDelete', 'passParams' => true),
  709. 'Model.afterDelete' => array('callable' => 'afterDelete'),
  710. );
  711. }
  712. /**
  713. * Returns the CakeEventManager manager instance that is handling any callbacks.
  714. * You can use this instance to register any new listeners or callbacks to the
  715. * model events, or create your own events and trigger them at will.
  716. *
  717. * @return CakeEventManager
  718. */
  719. public function getEventManager() {
  720. if (empty($this->_eventManager)) {
  721. $this->_eventManager = new CakeEventManager();
  722. $this->_eventManager->attach($this->Behaviors);
  723. $this->_eventManager->attach($this);
  724. }
  725. return $this->_eventManager;
  726. }
  727. /**
  728. * Handles custom method calls, like findBy<field> for DB models,
  729. * and custom RPC calls for remote data sources.
  730. *
  731. * @param string $method Name of method to call.
  732. * @param array $params Parameters for the method.
  733. * @return mixed Whatever is returned by called method
  734. */
  735. public function __call($method, $params) {
  736. $result = $this->Behaviors->dispatchMethod($this, $method, $params);
  737. if ($result !== array('unhandled')) {
  738. return $result;
  739. }
  740. return $this->getDataSource()->query($method, $params, $this);
  741. }
  742. /**
  743. * Handles the lazy loading of model associations by looking in the association arrays for the requested variable
  744. *
  745. * @param string $name variable tested for existence in class
  746. * @return bool true if the variable exists (if is a not loaded model association it will be created), false otherwise
  747. */
  748. public function __isset($name) {
  749. $className = false;
  750. foreach ($this->_associations as $type) {
  751. if (isset($name, $this->{$type}[$name])) {
  752. $className = empty($this->{$type}[$name]['className']) ? $name : $this->{$type}[$name]['className'];
  753. break;
  754. } elseif (isset($name, $this->__backAssociation[$type][$name])) {
  755. $className = empty($this->__backAssociation[$type][$name]['className']) ?
  756. $name : $this->__backAssociation[$type][$name]['className'];
  757. break;
  758. } elseif ($type === 'hasAndBelongsToMany') {
  759. foreach ($this->{$type} as $k => $relation) {
  760. if (empty($relation['with'])) {
  761. continue;
  762. }
  763. if (is_array($relation['with'])) {
  764. if (key($relation['with']) === $name) {
  765. $className = $name;
  766. }
  767. } else {
  768. list($plugin, $class) = pluginSplit($relation['with']);
  769. if ($class === $name) {
  770. $className = $relation['with'];
  771. }
  772. }
  773. if ($className) {
  774. $assocKey = $k;
  775. $dynamic = !empty($relation['dynamicWith']);
  776. break(2);
  777. }
  778. }
  779. }
  780. }
  781. if (!$className) {
  782. return false;
  783. }
  784. list($plugin, $className) = pluginSplit($className);
  785. if (!ClassRegistry::isKeySet($className) && !empty($dynamic)) {
  786. $this->{$className} = new AppModel(array(
  787. 'name' => $className,
  788. 'table' => $this->hasAndBelongsToMany[$assocKey]['joinTable'],
  789. 'ds' => $this->useDbConfig
  790. ));
  791. } else {
  792. $this->_constructLinkedModel($name, $className, $plugin);
  793. }
  794. if (!empty($assocKey)) {
  795. $this->hasAndBelongsToMany[$assocKey]['joinTable'] = $this->{$name}->table;
  796. if (count($this->{$name}->schema()) <= 2 && $this->{$name}->primaryKey !== false) {
  797. $this->{$name}->primaryKey = $this->hasAndBelongsToMany[$assocKey]['foreignKey'];
  798. }
  799. }
  800. return true;
  801. }
  802. /**
  803. * Returns the value of the requested variable if it can be set by __isset()
  804. *
  805. * @param string $name variable requested for it's value or reference
  806. * @return mixed value of requested variable if it is set
  807. */
  808. public function __get($name) {
  809. if ($name === 'displayField') {
  810. return $this->displayField = $this->hasField(array('title', 'name', $this->primaryKey));
  811. }
  812. if ($name === 'tablePrefix') {
  813. $this->setDataSource();
  814. if (property_exists($this, 'tablePrefix') && !empty($this->tablePrefix)) {
  815. return $this->tablePrefix;
  816. }
  817. return $this->tablePrefix = null;
  818. }
  819. if (isset($this->{$name})) {
  820. return $this->{$name};
  821. }
  822. }
  823. /**
  824. * Bind model associations on the fly.
  825. *
  826. * If `$reset` is false, association will not be reset
  827. * to the originals defined in the model
  828. *
  829. * Example: Add a new hasOne binding to the Profile model not
  830. * defined in the model source code:
  831. *
  832. * `$this->User->bindModel(array('hasOne' => array('Profile')));`
  833. *
  834. * Bindings that are not made permanent will be reset by the next Model::find() call on this
  835. * model.
  836. *
  837. * @param array $params Set of bindings (indexed by binding type)
  838. * @param bool $reset Set to false to make the binding permanent
  839. * @return bool Success
  840. * @link http://book.cakephp.org/2.0/en/models/associations-linking-models-together.html#creating-and-destroying-associations-on-the-fly
  841. */
  842. public function bindModel($params, $reset = true) {
  843. foreach ($params as $assoc => $model) {
  844. if ($reset === true && !isset($this->__backAssociation[$assoc])) {
  845. $this->__backAssociation[$assoc] = $this->{$assoc};
  846. }
  847. foreach ($model as $key => $value) {
  848. $assocName = $key;
  849. if (is_numeric($key)) {
  850. $assocName = $value;
  851. $value = array();
  852. }
  853. $this->{$assoc}[$assocName] = $value;
  854. if (property_exists($this, $assocName)) {
  855. unset($this->{$assocName});
  856. }
  857. if ($reset === false && isset($this->__backAssociation[$assoc])) {
  858. $this->__backAssociation[$assoc][$assocName] = $value;
  859. }
  860. }
  861. }
  862. $this->_createLinks();
  863. return true;
  864. }
  865. /**
  866. * Turn off associations on the fly.
  867. *
  868. * If $reset is false, association will not be reset
  869. * to the originals defined in the model
  870. *
  871. * Example: Turn off the associated Model Support request,
  872. * to temporarily lighten the User model:
  873. *
  874. * `$this->User->unbindModel(array('hasMany' => array('SupportRequest')));`
  875. * Or alternatively:
  876. * `$this->User->unbindModel(array('hasMany' => 'SupportRequest'));`
  877. *
  878. * Unbound models that are not made permanent will reset with the next call to Model::find()
  879. *
  880. * @param array $params Set of bindings to unbind (indexed by binding type)
  881. * @param bool $reset Set to false to make the unbinding permanent
  882. * @return bool Success
  883. * @link http://book.cakephp.org/2.0/en/models/associations-linking-models-together.html#creating-and-destroying-associations-on-the-fly
  884. */
  885. public function unbindModel($params, $reset = true) {
  886. foreach ($params as $assoc => $models) {
  887. if ($reset === true && !isset($this->__backAssociation[$assoc])) {
  888. $this->__backAssociation[$assoc] = $this->{$assoc};
  889. }
  890. $models = Hash::normalize((array)$models, false);
  891. foreach ($models as $model) {
  892. if ($reset === false && isset($this->__backAssociation[$assoc][$model])) {
  893. unset($this->__backAssociation[$assoc][$model]);
  894. }
  895. unset($this->{$assoc}[$model]);
  896. }
  897. }
  898. return true;
  899. }
  900. /**
  901. * Create a set of associations.
  902. *
  903. * @return void
  904. */
  905. protected function _createLinks() {
  906. foreach ($this->_associations as $type) {
  907. $association =& $this->{$type};
  908. if (!is_array($association)) {
  909. $association = explode(',', $association);
  910. foreach ($association as $i => $className) {
  911. $className = trim($className);
  912. unset ($association[$i]);
  913. $association[$className] = array();
  914. }
  915. }
  916. if (!empty($association)) {
  917. foreach ($association as $assoc => $value) {
  918. $plugin = null;
  919. if (is_numeric($assoc)) {
  920. unset($association[$assoc]);
  921. $assoc = $value;
  922. $value = array();
  923. if (strpos($assoc, '.') !== false) {
  924. list($plugin, $assoc) = pluginSplit($assoc, true);
  925. $association[$assoc] = array('className' => $plugin . $assoc);
  926. } else {
  927. $association[$assoc] = $value;
  928. }
  929. }
  930. $this->_generateAssociation($type, $assoc);
  931. }
  932. }
  933. }
  934. }
  935. /**
  936. * Protected helper method to create associated models of a given class.
  937. *
  938. * @param string $assoc Association name
  939. * @param string $className Class name
  940. * @param string $plugin name of the plugin where $className is located
  941. * examples: public $hasMany = array('Assoc' => array('className' => 'ModelName'));
  942. * usage: $this->Assoc->modelMethods();
  943. *
  944. * public $hasMany = array('ModelName');
  945. * usage: $this->ModelName->modelMethods();
  946. * @return void
  947. */
  948. protected function _constructLinkedModel($assoc, $className = null, $plugin = null) {
  949. if (empty($className)) {
  950. $className = $assoc;
  951. }
  952. if (!isset($this->{$assoc}) || $this->{$assoc}->name !== $className) {
  953. if ($plugin) {
  954. $plugin .= '.';
  955. }
  956. $model = array('class' => $plugin . $className, 'alias' => $assoc);
  957. $this->{$assoc} = ClassRegistry::init($model);
  958. if ($plugin) {
  959. ClassRegistry::addObject($plugin . $className, $this->{$assoc});
  960. }
  961. if ($assoc) {
  962. $this->tableToModel[$this->{$assoc}->table] = $assoc;
  963. }
  964. }
  965. }
  966. /**
  967. * Build an array-based association from string.
  968. *
  969. * @param string $type 'belongsTo', 'hasOne', 'hasMany', 'hasAndBelongsToMany'
  970. * @param string $assocKey Association key.
  971. * @return void
  972. */
  973. protected function _generateAssociation($type, $assocKey) {
  974. $class = $assocKey;
  975. $dynamicWith = false;
  976. $assoc =& $this->{$type}[$assocKey];
  977. foreach ($this->_associationKeys[$type] as $key) {
  978. if (!isset($assoc[$key]) || $assoc[$key] === null) {
  979. $data = '';
  980. switch ($key) {
  981. case 'fields':
  982. $data = '';
  983. break;
  984. case 'foreignKey':
  985. $data = (($type === 'belongsTo') ? Inflector::underscore($assocKey) : Inflector::singularize($this->table)) . '_id';
  986. break;
  987. case 'associationForeignKey':
  988. $data = Inflector::singularize($this->{$class}->table) . '_id';
  989. break;
  990. case 'with':
  991. $data = Inflector::camelize(Inflector::singularize($assoc['joinTable']));
  992. $dynamicWith = true;
  993. break;
  994. case 'joinTable':
  995. $tables = array($this->table, $this->{$class}->table);
  996. sort($tables);
  997. $data = $tables[0] . '_' . $tables[1];
  998. break;
  999. case 'className':
  1000. $data = $class;
  1001. break;
  1002. case 'unique':
  1003. $data = true;
  1004. break;
  1005. }
  1006. $assoc[$key] = $data;
  1007. }
  1008. if ($dynamicWith) {
  1009. $assoc['dynamicWith'] = true;
  1010. }
  1011. }
  1012. }
  1013. /**
  1014. * Sets a custom table for your model class. Used by your controller to select a database table.
  1015. *
  1016. * @param string $tableName Name of the custom table
  1017. * @throws MissingTableException when database table $tableName is not found on data source
  1018. * @return void
  1019. */
  1020. public function setSource($tableName) {
  1021. $this->setDataSource($this->useDbConfig);
  1022. $db = ConnectionManager::getDataSource($this->useDbConfig);
  1023. if (method_exists($db, 'listSources')) {
  1024. $restore = $db->cacheSources;
  1025. $db->cacheSources = ($restore && $this->cacheSources);
  1026. $sources = $db->listSources();
  1027. $db->cacheSources = $restore;
  1028. if (is_array($sources) && !in_array(strtolower($this->tablePrefix . $tableName), array_map('strtolower', $sources))) {
  1029. throw new MissingTableException(array(
  1030. 'table' => $this->tablePrefix . $tableName,
  1031. 'class' => $this->alias,
  1032. 'ds' => $this->useDbConfig,
  1033. ));
  1034. }
  1035. if ($sources) {
  1036. $this->_schema = null;
  1037. }
  1038. }
  1039. $this->table = $this->useTable = $tableName;
  1040. $this->tableToModel[$this->table] = $this->alias;
  1041. }
  1042. /**
  1043. * This function does two things:
  1044. *
  1045. * 1. it scans the array $one for the primary key,
  1046. * and if that's found, it sets the current id to the value of $one[id].
  1047. * For all other keys than 'id' the keys and values of $one are copied to the 'data' property of this object.
  1048. * 2. Returns an array with all of $one's keys and values.
  1049. * (Alternative indata: two strings, which are mangled to
  1050. * a one-item, two-dimensional array using $one for a key and $two as its value.)
  1051. *
  1052. * @param string|array|SimpleXmlElement|DomNode $one Array or string of data
  1053. * @param string $two Value string for the alternative indata method
  1054. * @return array Data with all of $one's keys and values
  1055. * @link http://book.cakephp.org/2.0/en/models/saving-your-data.html
  1056. */
  1057. public function set($one, $two = null) {
  1058. if (!$one) {
  1059. return;
  1060. }
  1061. if (is_object($one)) {
  1062. if ($one instanceof SimpleXMLElement || $one instanceof DOMNode) {
  1063. $one = $this->_normalizeXmlData(Xml::toArray($one));
  1064. } else {
  1065. $one = Set::reverse($one);
  1066. }
  1067. }
  1068. if (is_array($one)) {
  1069. $data = $one;
  1070. if (empty($one[$this->alias])) {
  1071. $data = $this->_setAliasData($one);
  1072. }
  1073. } else {
  1074. $data = array($this->alias => array($one => $two));
  1075. }
  1076. foreach ($data as $modelName => $fieldSet) {
  1077. if (!is_array($fieldSet)) {
  1078. continue;
  1079. }
  1080. foreach ($fieldSet as $fieldName => $fieldValue) {
  1081. unset($this->validationErrors[$fieldName]);
  1082. if ($modelName === $this->alias && $fieldName === $this->primaryKey) {
  1083. $this->id = $fieldValue;
  1084. }
  1085. if (is_array($fieldValue) || is_object($fieldValue)) {
  1086. $fieldValue = $this->deconstruct($fieldName, $fieldValue);
  1087. }
  1088. $this->data[$modelName][$fieldName] = $fieldValue;
  1089. }
  1090. }
  1091. return $data;
  1092. }
  1093. /**
  1094. * Move values to alias
  1095. *
  1096. * @param array $data Data.
  1097. * @return array
  1098. */
  1099. protected function _setAliasData($data) {
  1100. $models = array_keys($this->getAssociated());
  1101. $schema = array_keys((array)$this->schema());
  1102. foreach ($data as $field => $value) {
  1103. if (in_array($field, $schema) || !in_array($field, $models)) {
  1104. $data[$this->alias][$field] = $value;
  1105. unset($data[$field]);
  1106. }
  1107. }
  1108. return $data;
  1109. }
  1110. /**
  1111. * Normalize `Xml::toArray()` to use in `Model::save()`
  1112. *
  1113. * @param array $xml XML as array
  1114. * @return array
  1115. */
  1116. protected function _normalizeXmlData(array $xml) {
  1117. $return = array();
  1118. foreach ($xml as $key => $value) {
  1119. if (is_array($value)) {
  1120. $return[Inflector::camelize($key)] = $this->_normalizeXmlData($value);
  1121. } elseif ($key[0] === '@') {
  1122. $return[substr($key, 1)] = $value;
  1123. } else {
  1124. $return[$key] = $value;
  1125. }
  1126. }
  1127. return $return;
  1128. }
  1129. /**
  1130. * Deconstructs a complex data type (array or object) into a single field value.
  1131. *
  1132. * @param string $field The name of the field to be deconstructed
  1133. * @param array|object $data An array or object to be deconstructed into a field
  1134. * @return mixed The resulting data that should be assigned to a field
  1135. */
  1136. public function deconstruct($field, $data) {
  1137. if (!is_array($data)) {
  1138. return $data;
  1139. }
  1140. $type = $this->getColumnType($field);
  1141. if (!in_array($type, array('datetime', 'timestamp', 'date', 'time'))) {
  1142. return $data;
  1143. }
  1144. $useNewDate = (isset($data['year']) || isset($data['month']) ||
  1145. isset($data['day']) || isset($data['hour']) || isset($data['minute']));
  1146. $dateFields = array('Y' => 'year', 'm' => 'month', 'd' => 'day', 'H' => 'hour', 'i' => 'min', 's' => 'sec');
  1147. $timeFields = array('H' => 'hour', 'i' => 'min', 's' => 'sec');
  1148. $date = array();
  1149. if (isset($data['meridian']) && empty($data['meridian'])) {
  1150. return null;
  1151. }
  1152. if (
  1153. isset($data['hour']) &&
  1154. isset($data['meridian']) &&
  1155. !empty($data['hour']) &&
  1156. $data['hour'] != 12 &&
  1157. $data['meridian'] === 'pm'
  1158. ) {
  1159. $data['hour'] = $data['hour'] + 12;
  1160. }
  1161. if (isset($data['hour']) && isset($data['meridian']) && $data['hour'] == 12 && $data['meridian'] === 'am') {
  1162. $data['hour'] = '00';
  1163. }
  1164. if ($type === 'time') {
  1165. foreach ($timeFields as $key => $val) {
  1166. if (!isset($data[$val]) || $data[$val] === '0' || $data[$val] === '00') {
  1167. $data[$val] = '00';
  1168. } elseif ($data[$val] !== '') {
  1169. $data[$val] = sprintf('%02d', $data[$val]);
  1170. }
  1171. if (!empty($data[$val])) {
  1172. $date[$key] = $data[$val];
  1173. } else {
  1174. return null;
  1175. }
  1176. }
  1177. }
  1178. if ($type === 'datetime' || $type === 'timestamp' || $type === 'date') {
  1179. foreach ($dateFields as $key => $val) {
  1180. if ($val === 'hour' || $val === 'min' || $val === 'sec') {
  1181. if (!isset($data[$val]) || $data[$val] === '0' || $data[$val] === '00') {
  1182. $data[$val] = '00';
  1183. } else {
  1184. $data[$val] = sprintf('%02d', $data[$val]);
  1185. }
  1186. }
  1187. if (!isset($data[$val]) || isset($data[$val]) && (empty($data[$val]) || $data[$val][0] === '-')) {
  1188. return null;
  1189. }
  1190. if (isset($data[$val]) && !empty($data[$val])) {
  1191. $date[$key] = $data[$val];
  1192. }
  1193. }
  1194. }
  1195. if ($useNewDate && !empty($date)) {
  1196. $format = $this->getDataSource()->columns[$type]['format'];
  1197. foreach (array('m', 'd', 'H', 'i', 's') as $index) {
  1198. if (isset($date[$index])) {
  1199. $date[$index] = sprintf('%02d', $date[$index]);
  1200. }
  1201. }
  1202. return str_replace(array_keys($date), array_values($date), $format);
  1203. }
  1204. return $data;
  1205. }
  1206. /**
  1207. * Returns an array of table metadata (column names and types) from the database.
  1208. * $field => keys(type, null, default, key, length, extra)
  1209. *
  1210. * @param bool|string $field Set to true to reload schema, or a string to return a specific field
  1211. * @return array Array of table metadata
  1212. */
  1213. public function schema($field = false) {
  1214. if ($this->useTable !== false && (!is_array($this->_schema) || $field === true)) {
  1215. $db = $this->getDataSource();
  1216. $db->cacheSources = ($this->cacheSources && $db->cacheSources);
  1217. if (method_exists($db, 'describe')) {
  1218. $this->_schema = $db->describe($this);
  1219. }
  1220. }
  1221. if (!is_string($field)) {
  1222. return $this->_schema;
  1223. }
  1224. if (isset($this->_schema[$field])) {
  1225. return $this->_schema[$field];
  1226. }
  1227. return null;
  1228. }
  1229. /**
  1230. * Returns an associative array of field names and column types.
  1231. *
  1232. * @return array Field types indexed by field name
  1233. */
  1234. public function getColumnTypes() {
  1235. $columns = $this->schema();
  1236. if (empty($columns)) {
  1237. trigger_error(__d('cake_dev', '(Model::getColumnTypes) Unable to build model field data. If you are using a model without a database table, try implementing schema()'), E_USER_WARNING);
  1238. }
  1239. $cols = array();
  1240. foreach ($columns as $field => $values) {
  1241. $cols[$field] = $values['type'];
  1242. }
  1243. return $cols;
  1244. }
  1245. /**
  1246. * Returns the column type of a column in the model.
  1247. *
  1248. * @param string $column The name of the model column
  1249. * @return string Column type
  1250. */
  1251. public function getColumnType($column) {
  1252. $db = $this->getDataSource();
  1253. $cols = $this->schema();
  1254. $model = null;
  1255. $startQuote = isset($db->startQuote) ? $db->startQuote : null;
  1256. $endQuote = isset($db->endQuote) ? $db->endQuote : null;
  1257. $column = str_replace(array($startQuote, $endQuote), '', $column);
  1258. if (strpos($column, '.')) {
  1259. list($model, $column) = explode('.', $column);
  1260. }
  1261. if (isset($model) && $model != $this->alias && isset($this->{$model})) {
  1262. return $this->{$model}->getColumnType($column);
  1263. }
  1264. if (isset($cols[$column]) && isset($cols[$column]['type'])) {
  1265. return $cols[$column]['type'];
  1266. }
  1267. return null;
  1268. }
  1269. /**
  1270. * Returns true if the supplied field exists in the model's database table.
  1271. *
  1272. * @param string|array $name Name of field to look for, or an array of names
  1273. * @param bool $checkVirtual checks if the field is declared as virtual
  1274. * @return mixed If $name is a string, returns a boolean indicating whether the field exists.
  1275. * If $name is an array of field names, returns the first field that exists,
  1276. * or false if none exist.
  1277. */
  1278. public function hasField($name, $checkVirtual = false) {
  1279. if (is_array($name)) {
  1280. foreach ($name as $n) {
  1281. if ($this->hasField($n, $checkVirtual)) {
  1282. return $n;
  1283. }
  1284. }
  1285. return false;
  1286. }
  1287. if ($checkVirtual && !empty($this->virtualFields) && $this->isVirtualField($name)) {
  1288. return true;
  1289. }
  1290. if (empty($this->_schema)) {
  1291. $this->schema();
  1292. }
  1293. if ($this->_schema) {
  1294. return isset($this->_schema[$name]);
  1295. }
  1296. return false;
  1297. }
  1298. /**
  1299. * Check that a method is callable on a model. This will check both the model's own methods, its
  1300. * inherited methods and methods that could be callable through behaviors.
  1301. *
  1302. * @param string $method The method to be called.
  1303. * @return bool True on method being callable.
  1304. */
  1305. public function hasMethod($method) {
  1306. if (method_exists($this, $method)) {
  1307. return true;
  1308. }
  1309. return $this->Behaviors->hasMethod($method);
  1310. }
  1311. /**
  1312. * Returns true if the supplied field is a model Virtual Field
  1313. *
  1314. * @param string $field Name of field to look for
  1315. * @return bool indicating whether the field exists as a model virtual field.
  1316. */
  1317. public function isVirtualField($field) {
  1318. if (empty($this->virtualFields) || !is_string($field)) {
  1319. return false;
  1320. }
  1321. if (isset($this->virtualFields[$field])) {
  1322. return true;
  1323. }
  1324. if (strpos($field, '.') !== false) {
  1325. list($model, $field) = explode('.', $field);
  1326. if ($model === $this->alias && isset($this->virtualFields[$field])) {
  1327. return true;
  1328. }
  1329. }
  1330. return false;
  1331. }
  1332. /**
  1333. * Returns the expression for a model virtual field
  1334. *
  1335. * @param string $field Name of field to look for
  1336. * @return mixed If $field is string expression bound to virtual field $field
  1337. * If $field is null, returns an array of all model virtual fields
  1338. * or false if none $field exist.
  1339. */
  1340. public function getVirtualField($field = null) {
  1341. if (!$field) {
  1342. return empty($this->virtualFields) ? false : $this->virtualFields;
  1343. }
  1344. if ($this->isVirtualField($field)) {
  1345. if (strpos($field, '.') !== false) {
  1346. list(, $field) = pluginSplit($field);
  1347. }
  1348. return $this->virtualFields[$field];
  1349. }
  1350. return false;
  1351. }
  1352. /**
  1353. * Initializes the model for writing a new record, loading the default values
  1354. * for those fields that are not defined in $data, and clearing previous validation errors.
  1355. * Especially helpful for saving data in loops.
  1356. *
  1357. * @param bool|array $data Optional data array to assign to the model after it is created. If null or false,
  1358. * schema data defaults are not merged.
  1359. * @param bool $filterKey If true, overwrites any primary key input with an empty value
  1360. * @return array The current Model::data; after merging $data and/or defaults from database
  1361. * @link http://book.cakephp.org/2.0/en/models/saving-your-data.html#model-create-array-data-array
  1362. */
  1363. public function create($data = array(), $filterKey = false) {
  1364. $defaults = array();
  1365. $this->id = false;
  1366. $this->data = array();
  1367. $this->validationErrors = array();
  1368. if ($data !== null && $data !== false) {
  1369. $schema = (array)$this->schema();
  1370. foreach ($schema as $field => $properties) {
  1371. if ($this->primaryKey !== $field && isset($properties['default']) && $properties['default'] !== '') {
  1372. $defaults[$field] = $properties['default'];
  1373. }
  1374. }
  1375. $this->set($defaults);
  1376. $this->set($data);
  1377. }
  1378. if ($filterKey) {
  1379. $this->set($this->primaryKey, false);
  1380. }
  1381. return $this->data;
  1382. }
  1383. /**
  1384. * This function is a convenient wrapper class to create(false) and, as the name suggests, clears the id, data, and validation errors.
  1385. *
  1386. * @return bool Always true upon success
  1387. * @see Model::create()
  1388. */
  1389. public function clear() {
  1390. $this->create(false);
  1391. return true;
  1392. }
  1393. /**
  1394. * Returns a list of fields from the database, and sets the current model
  1395. * data (Model::$data) with the record found.
  1396. *
  1397. * @param string|array $fields String of single field name, or an array of field names.
  1398. * @param int|string $id The ID of the record to read
  1399. * @return array Array of database fields, or false if not found
  1400. * @link http://book.cakephp.org/2.0/en/models/retrieving-your-data.html#model-read
  1401. */
  1402. public function read($fields = null, $id = null) {
  1403. $this->validationErrors = array();
  1404. if ($id) {
  1405. $this->id = $id;
  1406. }
  1407. $id = $this->id;
  1408. if (is_array($this->id)) {
  1409. $id = $this->id[0];
  1410. }
  1411. if ($id !== null && $id !== false) {
  1412. $this->data = $this->find('first', array(
  1413. 'conditions' => array($this->alias . '.' . $this->primaryKey => $id),
  1414. 'fields' => $fields
  1415. ));
  1416. return $this->data;
  1417. }
  1418. return false;
  1419. }
  1420. /**
  1421. * Returns the contents of a single field given the supplied conditions, in the
  1422. * supplied order.
  1423. *
  1424. * @param string $name Name of field to get
  1425. * @param array $conditions SQL conditions (defaults to NULL)
  1426. * @param string $order SQL ORDER BY fragment
  1427. * @return string field contents, or false if not found
  1428. * @link http://book.cakephp.org/2.0/en/models/retrieving-your-data.html#model-field
  1429. */
  1430. public function field($name, $conditions = null, $order = null) {
  1431. if ($conditions === null && $this->id !== false) {
  1432. $conditions = array($this->alias . '.' . $this->primaryKey => $this->id);
  1433. }
  1434. $recursive = $this->recursive;
  1435. if ($this->recursive >= 1) {
  1436. $recursive = -1;
  1437. }
  1438. $fields = $name;
  1439. $data = $this->find('first', compact('conditions', 'fields', 'order', 'recursive'));
  1440. if (!$data) {
  1441. return false;
  1442. }
  1443. if (strpos($name, '.') === false) {
  1444. if (isset($data[$this->alias][$name])) {
  1445. return $data[$this->alias][$name];
  1446. }
  1447. } else {
  1448. $name = explode('.', $name);
  1449. if (isset($data[$name[0]][$name[1]])) {
  1450. return $data[$name[0]][$name[1]];
  1451. }
  1452. }
  1453. if (isset($data[0]) && count($data[0]) > 0) {
  1454. return array_shift($data[0]);
  1455. }
  1456. }
  1457. /**
  1458. * Saves the value of a single field to the database, based on the current
  1459. * model ID.
  1460. *
  1461. * @param string $name Name of the table field
  1462. * @param mixed $value Value of the field
  1463. * @param bool|array $validate Either a boolean, or an array.
  1464. * If a boolean, indicates whether or not to validate before saving.
  1465. * If an array, allows control of 'validate', 'callbacks' and 'counterCache' options.
  1466. * See Model::save() for details of each options.
  1467. * @return bool See Model::save()
  1468. * @see Model::save()
  1469. * @link http://book.cakephp.org/2.0/en/models/saving-your-data.html#model-savefield-string-fieldname-string-fieldvalue-validate-false
  1470. */
  1471. public function saveField($name, $value, $validate = false) {
  1472. $id = $this->id;
  1473. $this->create(false);
  1474. $options = array('validate' => $validate, 'fieldList' => array($name));
  1475. if (is_array($validate)) {
  1476. $options = $validate + array('validate' => false, 'fieldList' => array($name));
  1477. }
  1478. return $this->save(array($this->alias => array($this->primaryKey => $id, $name => $value)), $options);
  1479. }
  1480. /**
  1481. * Saves model data (based on white-list, if supplied) to the database. By
  1482. * default, validation occurs before save.
  1483. *
  1484. * @param array $data Data to save.
  1485. * @param bool|array $validate Either a boolean, or an array.
  1486. * If a boolean, indicates whether or not to validate before saving.
  1487. * If an array, can have following keys:
  1488. *
  1489. * - validate: Set to true/false to enable or disable validation.
  1490. * - fieldList: An array of fields you want to allow for saving.
  1491. * - callbacks: Set to false to disable callbacks. Using 'before' or 'after'
  1492. * will enable only those callbacks.
  1493. * - `counterCache`: Boolean to control updating of counter caches (if any)
  1494. *
  1495. * @param array $fieldList List of fields to allow to be saved
  1496. * @return mixed On success Model::$data if its not empty or true, false on failure
  1497. * @throws PDOException
  1498. * @link http://book.cakephp.org/2.0/en/models/saving-your-data.html
  1499. */
  1500. public function save($data = null, $validate = true, $fieldList = array()) {
  1501. $defaults = array(
  1502. 'validate' => true, 'fieldList' => array(),
  1503. 'callbacks' => true, 'counterCache' => true
  1504. );
  1505. $_whitelist = $this->whitelist;
  1506. $fields = array();
  1507. if (!is_array($validate)) {
  1508. $options = compact('validate', 'fieldList') + $defaults;
  1509. } else {
  1510. $options = $validate + $defaults;
  1511. }
  1512. if (!empty($options['fieldList'])) {
  1513. if (!empty($options['fieldList'][$this->alias]) && is_array($options['fieldList'][$this->alias])) {
  1514. $this->whitelist = $options['fieldList'][$this->alias];
  1515. } elseif (Hash::dimensions($options['fieldList']) < 2) {
  1516. $this->whitelist = $options['fieldList'];
  1517. }
  1518. } elseif ($options['fieldList'] === null) {
  1519. $this->whitelist = array();
  1520. }
  1521. $this->set($data);
  1522. if (empty($this->data) && !$this->hasField(array('created', 'updated', 'modified'))) {
  1523. $this->whitelist = $_whitelist;
  1524. return false;
  1525. }
  1526. foreach (array('created', 'updated', 'modified') as $field) {
  1527. $keyPresentAndEmpty = (
  1528. isset($this->data[$this->alias]) &&
  1529. array_key_exists($field, $this->data[$this->alias]) &&
  1530. $this->data[$this->alias][$field] === null
  1531. );
  1532. if ($keyPresentAndEmpty) {
  1533. unset($this->data[$this->alias][$field]);
  1534. }
  1535. }
  1536. $exists = $this->exists();
  1537. $dateFields = array('modified', 'updated');
  1538. if (!$exists) {
  1539. $dateFields[] = 'created';
  1540. }
  1541. if (isset($this->data[$this->alias])) {
  1542. $fields = array_keys($this->data[$this->alias]);
  1543. }
  1544. if ($options['validate'] && !$this->validates($options)) {
  1545. $this->whitelist = $_whitelist;
  1546. return false;
  1547. }
  1548. $db = $this->getDataSource();
  1549. $now = time();
  1550. foreach ($dateFields as $updateCol) {
  1551. if (in_array($updateCol, $fields) || !$this->hasField($updateCol)) {
  1552. continue;
  1553. }
  1554. $default = array('formatter' => 'date');
  1555. $colType = array_merge($default, $db->columns[$this->getColumnType($updateCol)]);
  1556. $time = $now;
  1557. if (array_key_exists('format', $colType)) {
  1558. $time = call_user_func($colType['formatter'], $colType['format']);
  1559. }
  1560. if (!empty($this->whitelist)) {
  1561. $this->whitelist[] = $updateCol;
  1562. }
  1563. $this->set($updateCol, $time);
  1564. }
  1565. if ($options['callbacks'] === true || $options['callbacks'] === 'before') {
  1566. $event = new CakeEvent('Model.beforeSave', $this, array($options));
  1567. list($event->break, $event->breakOn) = array(true, array(false, null));
  1568. $this->getEventManager()->dispatch($event);
  1569. if (!$event->result) {
  1570. $this->whitelist = $_whitelist;
  1571. return false;
  1572. }
  1573. }
  1574. $db = $this->getDataSource();
  1575. if (empty($this->data[$this->alias][$this->primaryKey])) {
  1576. unset($this->data[$this->alias][$this->primaryKey]);
  1577. }
  1578. $fields = $values = array();
  1579. foreach ($this->data as $n => $v) {
  1580. if (isset($this->hasAndBelongsToMany[$n])) {
  1581. if (isset($v[$n])) {
  1582. $v = $v[$n];
  1583. }
  1584. $joined[$n] = $v;
  1585. } elseif ($n === $this->alias) {
  1586. foreach (array('created', 'updated', 'modified') as $field) {
  1587. if (array_key_exists($field, $v) && empty($v[$field])) {
  1588. unset($v[$field]);
  1589. }
  1590. }
  1591. foreach ($v as $x => $y) {
  1592. if ($this->hasField($x) && (empty($this->whitelist) || in_array($x, $this->whitelist))) {
  1593. list($fields[], $values[]) = array($x, $y);
  1594. }
  1595. }
  1596. }
  1597. }
  1598. $count = count($fields);
  1599. if (!$exists && $count > 0) {
  1600. $this->id = false;
  1601. }
  1602. $success = true;
  1603. $created = false;
  1604. if ($count > 0) {
  1605. $cache = $this->_prepareUpdateFields(array_combine($fields, $values));
  1606. if (!empty($this->id)) {
  1607. $this->__safeUpdateMode = true;
  1608. try {
  1609. $success = (bool)$db->update($this, $fields, $values);
  1610. } catch (Exception $e) {
  1611. $this->__safeUpdateMode = false;
  1612. throw $e;
  1613. }
  1614. $this->__safeUpdateMode = false;
  1615. } else {
  1616. if (empty($this->data[$this->alias][$this->primaryKey]) && $this->_isUUIDField($this->primaryKey)) {
  1617. if (array_key_exists($this->primaryKey, $this->data[$this->alias])) {
  1618. $j = array_search($this->primaryKey, $fields);
  1619. $values[$j] = String::uuid();
  1620. } else {
  1621. list($fields[], $values[]) = array($this->primaryKey, String::uuid());
  1622. }
  1623. }
  1624. if (!$db->create($this, $fields, $values)) {
  1625. $success = false;
  1626. } else {
  1627. $created = true;
  1628. }
  1629. }
  1630. if ($success && $options['counterCache'] && !empty($this->belongsTo)) {
  1631. $this->updateCounterCache($cache, $created);
  1632. }
  1633. }
  1634. if (!empty($joined) && $success === true) {
  1635. $this->_saveMulti($joined, $this->id, $db);
  1636. }
  1637. if ($success && $count === 0) {
  1638. $success = false;
  1639. }
  1640. if ($success && $count > 0) {
  1641. if (!empty($this->data)) {
  1642. if ($created) {
  1643. $this->data[$this->alias][$this->primaryKey] = $this->id;
  1644. }
  1645. }
  1646. if ($options['callbacks'] === true || $options['callbacks'] === 'after') {
  1647. $event = new CakeEvent('Model.afterSave', $this, array($created, $options));
  1648. $this->getEventManager()->dispatch($event);
  1649. }
  1650. if (!empty($this->data)) {
  1651. $success = $this->data;
  1652. }
  1653. $this->_clearCache();
  1654. $this->validationErrors = array();
  1655. $this->data = false;
  1656. }
  1657. $this->whitelist = $_whitelist;
  1658. return $success;
  1659. }
  1660. /**
  1661. * Check if the passed in field is a UUID field
  1662. *
  1663. * @param string $field the field to check
  1664. * @return bool
  1665. */
  1666. protected function _isUUIDField($field) {
  1667. $field = $this->schema($field);
  1668. return $field['length'] == 36 && in_array($field['type'], array('string', 'binary'));
  1669. }
  1670. /**
  1671. * Saves model hasAndBelongsToMany data to the database.
  1672. *
  1673. * @param array $joined Data to save
  1674. * @param int|string $id ID of record in this model
  1675. * @param DataSource $db Datasource instance.
  1676. * @return void
  1677. */
  1678. protected function _saveMulti($joined, $id, $db) {
  1679. foreach ($joined as $assoc => $data) {
  1680. if (!isset($this->hasAndBelongsToMany[$assoc])) {
  1681. continue;
  1682. }
  1683. $habtm = $this->hasAndBelongsToMany[$assoc];
  1684. list($join) = $this->joinModel($habtm['with']);
  1685. $Model = $this->{$join};
  1686. if (!empty($habtm['with'])) {
  1687. $withModel = is_array($habtm['with']) ? key($habtm['with']) : $habtm['with'];
  1688. list(, $withModel) = pluginSplit($withModel);
  1689. $dbMulti = $this->{$withModel}->getDataSource();
  1690. } else {
  1691. $dbMulti = $db;
  1692. }
  1693. $isUUID = !empty($Model->primaryKey) && $Model->_isUUIDField($Model->primaryKey);
  1694. $newData = $newValues = $newJoins = array();
  1695. $primaryAdded = false;
  1696. $fields = array(
  1697. $dbMulti->name($habtm['foreignKey']),
  1698. $dbMulti->name($habtm['associationForeignKey'])
  1699. );
  1700. $idField = $db->name($Model->primaryKey);
  1701. if ($isUUID && !in_array($idField, $fields)) {
  1702. $fields[] = $idField;
  1703. $primaryAdded = true;
  1704. }
  1705. foreach ((array)$data as $row) {
  1706. if ((is_string($row) && (strlen($row) === 36 || strlen($row) === 16)) || is_numeric($row)) {
  1707. $newJoins[] = $row;
  1708. $values = array($id, $row);
  1709. if ($isUUID && $primaryAdded) {
  1710. $values[] = String::uuid();
  1711. }
  1712. $newValues[$row] = $values;
  1713. unset($values);
  1714. } elseif (isset($row[$habtm['associationForeignKey']])) {
  1715. if (!empty($row[$Model->primaryKey])) {
  1716. $newJoins[] = $row[$habtm['associationForeignKey']];
  1717. }
  1718. $newData[] = $row;
  1719. } elseif (isset($row[$join]) && isset($row[$join][$habtm['associationForeignKey']])) {
  1720. if (!empty($row[$join][$Model->primaryKey])) {
  1721. $newJoins[] = $row[$join][$habtm['associationForeignKey']];
  1722. }
  1723. $newData[] = $row[$join];
  1724. }
  1725. }
  1726. $keepExisting = $habtm['unique'] === 'keepExisting';
  1727. if ($habtm['unique']) {
  1728. $conditions = array(
  1729. $join . '.' . $habtm['foreignKey'] => $id
  1730. );
  1731. if (!empty($habtm['conditions'])) {
  1732. $conditions = array_merge($conditions, (array)$habtm['conditions']);
  1733. }
  1734. $associationForeignKey = $Model->alias . '.' . $habtm['associationForeignKey'];
  1735. $links = $Model->find('all', array(
  1736. 'conditions' => $conditions,
  1737. 'recursive' => empty($habtm['conditions']) ? -1 : 0,
  1738. 'fields' => $associationForeignKey,
  1739. ));
  1740. $oldLinks = Hash::extract($links, "{n}.{$associationForeignKey}");
  1741. if (!empty($oldLinks)) {
  1742. if ($keepExisting && !empty($newJoins)) {
  1743. $conditions[$associationForeignKey] = array_diff($oldLinks, $newJoins);
  1744. } else {
  1745. $conditions[$associationForeignKey] = $oldLinks;
  1746. }
  1747. $dbMulti->delete($Model, $conditions);
  1748. }
  1749. }
  1750. if (!empty($newData)) {
  1751. foreach ($newData as $data) {
  1752. $data[$habtm['foreignKey']] = $id;
  1753. if (empty($data[$Model->primaryKey])) {
  1754. $Model->create();
  1755. }
  1756. $Model->save($data);
  1757. }
  1758. }
  1759. if (!empty($newValues)) {
  1760. if ($keepExisting && !empty($links)) {
  1761. foreach ($links as $link) {
  1762. $oldJoin = $link[$join][$habtm['associationForeignKey']];
  1763. if (!in_array($oldJoin, $newJoins)) {
  1764. $conditions[$associationForeignKey] = $oldJoin;
  1765. $db->delete($Model, $conditions);
  1766. } else {
  1767. unset($newValues[$oldJoin]);
  1768. }
  1769. }
  1770. $newValues = array_values($newValues);
  1771. }
  1772. if (!empty($newValues)) {
  1773. $dbMulti->insertMulti($Model, $fields, $newValues);
  1774. }
  1775. }
  1776. }
  1777. }
  1778. /**
  1779. * Updates the counter cache of belongsTo associations after a save or delete operation
  1780. *
  1781. * @param array $keys Optional foreign key data, defaults to the information $this->data
  1782. * @param bool $created True if a new record was created, otherwise only associations with
  1783. * 'counterScope' defined get updated
  1784. * @return void
  1785. */
  1786. public function updateCounterCache($keys = array(), $created = false) {
  1787. if (empty($keys) && isset($this->data[$this->alias])) {
  1788. $keys = $this->data[$this->alias];
  1789. }
  1790. $keys['old'] = isset($keys['old']) ? $keys['old'] : array();
  1791. foreach ($this->belongsTo as $parent => $assoc) {
  1792. if (empty($assoc['counterCache'])) {
  1793. continue;
  1794. }
  1795. $Model = $this->{$parent};
  1796. if (!is_array($assoc['counterCache'])) {
  1797. if (isset($assoc['counterScope'])) {
  1798. $assoc['counterCache'] = array($assoc['counterCache'] => $assoc['counterScope']);
  1799. } else {
  1800. $assoc['counterCache'] = array($assoc['counterCache'] => array());
  1801. }
  1802. }
  1803. $foreignKey = $assoc['foreignKey'];
  1804. $fkQuoted = $this->escapeField($assoc['foreignKey']);
  1805. foreach ($assoc['counterCache'] as $field => $conditions) {
  1806. if (!is_string($field)) {
  1807. $field = Inflector::underscore($this->alias) . '_count';
  1808. }
  1809. if (!$Model->hasField($field)) {
  1810. continue;
  1811. }
  1812. if ($conditions === true) {
  1813. $conditions = array();
  1814. } else {
  1815. $conditions = (array)$conditions;
  1816. }
  1817. if (!array_key_exists($foreignKey, $keys)) {
  1818. $keys[$foreignKey] = $this->field($foreignKey);
  1819. }
  1820. $recursive = (empty($conditions) ? -1 : 0);
  1821. if (isset($keys['old'][$foreignKey]) && $keys['old'][$foreignKey] != $keys[$foreignKey]) {
  1822. $conditions[$fkQuoted] = $keys['old'][$foreignKey];
  1823. $count = intval($this->find('count', compact('conditions', 'recursive')));
  1824. $Model->updateAll(
  1825. array($field => $count),
  1826. array($Model->escapeField() => $keys['old'][$foreignKey])
  1827. );
  1828. }
  1829. $conditions[$fkQuoted] = $keys[$foreignKey];
  1830. if ($recursive === 0) {
  1831. $conditions = array_merge($conditions, (array)$conditions);
  1832. }
  1833. $count = intval($this->find('count', compact('conditions', 'recursive')));
  1834. $Model->updateAll(
  1835. array($field => $count),
  1836. array($Model->escapeField() => $keys[$foreignKey])
  1837. );
  1838. }
  1839. }
  1840. }
  1841. /**
  1842. * Helper method for `Model::updateCounterCache()`. Checks the fields to be updated for
  1843. *
  1844. * @param array $data The fields of the record that will be updated
  1845. * @return array Returns updated foreign key values, along with an 'old' key containing the old
  1846. * values, or empty if no foreign keys are updated.
  1847. */
  1848. protected function _prepareUpdateFields($data) {
  1849. $foreignKeys = array();
  1850. foreach ($this->belongsTo as $assoc => $info) {
  1851. if (isset($info['counterCache']) && $info['counterCache']) {
  1852. $foreignKeys[$assoc] = $info['foreignKey'];
  1853. }
  1854. }
  1855. $included = array_intersect($foreignKeys, array_keys($data));
  1856. if (empty($included) || empty($this->id)) {
  1857. return array();
  1858. }
  1859. $old = $this->find('first', array(
  1860. 'conditions' => array($this->alias . '.' . $this->primaryKey => $this->id),
  1861. 'fields' => array_values($included),
  1862. 'recursive' => -1
  1863. ));
  1864. return array_merge($data, array('old' => $old[$this->alias]));
  1865. }
  1866. /**
  1867. * Backwards compatible passthrough method for:
  1868. * saveMany(), validateMany(), saveAssociated() and validateAssociated()
  1869. *
  1870. * Saves multiple individual records for a single model; Also works with a single record, as well as
  1871. * all its associated records.
  1872. *
  1873. * #### Options
  1874. *
  1875. * - `validate`: Set to false to disable validation, true to validate each record before saving,
  1876. * 'first' to validate *all* records before any are saved (default),
  1877. * or 'only' to only validate the records, but not save them.
  1878. * - `atomic`: If true (default), will attempt to save all records in a single transaction.
  1879. * Should be set to false if database/table does not support transactions.
  1880. * - `fieldList`: Equivalent to the $fieldList parameter in Model::save().
  1881. * It should be an associate array with model name as key and array of fields as value. Eg.
  1882. * {{{
  1883. * array(
  1884. * 'SomeModel' => array('field'),
  1885. * 'AssociatedModel' => array('field', 'otherfield')
  1886. * )
  1887. * }}}
  1888. * - `deep`: See saveMany/saveAssociated
  1889. * - `callbacks`: See Model::save()
  1890. * - `counterCache`: See Model::save()
  1891. *
  1892. * @param array $data Record data to save. This can be either a numerically-indexed array (for saving multiple
  1893. * records of the same type), or an array indexed by association name.
  1894. * @param array $options Options to use when saving record data, See $options above.
  1895. * @return mixed If atomic: True on success, or false on failure.
  1896. * Otherwise: array similar to the $data array passed, but values are set to true/false
  1897. * depending on whether each record saved successfully.
  1898. * @link http://book.cakephp.org/2.0/en/models/saving-your-data.html#model-saveassociated-array-data-null-array-options-array
  1899. * @link http://book.cakephp.org/2.0/en/models/saving-your-data.html#model-saveall-array-data-null-array-options-array
  1900. */
  1901. public function saveAll($data = array(), $options = array()) {
  1902. $options += array('validate' => 'first');
  1903. if (Hash::numeric(array_keys($data))) {
  1904. if ($options['validate'] === 'only') {
  1905. return $this->validateMany($data, $options);
  1906. }
  1907. return $this->saveMany($data, $options);
  1908. }
  1909. if ($options['validate'] === 'only') {
  1910. return $this->validateAssociated($data, $options);
  1911. }
  1912. return $this->saveAssociated($data, $options);
  1913. }
  1914. /**
  1915. * Saves multiple individual records for a single model
  1916. *
  1917. * #### Options
  1918. *
  1919. * - `validate`: Set to false to disable validation, true to validate each record before saving,
  1920. * 'first' to validate *all* records before any are saved (default),
  1921. * - `atomic`: If true (default), will attempt to save all records in a single transaction.
  1922. * Should be set to false if database/table does not support transactions.
  1923. * - `fieldList`: Equivalent to the $fieldList parameter in Model::save()
  1924. * - `deep`: If set to true, all associated data will be saved as well.
  1925. * - `callbacks`: See Model::save()
  1926. * - `counterCache`: See Model::save()
  1927. *
  1928. * @param array $data Record data to save. This should be a numerically-indexed array
  1929. * @param array $options Options to use when saving record data, See $options above.
  1930. * @return mixed If atomic: True on success, or false on failure.
  1931. * Otherwise: array similar to the $data array passed, but values are set to true/false
  1932. * depending on whether each record saved successfully.
  1933. * @link http://book.cakephp.org/2.0/en/models/saving-your-data.html#model-savemany-array-data-null-array-options-array
  1934. */
  1935. public function saveMany($data = null, $options = array()) {
  1936. if (empty($data)) {
  1937. $data = $this->data;
  1938. }
  1939. $options += array('validate' => 'first', 'atomic' => true, 'deep' => false);
  1940. $this->validationErrors = $validationErrors = array();
  1941. if (empty($data) && $options['validate'] !== false) {
  1942. $result = $this->save($data, $options);
  1943. if (!$options['atomic']) {
  1944. return array(!empty($result));
  1945. }
  1946. return !empty($result);
  1947. }
  1948. if ($options['validate'] === 'first') {
  1949. $validates = $this->validateMany($data, $options);
  1950. if ((!$validates && $options['atomic']) || (!$options['atomic'] && in_array(false, $validates, true))) {
  1951. return $validates;
  1952. }
  1953. $options['validate'] = false;
  1954. }
  1955. if ($options['atomic']) {
  1956. $db = $this->getDataSource();
  1957. $transactionBegun = $db->begin();
  1958. }
  1959. $return = array();
  1960. foreach ($data as $key => $record) {
  1961. $validates = $this->create(null) !== null;
  1962. $saved = false;
  1963. if ($validates) {
  1964. if ($options['deep']) {
  1965. $saved = $this->saveAssociated($record, array_merge($options, array('atomic' => false)));
  1966. } else {
  1967. $saved = $this->save($record, $options);
  1968. }
  1969. }
  1970. $validates = ($validates && ($saved === true || (is_array($saved) && !in_array(false, $saved, true))));
  1971. if (!$validates) {
  1972. $validationErrors[$key] = $this->validationErrors;
  1973. }
  1974. if (!$options['atomic']) {
  1975. $return[$key] = $validates;
  1976. } elseif (!$validates) {
  1977. break;
  1978. }
  1979. }
  1980. $this->validationErrors = $validationErrors;
  1981. if (!$options['atomic']) {
  1982. return $return;
  1983. }
  1984. if ($validates) {
  1985. if ($transactionBegun) {
  1986. return $db->commit() !== false;
  1987. }
  1988. return true;
  1989. }
  1990. $db->rollback();
  1991. return false;
  1992. }
  1993. /**
  1994. * Validates multiple individual records for a single model
  1995. *
  1996. * #### Options
  1997. *
  1998. * - `atomic`: If true (default), returns boolean. If false returns array.
  1999. * - `fieldList`: Equivalent to the $fieldList parameter in Model::save()
  2000. * - `deep`: If set to true, all associated data will be validated as well.
  2001. *
  2002. * Warning: This method could potentially change the passed argument `$data`,
  2003. * If you do not want this to happen, make a copy of `$data` before passing it
  2004. * to this method
  2005. *
  2006. * @param array &$data Record data to validate. This should be a numerically-indexed array
  2007. * @param array $options Options to use when validating record data (see above), See also $options of validates().
  2008. * @return bool|array If atomic: True on success, or false on failure.
  2009. * Otherwise: array similar to the $data array passed, but values are set to true/false
  2010. * depending on whether each record validated successfully.
  2011. */
  2012. public function validateMany(&$data, $options = array()) {
  2013. return $this->validator()->validateMany($data, $options);
  2014. }
  2015. /**
  2016. * Saves a single record, as well as all its directly associated records.
  2017. *
  2018. * #### Options
  2019. *
  2020. * - `validate`: Set to `false` to disable validation, `true` to validate each record before saving,
  2021. * 'first' to validate *all* records before any are saved(default),
  2022. * - `atomic`: If true (default), will attempt to save all records in a single transaction.
  2023. * Should be set to false if database/table does not support transactions.
  2024. * - `fieldList`: Equivalent to the $fieldList parameter in Model::save().
  2025. * It should be an associate array with model name as key and array of fields as value. Eg.
  2026. * {{{
  2027. * array(
  2028. * 'SomeModel' => array('field'),
  2029. * 'AssociatedModel' => array('field', 'otherfield')
  2030. * )
  2031. * }}}
  2032. * - `deep`: If set to true, not only directly associated data is saved, but deeper nested associated data as well.
  2033. * - `callbacks`: See Model::save()
  2034. * - `counterCache`: See Model::save()
  2035. *
  2036. * @param array $data Record data to save. This should be an array indexed by association name.
  2037. * @param array $options Options to use when saving record data, See $options above.
  2038. * @return mixed If atomic: True on success, or false on failure.
  2039. * Otherwise: array similar to the $data array passed, but values are set to true/false
  2040. * depending on whether each record saved successfully.
  2041. * @link http://book.cakephp.org/2.0/en/models/saving-your-data.html#model-saveassociated-array-data-null-array-options-array
  2042. */
  2043. public function saveAssociated($data = null, $options = array()) {
  2044. if (empty($data)) {
  2045. $data = $this->data;
  2046. }
  2047. $options += array('validate' => 'first', 'atomic' => true, 'deep' => false);
  2048. $this->validationErrors = $validationErrors = array();
  2049. if (empty($data) && $options['validate'] !== false) {
  2050. $result = $this->save($data, $options);
  2051. if (!$options['atomic']) {
  2052. return array(!empty($result));
  2053. }
  2054. return !empty($result);
  2055. }
  2056. if ($options['validate'] === 'first') {
  2057. $validates = $this->validateAssociated($data, $options);
  2058. if ((!$validates && $options['atomic']) || (!$options['atomic'] && in_array(false, Hash::flatten($validates), true))) {
  2059. return $validates;
  2060. }
  2061. $options['validate'] = false;
  2062. }
  2063. if ($options['atomic']) {
  2064. $db = $this->getDataSource();
  2065. $transactionBegun = $db->begin();
  2066. }
  2067. $associations = $this->getAssociated();
  2068. $return = array();
  2069. $validates = true;
  2070. foreach ($data as $association => $values) {
  2071. $isEmpty = empty($values) || (isset($values[$association]) && empty($values[$association]));
  2072. if ($isEmpty || !isset($associations[$association]) || $associations[$association] !== 'belongsTo') {
  2073. continue;
  2074. }
  2075. $Model = $this->{$association};
  2076. $validates = $Model->create(null) !== null;
  2077. $saved = false;
  2078. if ($validates) {
  2079. if ($options['deep']) {
  2080. $saved = $Model->saveAssociated($values, array('atomic' => false) + $options);
  2081. } else {
  2082. $saved = $Model->save($values, array('atomic' => false) + $options);
  2083. }
  2084. $validates = ($saved === true || (is_array($saved) && !in_array(false, $saved, true)));
  2085. }
  2086. if ($validates) {
  2087. $key = $this->belongsTo[$association]['foreignKey'];
  2088. if (isset($data[$this->alias])) {
  2089. $data[$this->alias][$key] = $Model->id;
  2090. } else {
  2091. $data = array_merge(array($key => $Model->id), $data, array($key => $Model->id));
  2092. }
  2093. $options = $this->_addToWhiteList($key, $options);
  2094. } else {
  2095. $validationErrors[$association] = $Model->validationErrors;
  2096. }
  2097. $return[$association] = $validates;
  2098. }
  2099. if ($validates && !($this->create(null) !== null && $this->save($data, $options))) {
  2100. $validationErrors[$this->alias] = $this->validationErrors;
  2101. $validates = false;
  2102. }
  2103. $return[$this->alias] = $validates;
  2104. foreach ($data as $association => $values) {
  2105. if (!$validates) {
  2106. break;
  2107. }
  2108. $isEmpty = empty($values) || (isset($values[$association]) && empty($values[$association]));
  2109. if ($isEmpty || !isset($associations[$association])) {
  2110. continue;
  2111. }
  2112. $Model = $this->{$association};
  2113. $type = $associations[$association];
  2114. $key = $this->{$type}[$association]['foreignKey'];
  2115. switch ($type) {
  2116. case 'hasOne':
  2117. if (isset($values[$association])) {
  2118. $values[$association][$key] = $this->id;
  2119. } else {
  2120. $values = array_merge(array($key => $this->id), $values, array($key => $this->id));
  2121. }
  2122. $validates = $Model->create(null) !== null;
  2123. $saved = false;
  2124. if ($validates) {
  2125. $options = $Model->_addToWhiteList($key, $options);
  2126. if ($options['deep']) {
  2127. $saved = $Model->saveAssociated($values, array('atomic' => false) + $options);
  2128. } else {
  2129. $saved = $Model->save($values, $options);
  2130. }
  2131. }
  2132. $validates = ($validates && ($saved === true || (is_array($saved) && !in_array(false, $saved, true))));
  2133. if (!$validates) {
  2134. $validationErrors[$association] = $Model->validationErrors;
  2135. }
  2136. $return[$association] = $validates;
  2137. break;
  2138. case 'hasMany':
  2139. foreach ($values as $i => $value) {
  2140. if (isset($values[$i][$association])) {
  2141. $values[$i][$association][$key] = $this->id;
  2142. } else {
  2143. $values[$i] = array_merge(array($key => $this->id), $value, array($key => $this->id));
  2144. }
  2145. }
  2146. $options = $Model->_addToWhiteList($key, $options);
  2147. $_return = $Model->saveMany($values, array('atomic' => false) + $options);
  2148. if (in_array(false, $_return, true)) {
  2149. $validationErrors[$association] = $Model->validationErrors;
  2150. $validates = false;
  2151. }
  2152. $return[$association] = $_return;
  2153. break;
  2154. }
  2155. }
  2156. $this->validationErrors = $validationErrors;
  2157. if (isset($validationErrors[$this->alias])) {
  2158. $this->validationErrors = $validationErrors[$this->alias];
  2159. unset($validationErrors[$this->alias]);
  2160. $this->validationErrors = array_merge($this->validationErrors, $validationErrors);
  2161. }
  2162. if (!$options['atomic']) {
  2163. return $return;
  2164. }
  2165. if ($validates) {
  2166. if ($transactionBegun) {
  2167. return $db->commit() !== false;
  2168. }
  2169. return true;
  2170. }
  2171. $db->rollback();
  2172. return false;
  2173. }
  2174. /**
  2175. * Helper method for saveAll() and friends, to add foreign key to fieldlist
  2176. *
  2177. * @param string $key fieldname to be added to list
  2178. * @param array $options Options list
  2179. * @return array options
  2180. */
  2181. protected function _addToWhiteList($key, $options) {
  2182. if (empty($options['fieldList']) && $this->whitelist && !in_array($key, $this->whitelist)) {
  2183. $options['fieldList'][$this->alias] = $this->whitelist;
  2184. $options['fieldList'][$this->alias][] = $key;
  2185. return $options;
  2186. }
  2187. if (!empty($options['fieldList'][$this->alias]) && is_array($options['fieldList'][$this->alias])) {
  2188. $options['fieldList'][$this->alias][] = $key;
  2189. return $options;
  2190. }
  2191. if (!empty($options['fieldList']) && is_array($options['fieldList']) && Hash::dimensions($options['fieldList']) < 2) {
  2192. $options['fieldList'][] = $key;
  2193. }
  2194. return $options;
  2195. }
  2196. /**
  2197. * Validates a single record, as well as all its directly associated records.
  2198. *
  2199. * #### Options
  2200. *
  2201. * - `atomic`: If true (default), returns boolean. If false returns array.
  2202. * - `fieldList`: Equivalent to the $fieldList parameter in Model::save()
  2203. * - `deep`: If set to true, not only directly associated data , but deeper nested associated data is validated as well.
  2204. *
  2205. * Warning: This method could potentially change the passed argument `$data`,
  2206. * If you do not want this to happen, make a copy of `$data` before passing it
  2207. * to this method
  2208. *
  2209. * @param array &$data Record data to validate. This should be an array indexed by association name.
  2210. * @param array $options Options to use when validating record data (see above), See also $options of validates().
  2211. * @return array|bool If atomic: True on success, or false on failure.
  2212. * Otherwise: array similar to the $data array passed, but values are set to true/false
  2213. * depending on whether each record validated successfully.
  2214. */
  2215. public function validateAssociated(&$data, $options = array()) {
  2216. return $this->validator()->validateAssociated($data, $options);
  2217. }
  2218. /**
  2219. * Updates multiple model records based on a set of conditions.
  2220. *
  2221. * @param array $fields Set of fields and values, indexed by fields.
  2222. * Fields are treated as SQL snippets, to insert literal values manually escape your data.
  2223. * @param mixed $conditions Conditions to match, true for all records
  2224. * @return bool True on success, false on failure
  2225. * @link http://book.cakephp.org/2.0/en/models/saving-your-data.html#model-updateall-array-fields-array-conditions
  2226. */
  2227. public function updateAll($fields, $conditions = true) {
  2228. return $this->getDataSource()->update($this, $fields, null, $conditions);
  2229. }
  2230. /**
  2231. * Removes record for given ID. If no ID is given, the current ID is used. Returns true on success.
  2232. *
  2233. * @param int|string $id ID of record to delete
  2234. * @param bool $cascade Set to true to delete records that depend on this record
  2235. * @return bool True on success
  2236. * @link http://book.cakephp.org/2.0/en/models/deleting-data.html
  2237. */
  2238. public function delete($id = null, $cascade = true) {
  2239. if (!empty($id)) {
  2240. $this->id = $id;
  2241. }
  2242. $id = $this->id;
  2243. $event = new CakeEvent('Model.beforeDelete', $this, array($cascade));
  2244. list($event->break, $event->breakOn) = array(true, array(false, null));
  2245. $this->getEventManager()->dispatch($event);
  2246. if ($event->isStopped()) {
  2247. return false;
  2248. }
  2249. if (!$this->exists()) {
  2250. return false;
  2251. }
  2252. $this->_deleteDependent($id, $cascade);
  2253. $this->_deleteLinks($id);
  2254. $this->id = $id;
  2255. if (!empty($this->belongsTo)) {
  2256. foreach ($this->belongsTo as $assoc) {
  2257. if (empty($assoc['counterCache'])) {
  2258. continue;
  2259. }
  2260. $keys = $this->find('first', array(
  2261. 'fields' => $this->_collectForeignKeys(),
  2262. 'conditions' => array($this->alias . '.' . $this->primaryKey => $id),
  2263. 'recursive' => -1,
  2264. 'callbacks' => false
  2265. ));
  2266. break;
  2267. }
  2268. }
  2269. if (!$this->getDataSource()->delete($this, array($this->alias . '.' . $this->primaryKey => $id))) {
  2270. return false;
  2271. }
  2272. if (!empty($keys[$this->alias])) {
  2273. $this->updateCounterCache($keys[$this->alias]);
  2274. }
  2275. $this->getEventManager()->dispatch(new CakeEvent('Model.afterDelete', $this));
  2276. $this->_clearCache();
  2277. $this->id = false;
  2278. return true;
  2279. }
  2280. /**
  2281. * Cascades model deletes through associated hasMany and hasOne child records.
  2282. *
  2283. * @param string $id ID of record that was deleted
  2284. * @param bool $cascade Set to true to delete records that depend on this record
  2285. * @return void
  2286. */
  2287. protected function _deleteDependent($id, $cascade) {
  2288. if ($cascade !== true) {
  2289. return;
  2290. }
  2291. if (!empty($this->__backAssociation)) {
  2292. $savedAssociations = $this->__backAssociation;
  2293. $this->__backAssociation = array();
  2294. }
  2295. foreach (array_merge($this->hasMany, $this->hasOne) as $assoc => $data) {
  2296. if ($data['dependent'] !== true) {
  2297. continue;
  2298. }
  2299. $Model = $this->{$assoc};
  2300. if ($data['foreignKey'] === false && $data['conditions'] && in_array($this->name, $Model->getAssociated('belongsTo'))) {
  2301. $Model->recursive = 0;
  2302. $conditions = array($this->escapeField(null, $this->name) => $id);
  2303. } else {
  2304. $Model->recursive = -1;
  2305. $conditions = array($Model->escapeField($data['foreignKey']) => $id);
  2306. if ($data['conditions']) {
  2307. $conditions = array_merge((array)$data['conditions'], $conditions);
  2308. }
  2309. }
  2310. if (isset($data['exclusive']) && $data['exclusive']) {
  2311. $Model->deleteAll($conditions);
  2312. } else {
  2313. $records = $Model->find('all', array(
  2314. 'conditions' => $conditions, 'fields' => $Model->primaryKey
  2315. ));
  2316. if (!empty($records)) {
  2317. foreach ($records as $record) {
  2318. $Model->delete($record[$Model->alias][$Model->primaryKey]);
  2319. }
  2320. }
  2321. }
  2322. }
  2323. if (isset($savedAssociations)) {
  2324. $this->__backAssociation = $savedAssociations;
  2325. }
  2326. }
  2327. /**
  2328. * Cascades model deletes through HABTM join keys.
  2329. *
  2330. * @param string $id ID of record that was deleted
  2331. * @return void
  2332. */
  2333. protected function _deleteLinks($id) {
  2334. foreach ($this->hasAndBelongsToMany as $data) {
  2335. list(, $joinModel) = pluginSplit($data['with']);
  2336. $Model = $this->{$joinModel};
  2337. $records = $Model->find('all', array(
  2338. 'conditions' => array($Model->escapeField($data['foreignKey']) => $id),
  2339. 'fields' => $Model->primaryKey,
  2340. 'recursive' => -1,
  2341. 'callbacks' => false
  2342. ));
  2343. if (!empty($records)) {
  2344. foreach ($records as $record) {
  2345. $Model->delete($record[$Model->alias][$Model->primaryKey]);
  2346. }
  2347. }
  2348. }
  2349. }
  2350. /**
  2351. * Deletes multiple model records based on a set of conditions.
  2352. *
  2353. * @param mixed $conditions Conditions to match
  2354. * @param bool $cascade Set to true to delete records that depend on this record
  2355. * @param bool $callbacks Run callbacks
  2356. * @return bool True on success, false on failure
  2357. * @link http://book.cakephp.org/2.0/en/models/deleting-data.html#deleteall
  2358. */
  2359. public function deleteAll($conditions, $cascade = true, $callbacks = false) {
  2360. if (empty($conditions)) {
  2361. return false;
  2362. }
  2363. $db = $this->getDataSource();
  2364. if (!$cascade && !$callbacks) {
  2365. return $db->delete($this, $conditions);
  2366. }
  2367. $ids = $this->find('all', array_merge(array(
  2368. 'fields' => "{$this->alias}.{$this->primaryKey}",
  2369. 'order' => false,
  2370. 'group' => "{$this->alias}.{$this->primaryKey}",
  2371. 'recursive' => 0), compact('conditions'))
  2372. );
  2373. if ($ids === false || $ids === null) {
  2374. return false;
  2375. }
  2376. $ids = Hash::extract($ids, "{n}.{$this->alias}.{$this->primaryKey}");
  2377. if (empty($ids)) {
  2378. return true;
  2379. }
  2380. if ($callbacks) {
  2381. $_id = $this->id;
  2382. $result = true;
  2383. foreach ($ids as $id) {
  2384. $result = $result && $this->delete($id, $cascade);
  2385. }
  2386. $this->id = $_id;
  2387. return $result;
  2388. }
  2389. foreach ($ids as $id) {
  2390. $this->_deleteLinks($id);
  2391. if ($cascade) {
  2392. $this->_deleteDependent($id, $cascade);
  2393. }
  2394. }
  2395. return $db->delete($this, array($this->alias . '.' . $this->primaryKey => $ids));
  2396. }
  2397. /**
  2398. * Collects foreign keys from associations.
  2399. *
  2400. * @param string $type Association type.
  2401. * @return array
  2402. */
  2403. protected function _collectForeignKeys($type = 'belongsTo') {
  2404. $result = array();
  2405. foreach ($this->{$type} as $assoc => $data) {
  2406. if (isset($data['foreignKey']) && is_string($data['foreignKey'])) {
  2407. $result[$assoc] = $data['foreignKey'];
  2408. }
  2409. }
  2410. return $result;
  2411. }
  2412. /**
  2413. * Returns true if a record with particular ID exists.
  2414. *
  2415. * If $id is not passed it calls `Model::getID()` to obtain the current record ID,
  2416. * and then performs a `Model::find('count')` on the currently configured datasource
  2417. * to ascertain the existence of the record in persistent storage.
  2418. *
  2419. * @param int|string $id ID of record to check for existence
  2420. * @return bool True if such a record exists
  2421. */
  2422. public function exists($id = null) {
  2423. if ($id === null) {
  2424. $id = $this->getID();
  2425. }
  2426. if ($id === false) {
  2427. return false;
  2428. }
  2429. return (bool)$this->find('count', array(
  2430. 'conditions' => array(
  2431. $this->alias . '.' . $this->primaryKey => $id
  2432. ),
  2433. 'recursive' => -1,
  2434. 'callbacks' => false
  2435. ));
  2436. }
  2437. /**
  2438. * Returns true if a record that meets given conditions exists.
  2439. *
  2440. * @param array $conditions SQL conditions array
  2441. * @return bool True if such a record exists
  2442. */
  2443. public function hasAny($conditions = null) {
  2444. return (bool)$this->find('count', array('conditions' => $conditions, 'recursive' => -1));
  2445. }
  2446. /**
  2447. * Queries the datasource and returns a result set array.
  2448. *
  2449. * Used to perform find operations, where the first argument is type of find operation to perform
  2450. * (all / first / count / neighbors / list / threaded),
  2451. * second parameter options for finding (indexed array, including: 'conditions', 'limit',
  2452. * 'recursive', 'page', 'fields', 'offset', 'order', 'callbacks')
  2453. *
  2454. * Eg:
  2455. * {{{
  2456. * $model->find('all', array(
  2457. * 'conditions' => array('name' => 'Thomas Anderson'),
  2458. * 'fields' => array('name', 'email'),
  2459. * 'order' => 'field3 DESC',
  2460. * 'recursive' => 2,
  2461. * 'group' => 'type',
  2462. * 'callbacks' => false,
  2463. * ));
  2464. * }}}
  2465. *
  2466. * In addition to the standard query keys above, you can provide Datasource, and behavior specific
  2467. * keys. For example, when using a SQL based datasource you can use the joins key to specify additional
  2468. * joins that should be part of the query.
  2469. *
  2470. * {{{
  2471. * $model->find('all', array(
  2472. * 'conditions' => array('name' => 'Thomas Anderson'),
  2473. * 'joins' => array(
  2474. * array(
  2475. * 'alias' => 'Thought',
  2476. * 'table' => 'thoughts',
  2477. * 'type' => 'LEFT',
  2478. * 'conditions' => '`Thought`.`person_id` = `Person`.`id`'
  2479. * )
  2480. * )
  2481. * ));
  2482. * }}}
  2483. *
  2484. * ### Disabling callbacks
  2485. *
  2486. * The `callbacks` key allows you to disable or specify the callbacks that should be run. To
  2487. * disable beforeFind & afterFind callbacks set `'callbacks' => false` in your options. You can
  2488. * also set the callbacks option to 'before' or 'after' to enable only the specified callback.
  2489. *
  2490. * ### Adding new find types
  2491. *
  2492. * Behaviors and find types can also define custom finder keys which are passed into find().
  2493. * See the documentation for custom find types
  2494. * (http://book.cakephp.org/2.0/en/models/retrieving-your-data.html#creating-custom-find-types)
  2495. * for how to implement custom find types.
  2496. *
  2497. * Specifying 'fields' for notation 'list':
  2498. *
  2499. * - If no fields are specified, then 'id' is used for key and 'model->displayField' is used for value.
  2500. * - If a single field is specified, 'id' is used for key and specified field is used for value.
  2501. * - If three fields are specified, they are used (in order) for key, value and group.
  2502. * - Otherwise, first and second fields are used for key and value.
  2503. *
  2504. * Note: find(list) + database views have issues with MySQL 5.0. Try upgrading to MySQL 5.1 if you
  2505. * have issues with database views.
  2506. *
  2507. * Note: find(count) has its own return values.
  2508. *
  2509. * @param string $type Type of find operation (all / first / count / neighbors / list / threaded)
  2510. * @param array $query Option fields (conditions / fields / joins / limit / offset / order / page / group / callbacks)
  2511. * @return array Array of records, or Null on failure.
  2512. * @link http://book.cakephp.org/2.0/en/models/retrieving-your-data.html
  2513. */
  2514. public function find($type = 'first', $query = array()) {
  2515. $this->findQueryType = $type;
  2516. $this->id = $this->getID();
  2517. $query = $this->buildQuery($type, $query);
  2518. if ($query === null) {
  2519. return null;
  2520. }
  2521. return $this->_readDataSource($type, $query);
  2522. }
  2523. /**
  2524. * Read from the datasource
  2525. *
  2526. * Model::_readDataSource() is used by all find() calls to read from the data source and can be overloaded to allow
  2527. * caching of datasource calls.
  2528. *
  2529. * {{{
  2530. * protected function _readDataSource($type, $query) {
  2531. * $cacheName = md5(json_encode($query));
  2532. * $cache = Cache::read($cacheName, 'cache-config-name');
  2533. * if ($cache !== false) {
  2534. * return $cache;
  2535. * }
  2536. *
  2537. * $results = parent::_readDataSource($type, $query);
  2538. * Cache::write($cacheName, $results, 'cache-config-name');
  2539. * return $results;
  2540. * }
  2541. * }}}
  2542. *
  2543. * @param string $type Type of find operation (all / first / count / neighbors / list / threaded)
  2544. * @param array $query Option fields (conditions / fields / joins / limit / offset / order / page / group / callbacks)
  2545. * @return array
  2546. */
  2547. protected function _readDataSource($type, $query) {
  2548. $results = $this->getDataSource()->read($this, $query);
  2549. $this->resetAssociations();
  2550. if ($query['callbacks'] === true || $query['callbacks'] === 'after') {
  2551. $results = $this->_filterResults($results);
  2552. }
  2553. $this->findQueryType = null;
  2554. if ($this->findMethods[$type] === true) {
  2555. return $this->{'_find' . ucfirst($type)}('after', $query, $results);
  2556. }
  2557. }
  2558. /**
  2559. * Builds the query array that is used by the data source to generate the query to fetch the data.
  2560. *
  2561. * @param string $type Type of find operation (all / first / count / neighbors / list / threaded)
  2562. * @param array $query Option fields (conditions / fields / joins / limit / offset / order / page / group / callbacks)
  2563. * @return array Query array or null if it could not be build for some reasons
  2564. * @see Model::find()
  2565. */
  2566. public function buildQuery($type = 'first', $query = array()) {
  2567. $query = array_merge(
  2568. array(
  2569. 'conditions' => null, 'fields' => null, 'joins' => array(), 'limit' => null,
  2570. 'offset' => null, 'order' => null, 'page' => 1, 'group' => null, 'callbacks' => true,
  2571. ),
  2572. (array)$query
  2573. );
  2574. if ($this->findMethods[$type] === true) {
  2575. $query = $this->{'_find' . ucfirst($type)}('before', $query);
  2576. }
  2577. if (!is_numeric($query['page']) || intval($query['page']) < 1) {
  2578. $query['page'] = 1;
  2579. }
  2580. if ($query['page'] > 1 && !empty($query['limit'])) {
  2581. $query['offset'] = ($query['page'] - 1) * $query['limit'];
  2582. }
  2583. if ($query['order'] === null && $this->order !== null) {
  2584. $query['order'] = $this->order;
  2585. }
  2586. $query['order'] = array($query['order']);
  2587. if ($query['callbacks'] === true || $query['callbacks'] === 'before') {
  2588. $event = new CakeEvent('Model.beforeFind', $this, array($query));
  2589. list($event->break, $event->breakOn, $event->modParams) = array(true, array(false, null), 0);
  2590. $this->getEventManager()->dispatch($event);
  2591. if ($event->isStopped()) {
  2592. return null;
  2593. }
  2594. $query = $event->result === true ? $event->data[0] : $event->result;
  2595. }
  2596. return $query;
  2597. }
  2598. /**
  2599. * Handles the before/after filter logic for find('all') operations. Only called by Model::find().
  2600. *
  2601. * @param string $state Either "before" or "after"
  2602. * @param array $query Query.
  2603. * @param array $results Results.
  2604. * @return array
  2605. * @see Model::find()
  2606. */
  2607. protected function _findAll($state, $query, $results = array()) {
  2608. if ($state === 'before') {
  2609. return $query;
  2610. }
  2611. return $results;
  2612. }
  2613. /**
  2614. * Handles the before/after filter logic for find('first') operations. Only called by Model::find().
  2615. *
  2616. * @param string $state Either "before" or "after"
  2617. * @param array $query Query.
  2618. * @param array $results Results.
  2619. * @return array
  2620. * @see Model::find()
  2621. */
  2622. protected function _findFirst($state, $query, $results = array()) {
  2623. if ($state === 'before') {
  2624. $query['limit'] = 1;
  2625. return $query;
  2626. }
  2627. if (empty($results[0])) {
  2628. return array();
  2629. }
  2630. return $results[0];
  2631. }
  2632. /**
  2633. * Handles the before/after filter logic for find('count') operations. Only called by Model::find().
  2634. *
  2635. * @param string $state Either "before" or "after"
  2636. * @param array $query Query.
  2637. * @param array $results Results.
  2638. * @return int The number of records found, or false
  2639. * @see Model::find()
  2640. */
  2641. protected function _findCount($state, $query, $results = array()) {
  2642. if ($state === 'before') {
  2643. if (!empty($query['type']) && isset($this->findMethods[$query['type']]) && $query['type'] !== 'count') {
  2644. $query['operation'] = 'count';
  2645. $query = $this->{'_find' . ucfirst($query['type'])}('before', $query);
  2646. }
  2647. $db = $this->getDataSource();
  2648. $query['order'] = false;
  2649. if (!method_exists($db, 'calculate')) {
  2650. return $query;
  2651. }
  2652. if (!empty($query['fields']) && is_array($query['fields'])) {
  2653. if (!preg_match('/^count/i', current($query['fields']))) {
  2654. unset($query['fields']);
  2655. }
  2656. }
  2657. if (empty($query['fields'])) {
  2658. $query['fields'] = $db->calculate($this, 'count');
  2659. } elseif (method_exists($db, 'expression') && is_string($query['fields']) && !preg_match('/count/i', $query['fields'])) {
  2660. $query['fields'] = $db->calculate($this, 'count', array(
  2661. $db->expression($query['fields']), 'count'
  2662. ));
  2663. }
  2664. return $query;
  2665. }
  2666. foreach (array(0, $this->alias) as $key) {
  2667. if (isset($results[0][$key]['count'])) {
  2668. if ($query['group']) {
  2669. return count($results);
  2670. }
  2671. return intval($results[0][$key]['count']);
  2672. }
  2673. }
  2674. return false;
  2675. }
  2676. /**
  2677. * Handles the before/after filter logic for find('list') operations. Only called by Model::find().
  2678. *
  2679. * @param string $state Either "before" or "after"
  2680. * @param array $query Query.
  2681. * @param array $results Results.
  2682. * @return array Key/value pairs of primary keys/display field values of all records found
  2683. * @see Model::find()
  2684. */
  2685. protected function _findList($state, $query, $results = array()) {
  2686. if ($state === 'before') {
  2687. if (empty($query['fields'])) {
  2688. $query['fields'] = array("{$this->alias}.{$this->primaryKey}", "{$this->alias}.{$this->displayField}");
  2689. $list = array("{n}.{$this->alias}.{$this->primaryKey}", "{n}.{$this->alias}.{$this->displayField}", null);
  2690. } else {
  2691. if (!is_array($query['fields'])) {
  2692. $query['fields'] = String::tokenize($query['fields']);
  2693. }
  2694. if (count($query['fields']) === 1) {
  2695. if (strpos($query['fields'][0], '.') === false) {
  2696. $query['fields'][0] = $this->alias . '.' . $query['fields'][0];
  2697. }
  2698. $list = array("{n}.{$this->alias}.{$this->primaryKey}", '{n}.' . $query['fields'][0], null);
  2699. $query['fields'] = array("{$this->alias}.{$this->primaryKey}", $query['fields'][0]);
  2700. } elseif (count($query['fields']) === 3) {
  2701. for ($i = 0; $i < 3; $i++) {
  2702. if (strpos($query['fields'][$i], '.') === false) {
  2703. $query['fields'][$i] = $this->alias . '.' . $query['fields'][$i];
  2704. }
  2705. }
  2706. $list = array('{n}.' . $query['fields'][0], '{n}.' . $query['fields'][1], '{n}.' . $query['fields'][2]);
  2707. } else {
  2708. for ($i = 0; $i < 2; $i++) {
  2709. if (strpos($query['fields'][$i], '.') === false) {
  2710. $query['fields'][$i] = $this->alias . '.' . $query['fields'][$i];
  2711. }
  2712. }
  2713. $list = array('{n}.' . $query['fields'][0], '{n}.' . $query['fields'][1], null);
  2714. }
  2715. }
  2716. if (!isset($query['recursive']) || $query['recursive'] === null) {
  2717. $query['recursive'] = -1;
  2718. }
  2719. list($query['list']['keyPath'], $query['list']['valuePath'], $query['list']['groupPath']) = $list;
  2720. return $query;
  2721. }
  2722. if (empty($results)) {
  2723. return array();
  2724. }
  2725. return Hash::combine($results, $query['list']['keyPath'], $query['list']['valuePath'], $query['list']['groupPath']);
  2726. }
  2727. /**
  2728. * Detects the previous field's value, then uses logic to find the 'wrapping'
  2729. * rows and return them.
  2730. *
  2731. * @param string $state Either "before" or "after"
  2732. * @param array $query Query.
  2733. * @param array $results Results.
  2734. * @return array
  2735. */
  2736. protected function _findNeighbors($state, $query, $results = array()) {
  2737. extract($query);
  2738. if ($state === 'before') {
  2739. $conditions = (array)$conditions;
  2740. if (isset($field) && isset($value)) {
  2741. if (strpos($field, '.') === false) {
  2742. $field = $this->alias . '.' . $field;
  2743. }
  2744. } else {
  2745. $field = $this->alias . '.' . $this->primaryKey;
  2746. $value = $this->id;
  2747. }
  2748. $query['conditions'] = array_merge($conditions, array($field . ' <' => $value));
  2749. $query['order'] = $field . ' DESC';
  2750. $query['limit'] = 1;
  2751. $query['field'] = $field;
  2752. $query['value'] = $value;
  2753. return $query;
  2754. }
  2755. unset($query['conditions'][$field . ' <']);
  2756. $return = array();
  2757. if (isset($results[0])) {
  2758. $prevVal = Hash::get($results[0], $field);
  2759. $query['conditions'][$field . ' >='] = $prevVal;
  2760. $query['conditions'][$field . ' !='] = $value;
  2761. $query['limit'] = 2;
  2762. } else {
  2763. $return['prev'] = null;
  2764. $query['conditions'][$field . ' >'] = $value;
  2765. $query['limit'] = 1;
  2766. }
  2767. $query['order'] = $field . ' ASC';
  2768. $neighbors = $this->find('all', $query);
  2769. if (!array_key_exists('prev', $return)) {
  2770. $return['prev'] = isset($neighbors[0]) ? $neighbors[0] : null;
  2771. }
  2772. if (count($neighbors) === 2) {
  2773. $return['next'] = $neighbors[1];
  2774. } elseif (count($neighbors) === 1 && !$return['prev']) {
  2775. $return['next'] = $neighbors[0];
  2776. } else {
  2777. $return['next'] = null;
  2778. }
  2779. return $return;
  2780. }
  2781. /**
  2782. * In the event of ambiguous results returned (multiple top level results, with different parent_ids)
  2783. * top level results with different parent_ids to the first result will be dropped
  2784. *
  2785. * @param string $state Either "before" or "after".
  2786. * @param array $query Query.
  2787. * @param array $results Results.
  2788. * @return array Threaded results
  2789. */
  2790. protected function _findThreaded($state, $query, $results = array()) {
  2791. if ($state === 'before') {
  2792. return $query;
  2793. }
  2794. $parent = 'parent_id';
  2795. if (isset($query['parent'])) {
  2796. $parent = $query['parent'];
  2797. }
  2798. return Hash::nest($results, array(
  2799. 'idPath' => '{n}.' . $this->alias . '.' . $this->primaryKey,
  2800. 'parentPath' => '{n}.' . $this->alias . '.' . $parent
  2801. ));
  2802. }
  2803. /**
  2804. * Passes query results through model and behavior afterFind() methods.
  2805. *
  2806. * @param array $results Results to filter
  2807. * @param bool $primary If this is the primary model results (results from model where the find operation was performed)
  2808. * @return array Set of filtered results
  2809. */
  2810. protected function _filterResults($results, $primary = true) {
  2811. $event = new CakeEvent('Model.afterFind', $this, array($results, $primary));
  2812. $event->modParams = 0;
  2813. $this->getEventManager()->dispatch($event);
  2814. return $event->result;
  2815. }
  2816. /**
  2817. * This resets the association arrays for the model back
  2818. * to those originally defined in the model. Normally called at the end
  2819. * of each call to Model::find()
  2820. *
  2821. * @return bool Success
  2822. */
  2823. public function resetAssociations() {
  2824. if (!empty($this->__backAssociation)) {
  2825. foreach ($this->_associations as $type) {
  2826. if (isset($this->__backAssociation[$type])) {
  2827. $this->{$type} = $this->__backAssociation[$type];
  2828. }
  2829. }
  2830. $this->__backAssociation = array();
  2831. }
  2832. foreach ($this->_associations as $type) {
  2833. foreach ($this->{$type} as $key => $name) {
  2834. if (property_exists($this, $key) && !empty($this->{$key}->__backAssociation)) {
  2835. $this->{$key}->resetAssociations();
  2836. }
  2837. }
  2838. }
  2839. $this->__backAssociation = array();
  2840. return true;
  2841. }
  2842. /**
  2843. * Returns false if any fields passed match any (by default, all if $or = false) of their matching values.
  2844. *
  2845. * @param array $fields Field/value pairs to search (if no values specified, they are pulled from $this->data)
  2846. * @param bool $or If false, all fields specified must match in order for a false return value
  2847. * @return bool False if any records matching any fields are found
  2848. */
  2849. public function isUnique($fields, $or = true) {
  2850. if (!is_array($fields)) {
  2851. $fields = func_get_args();
  2852. if (is_bool($fields[count($fields) - 1])) {
  2853. $or = $fields[count($fields) - 1];
  2854. unset($fields[count($fields) - 1]);
  2855. }
  2856. }
  2857. foreach ($fields as $field => $value) {
  2858. if (is_numeric($field)) {
  2859. unset($fields[$field]);
  2860. $field = $value;
  2861. $value = null;
  2862. if (isset($this->data[$this->alias][$field])) {
  2863. $value = $this->data[$this->alias][$field];
  2864. }
  2865. }
  2866. if (strpos($field, '.') === false) {
  2867. unset($fields[$field]);
  2868. $fields[$this->alias . '.' . $field] = $value;
  2869. }
  2870. }
  2871. if ($or) {
  2872. $fields = array('or' => $fields);
  2873. }
  2874. if (!empty($this->id)) {
  2875. $fields[$this->alias . '.' . $this->primaryKey . ' !='] = $this->id;
  2876. }
  2877. return !$this->find('count', array('conditions' => $fields, 'recursive' => -1));
  2878. }
  2879. /**
  2880. * Returns a resultset for a given SQL statement. Custom SQL queries should be performed with this method.
  2881. *
  2882. * The method can options 2nd and 3rd parameters.
  2883. *
  2884. * - 2nd param: Either a boolean to control query caching or an array of parameters
  2885. * for use with prepared statement placeholders.
  2886. * - 3rd param: If 2nd argument is provided, a boolean flag for enabling/disabled
  2887. * query caching.
  2888. *
  2889. * @param string $sql SQL statement
  2890. * @return mixed Resultset array or boolean indicating success / failure depending on the query executed
  2891. * @link http://book.cakephp.org/2.0/en/models/retrieving-your-data.html#model-query
  2892. */
  2893. public function query($sql) {
  2894. $params = func_get_args();
  2895. $db = $this->getDataSource();
  2896. return call_user_func_array(array(&$db, 'query'), $params);
  2897. }
  2898. /**
  2899. * Returns true if all fields pass validation. Will validate hasAndBelongsToMany associations
  2900. * that use the 'with' key as well. Since _saveMulti is incapable of exiting a save operation.
  2901. *
  2902. * Will validate the currently set data. Use Model::set() or Model::create() to set the active data.
  2903. *
  2904. * @param array $options An optional array of custom options to be made available in the beforeValidate callback
  2905. * @return bool True if there are no errors
  2906. */
  2907. public function validates($options = array()) {
  2908. return $this->validator()->validates($options);
  2909. }
  2910. /**
  2911. * Returns an array of fields that have failed the validation of the current model.
  2912. *
  2913. * Additionally it populates the validationErrors property of the model with the same array.
  2914. *
  2915. * @param array|string $options An optional array of custom options to be made available in the beforeValidate callback
  2916. * @return array Array of invalid fields and their error messages
  2917. * @see Model::validates()
  2918. */
  2919. public function invalidFields($options = array()) {
  2920. return $this->validator()->errors($options);
  2921. }
  2922. /**
  2923. * Marks a field as invalid, optionally setting the name of validation
  2924. * rule (in case of multiple validation for field) that was broken.
  2925. *
  2926. * @param string $field The name of the field to invalidate
  2927. * @param mixed $value Name of validation rule that was not failed, or validation message to
  2928. * be returned. If no validation key is provided, defaults to true.
  2929. * @return void
  2930. */
  2931. public function invalidate($field, $value = true) {
  2932. $this->validator()->invalidate($field, $value);
  2933. }
  2934. /**
  2935. * Returns true if given field name is a foreign key in this model.
  2936. *
  2937. * @param string $field Returns true if the input string ends in "_id"
  2938. * @return bool True if the field is a foreign key listed in the belongsTo array.
  2939. */
  2940. public function isForeignKey($field) {
  2941. $foreignKeys = array();
  2942. if (!empty($this->belongsTo)) {
  2943. foreach ($this->belongsTo as $data) {
  2944. $foreignKeys[] = $data['foreignKey'];
  2945. }
  2946. }
  2947. return in_array($field, $foreignKeys);
  2948. }
  2949. /**
  2950. * Escapes the field name and prepends the model name. Escaping is done according to the
  2951. * current database driver's rules.
  2952. *
  2953. * @param string $field Field to escape (e.g: id)
  2954. * @param string $alias Alias for the model (e.g: Post)
  2955. * @return string The name of the escaped field for this Model (i.e. id becomes `Post`.`id`).
  2956. */
  2957. public function escapeField($field = null, $alias = null) {
  2958. if (empty($alias)) {
  2959. $alias = $this->alias;
  2960. }
  2961. if (empty($field)) {
  2962. $field = $this->primaryKey;
  2963. }
  2964. $db = $this->getDataSource();
  2965. if (strpos($field, $db->name($alias) . '.') === 0) {
  2966. return $field;
  2967. }
  2968. return $db->name($alias . '.' . $field);
  2969. }
  2970. /**
  2971. * Returns the current record's ID
  2972. *
  2973. * @param int $list Index on which the composed ID is located
  2974. * @return mixed The ID of the current record, false if no ID
  2975. */
  2976. public function getID($list = 0) {
  2977. if (empty($this->id) || (is_array($this->id) && isset($this->id[0]) && empty($this->id[0]))) {
  2978. return false;
  2979. }
  2980. if (!is_array($this->id)) {
  2981. return $this->id;
  2982. }
  2983. if (isset($this->id[$list]) && !empty($this->id[$list])) {
  2984. return $this->id[$list];
  2985. }
  2986. if (isset($this->id[$list])) {
  2987. return false;
  2988. }
  2989. return current($this->id);
  2990. }
  2991. /**
  2992. * Returns the ID of the last record this model inserted.
  2993. *
  2994. * @return mixed Last inserted ID
  2995. */
  2996. public function getLastInsertID() {
  2997. return $this->getInsertID();
  2998. }
  2999. /**
  3000. * Returns the ID of the last record this model inserted.
  3001. *
  3002. * @return mixed Last inserted ID
  3003. */
  3004. public function getInsertID() {
  3005. return $this->_insertID;
  3006. }
  3007. /**
  3008. * Sets the ID of the last record this model inserted
  3009. *
  3010. * @param int|string $id Last inserted ID
  3011. * @return void
  3012. */
  3013. public function setInsertID($id) {
  3014. $this->_insertID = $id;
  3015. }
  3016. /**
  3017. * Returns the number of rows returned from the last query.
  3018. *
  3019. * @return int Number of rows
  3020. */
  3021. public function getNumRows() {
  3022. return $this->getDataSource()->lastNumRows();
  3023. }
  3024. /**
  3025. * Returns the number of rows affected by the last query.
  3026. *
  3027. * @return int Number of rows
  3028. */
  3029. public function getAffectedRows() {
  3030. return $this->getDataSource()->lastAffected();
  3031. }
  3032. /**
  3033. * Sets the DataSource to which this model is bound.
  3034. *
  3035. * @param string $dataSource The name of the DataSource, as defined in app/Config/database.php
  3036. * @return void
  3037. * @throws MissingConnectionException
  3038. */
  3039. public function setDataSource($dataSource = null) {
  3040. $oldConfig = $this->useDbConfig;
  3041. if ($dataSource) {
  3042. $this->useDbConfig = $dataSource;
  3043. }
  3044. $db = ConnectionManager::getDataSource($this->useDbConfig);
  3045. if (!empty($oldConfig) && isset($db->config['prefix'])) {
  3046. $oldDb = ConnectionManager::getDataSource($oldConfig);
  3047. if (!isset($this->tablePrefix) || (!isset($oldDb->config['prefix']) || $this->tablePrefix === $oldDb->config['prefix'])) {
  3048. $this->tablePrefix = $db->config['prefix'];
  3049. }
  3050. } elseif (isset($db->config['prefix'])) {
  3051. $this->tablePrefix = $db->config['prefix'];
  3052. }
  3053. $schema = $db->getSchemaName();
  3054. $defaultProperties = get_class_vars(get_class($this));
  3055. if (isset($defaultProperties['schemaName'])) {
  3056. $schema = $defaultProperties['schemaName'];
  3057. }
  3058. $this->schemaName = $schema;
  3059. }
  3060. /**
  3061. * Gets the DataSource to which this model is bound.
  3062. *
  3063. * @return DataSource A DataSource object
  3064. */
  3065. public function getDataSource() {
  3066. if (!$this->_sourceConfigured && $this->useTable !== false) {
  3067. $this->_sourceConfigured = true;
  3068. $this->setSource($this->useTable);
  3069. }
  3070. return ConnectionManager::getDataSource($this->useDbConfig);
  3071. }
  3072. /**
  3073. * Get associations
  3074. *
  3075. * @return array
  3076. */
  3077. public function associations() {
  3078. return $this->_associations;
  3079. }
  3080. /**
  3081. * Gets all the models with which this model is associated.
  3082. *
  3083. * @param string $type Only result associations of this type
  3084. * @return array Associations
  3085. */
  3086. public function getAssociated($type = null) {
  3087. if (!$type) {
  3088. $associated = array();
  3089. foreach ($this->_associations as $assoc) {
  3090. if (!empty($this->{$assoc})) {
  3091. $models = array_keys($this->{$assoc});
  3092. foreach ($models as $m) {
  3093. $associated[$m] = $assoc;
  3094. }
  3095. }
  3096. }
  3097. return $associated;
  3098. }
  3099. if (in_array($type, $this->_associations)) {
  3100. if (empty($this->{$type})) {
  3101. return array();
  3102. }
  3103. return array_keys($this->{$type});
  3104. }
  3105. $assoc = array_merge(
  3106. $this->hasOne,
  3107. $this->hasMany,
  3108. $this->belongsTo,
  3109. $this->hasAndBelongsToMany
  3110. );
  3111. if (array_key_exists($type, $assoc)) {
  3112. foreach ($this->_associations as $a) {
  3113. if (isset($this->{$a}[$type])) {
  3114. $assoc[$type]['association'] = $a;
  3115. break;
  3116. }
  3117. }
  3118. return $assoc[$type];
  3119. }
  3120. return null;
  3121. }
  3122. /**
  3123. * Gets the name and fields to be used by a join model. This allows specifying join fields
  3124. * in the association definition.
  3125. *
  3126. * @param string|array $assoc The model to be joined
  3127. * @param array $keys Any join keys which must be merged with the keys queried
  3128. * @return array
  3129. */
  3130. public function joinModel($assoc, $keys = array()) {
  3131. if (is_string($assoc)) {
  3132. list(, $assoc) = pluginSplit($assoc);
  3133. return array($assoc, array_keys($this->{$assoc}->schema()));
  3134. }
  3135. if (is_array($assoc)) {
  3136. $with = key($assoc);
  3137. return array($with, array_unique(array_merge($assoc[$with], $keys)));
  3138. }
  3139. trigger_error(
  3140. __d('cake_dev', 'Invalid join model settings in %s. The association parameter has the wrong type, expecting a string or array, but was passed type: %s', $this->alias, gettype($assoc)),
  3141. E_USER_WARNING
  3142. );
  3143. }
  3144. /**
  3145. * Called before each find operation. Return false if you want to halt the find
  3146. * call, otherwise return the (modified) query data.
  3147. *
  3148. * @param array $query Data used to execute this query, i.e. conditions, order, etc.
  3149. * @return mixed true if the operation should continue, false if it should abort; or, modified
  3150. * $query to continue with new $query
  3151. * @link http://book.cakephp.org/2.0/en/models/callback-methods.html#beforefind
  3152. */
  3153. public function beforeFind($query) {
  3154. return true;
  3155. }
  3156. /**
  3157. * Called after each find operation. Can be used to modify any results returned by find().
  3158. * Return value should be the (modified) results.
  3159. *
  3160. * @param mixed $results The results of the find operation
  3161. * @param bool $primary Whether this model is being queried directly (vs. being queried as an association)
  3162. * @return mixed Result of the find operation
  3163. * @link http://book.cakephp.org/2.0/en/models/callback-methods.html#afterfind
  3164. */
  3165. public function afterFind($results, $primary = false) {
  3166. return $results;
  3167. }
  3168. /**
  3169. * Called before each save operation, after validation. Return a non-true result
  3170. * to halt the save.
  3171. *
  3172. * @param array $options Options passed from Model::save().
  3173. * @return bool True if the operation should continue, false if it should abort
  3174. * @link http://book.cakephp.org/2.0/en/models/callback-methods.html#beforesave
  3175. * @see Model::save()
  3176. */
  3177. public function beforeSave($options = array()) {
  3178. return true;
  3179. }
  3180. /**
  3181. * Called after each successful save operation.
  3182. *
  3183. * @param bool $created True if this save created a new record
  3184. * @param array $options Options passed from Model::save().
  3185. * @return void
  3186. * @link http://book.cakephp.org/2.0/en/models/callback-methods.html#aftersave
  3187. * @see Model::save()
  3188. */
  3189. public function afterSave($created, $options = array()) {
  3190. }
  3191. /**
  3192. * Called before every deletion operation.
  3193. *
  3194. * @param bool $cascade If true records that depend on this record will also be deleted
  3195. * @return bool True if the operation should continue, false if it should abort
  3196. * @link http://book.cakephp.org/2.0/en/models/callback-methods.html#beforedelete
  3197. */
  3198. public function beforeDelete($cascade = true) {
  3199. return true;
  3200. }
  3201. /**
  3202. * Called after every deletion operation.
  3203. *
  3204. * @return void
  3205. * @link http://book.cakephp.org/2.0/en/models/callback-methods.html#afterdelete
  3206. */
  3207. public function afterDelete() {
  3208. }
  3209. /**
  3210. * Called during validation operations, before validation. Please note that custom
  3211. * validation rules can be defined in $validate.
  3212. *
  3213. * @param array $options Options passed from Model::save().
  3214. * @return bool True if validate operation should continue, false to abort
  3215. * @link http://book.cakephp.org/2.0/en/models/callback-methods.html#beforevalidate
  3216. * @see Model::save()
  3217. */
  3218. public function beforeValidate($options = array()) {
  3219. return true;
  3220. }
  3221. /**
  3222. * Called after data has been checked for errors
  3223. *
  3224. * @return void
  3225. */
  3226. public function afterValidate() {
  3227. }
  3228. /**
  3229. * Called when a DataSource-level error occurs.
  3230. *
  3231. * @return void
  3232. * @link http://book.cakephp.org/2.0/en/models/callback-methods.html#onerror
  3233. */
  3234. public function onError() {
  3235. }
  3236. /**
  3237. * Clears cache for this model.
  3238. *
  3239. * @param string $type If null this deletes cached views if Cache.check is true
  3240. * Will be used to allow deleting query cache also
  3241. * @return mixed True on delete, null otherwise
  3242. */
  3243. protected function _clearCache($type = null) {
  3244. if ($type !== null || Configure::read('Cache.check') !== true) {
  3245. return;
  3246. }
  3247. $pluralized = Inflector::pluralize($this->alias);
  3248. $assoc = array(
  3249. strtolower($pluralized),
  3250. Inflector::underscore($pluralized)
  3251. );
  3252. foreach ($this->_associations as $association) {
  3253. foreach ($this->{$association} as $className) {
  3254. $pluralizedAssociation = Inflector::pluralize($className['className']);
  3255. if (!in_array(strtolower($pluralizedAssociation), $assoc)) {
  3256. $assoc = array_merge($assoc, array(
  3257. strtolower($pluralizedAssociation),
  3258. Inflector::underscore($pluralizedAssociation)
  3259. ));
  3260. }
  3261. }
  3262. }
  3263. clearCache(array_unique($assoc));
  3264. return true;
  3265. }
  3266. /**
  3267. * Returns an instance of a model validator for this class
  3268. *
  3269. * @param ModelValidator $instance Model validator instance.
  3270. * If null a new ModelValidator instance will be made using current model object
  3271. * @return ModelValidator
  3272. */
  3273. public function validator(ModelValidator $instance = null) {
  3274. if ($instance) {
  3275. $this->_validator = $instance;
  3276. } elseif (!$this->_validator) {
  3277. $this->_validator = new ModelValidator($this);
  3278. }
  3279. return $this->_validator;
  3280. }
  3281. }