Model.php 111 KB

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