Model.php 108 KB

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