Model.php 110 KB

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