Model.php 109 KB

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