Model.php 109 KB

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