Model.php 108 KB

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