Model.php 112 KB

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