| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683 |
- <?php
- App::uses('Model', 'Model');
- App::uses('Utility', 'Tools.Utility');
- /**
- * Model enhancements for Cake2
- *
- * @author Mark Scherer
- * @license MIT
- * 2012-02-27 ms
- */
- class MyModel extends Model {
- public $recursive = -1;
- public $actsAs = array('Containable');
- /** Specific Stuff **/
- public function __construct($id = false, $table = null, $ds = null) {
- parent::__construct($id, $table, $ds);
- # enable caching
- if (!Configure::read('Cache.disable') && Cache::config('sql') === false) {
- if (!file_exists(CACHE . 'sql')) {
- mkdir(CACHE . 'sql', CHOWN_PUBLIC);
- }
- Cache::config('sql', array(
- 'engine' => 'File',
- 'serialize' => true,
- 'prefix' => '',
- 'path' => CACHE .'sql'. DS,
- 'duration' => '+1 day'
- ));
- }
- # get a notice if there is an AppModel instances instead of real Models (in those cases usually a dev error!)
- if (defined('HTTP_HOST') && HTTP_HOST && !is_a($this, $this->name) && $this->displayField !== 'id' && $this->useDbConfig !== 'test' && !Configure::read('Core.disableModelInstanceNotice')) {
- trigger_error('AppModel instance! Expected: ' . $this->name);
- }
- }
- /**
- * Deconstructs a complex data type (array or object) into a single field value.
- * BUGFIXED VERSION - autodetects type and allows manual override
- *
- * @param string $field The name of the field to be deconstructed
- * @param array|object $data An array or object to be deconstructed into a field
- * @return mixed The resulting data that should be assigned to a field
- */
- public function deconstruct($field, $data, $type = null) {
- if (!is_array($data)) {
- return $data;
- }
- if ($type === null) {
- $type = $this->getColumnType($field);
- }
- if ($type === null) {
- //try to autodetect
- if (isset($data['day']) || isset($data['month']) || isset($data['year'])) {
- $type = 'date';
- }
- if (isset($data['hour']) || isset($data['min']) || isset($data['sec'])) {
- $type .= 'time';
- }
- }
- if (in_array($type, array('datetime', 'timestamp', 'date', 'time'))) {
- $useNewDate = (isset($data['year']) || isset($data['month']) ||
- isset($data['day']) || isset($data['hour']) || isset($data['minute']));
- $dateFields = array('Y' => 'year', 'm' => 'month', 'd' => 'day', 'H' => 'hour', 'i' => 'min', 's' => 'sec');
- $timeFields = array('H' => 'hour', 'i' => 'min', 's' => 'sec');
- $date = array();
- if (isset($data['meridian']) && empty($data['meridian'])) {
- return null;
- }
- if (
- isset($data['hour']) &&
- isset($data['meridian']) &&
- !empty($data['hour']) &&
- $data['hour'] != 12 &&
- 'pm' == $data['meridian']
- ) {
- $data['hour'] = $data['hour'] + 12;
- }
- if (isset($data['hour']) && isset($data['meridian']) && $data['hour'] == 12 && 'am' == $data['meridian']) {
- $data['hour'] = '00';
- }
- if ($type === 'time') {
- foreach ($timeFields as $key => $val) {
- if (!isset($data[$val]) || $data[$val] === '0' || $data[$val] === '00') {
- $data[$val] = '00';
- } elseif ($data[$val] !== '') {
- $data[$val] = sprintf('%02d', $data[$val]);
- }
- if (!empty($data[$val])) {
- $date[$key] = $data[$val];
- } else {
- return null;
- }
- }
- }
- if ($type === 'datetime' || $type === 'timestamp' || $type === 'date') {
- foreach ($dateFields as $key => $val) {
- if ($val === 'hour' || $val === 'min' || $val === 'sec') {
- if (!isset($data[$val]) || $data[$val] === '0' || $data[$val] === '00') {
- $data[$val] = '00';
- } else {
- $data[$val] = sprintf('%02d', $data[$val]);
- }
- }
- if (!isset($data[$val]) || isset($data[$val]) && (empty($data[$val]) || $data[$val][0] === '-')) {
- return null;
- }
- if (isset($data[$val]) && !empty($data[$val])) {
- $date[$key] = $data[$val];
- }
- }
- }
- if ($useNewDate && !empty($date)) {
- $format = $this->getDataSource()->columns[$type]['format'];
- foreach (array('m', 'd', 'H', 'i', 's') as $index) {
- if (isset($date[$index])) {
- $date[$index] = sprintf('%02d', $date[$index]);
- }
- }
- return str_replace(array_keys($date), array_values($date), $format);
- }
- }
- return $data;
- }
- /**
- * The main method for any enumeration, should be called statically
- * Now also supports reordering/filtering
- *
- * @link http://www.dereuromark.de/2010/06/24/static-enums-or-semihardcoded-attributes/
- * @param string $value or array $keys or NULL for complete array result
- * @param array $options (actual data)
- * @return mixed string/array
- * static enums
- * 2009-11-05 ms
- */
- public static function enum($value, $options, $default = null) {
- if ($value !== null && !is_array($value)) {
- if (array_key_exists($value, $options)) {
- return $options[$value];
- }
- return $default;
- } elseif ($value !== null) {
- $newOptions = array();
- foreach ($value as $v) {
- $newOptions[$v] = $options[$v];
- }
- return $newOptions;
- }
- return $options;
- }
- /**
- * Catch database errors before it’s too late
- * //TODO: testing
- * 2010-11-04 ms
- */
- public function onError() {
- $err = $this->lastError();
- if (!empty($err)) {
- $this->log($err, 'sql_error');
- } else {
- $this->log('unknown error', 'sql_error');
- }
- if (!empty($this->data)) {
- $data = $this->data;
- } elseif ($this->id) {
- $data = 'id ' . $this->id;
- } else {
- $data = 'no data';
- }
- $data .= ' (' . env('REDIRECT_URL') . ')';
- $this->log($data, 'sql_error');
- }
- /**
- * @return string Error message with error number
- * 2010-11-06 ms
- */
- public function lastError() {
- $db = $this->getDataSource();
- return $db->lastError();
- }
- /**
- * combine virtual fields with fields values of find()
- * USAGE:
- * $this->Model->find('all', array('fields' => $this->Model->virtualFields('full_name')));
- * Also adds the field to the virtualFields array of the model (for correct result)
- * TODO: adding of fields only temperory!
- * @param array $virtualFields to include
- * 2011-10-13 ms
- */
- public function virtualFields($fields = array()) {
- $res = array();
- foreach ((array)$fields as $field => $sql) {
- if (is_int($field)) {
- $field = $sql;
- $sql = null;
- }
- $plugin = $model = null;
- if (($pos = strrpos($field, '.')) !== false) {
- $model = substr($field, 0, $pos);
- $field = substr($field, $pos+1);
- if (($pos = strrpos($model, '.')) !== false) {
- list($plugin, $model) = pluginSplit($model);
- }
- }
- if (empty($model)) {
- $model = $this->alias;
- if ($sql === null) {
- $sql = $this->virtualFields[$field];
- } else {
- $this->virtualFields[$field] = $sql;
- }
- } else {
- if (!isset($this->$model)) {
- $fullModelName = ($plugin ? $plugin.'.' : '') . $model;
- $this->$model = ClassRegistry::init($fullModelName);
- }
- if ($sql === null) {
- $sql = $this->$model->virtualFields[$field];
- } else {
- $this->$model->virtualFields[$field] = $sql;
- }
- }
- $res[] = $sql.' AS '.$model.'__'.$field;
- }
- return $res;
- }
- /**
- * HIGHLY EXPERIMENTAL
- * manually escape value for updateAll() etc
- * 2011-06-27 ms
- */
- public function escapeValue($value) {
- if ($value === null || is_numeric($value)) {
- return $value;
- }
- if (is_bool($value)) {
- return (int)$value;
- }
- return "'" . $value . "'";
- }
- /**
- * HIGHLY EXPERIMENTAL
- * @see http://cakephp.lighthouseapp.com/projects/42648/tickets/1799-model-should-have-escapefield-method
- * 2011-07-05 ms
- */
- public function value($content) {
- $db = $this->getDatasource();
- return $db->value($content);
- }
- /**
- * TODO: move to behavior (Incremental)
- * @param mixed id (single string)
- * @param options:
- * - step (defaults to 1)
- * - current (if none it will get it from db)
- * - reset (if true, it will be set to 0)
- * - field (defaults to 'count')
- * - modify (if true if will affect modified timestamp)
- * - timestampField (if provided it will be filled with NOW())
- * 2010-06-08 ms
- */
- public function up($id, $customOptions = array()) {
- $step = 1;
- if (isset($customOptions['step'])) {
- $step = $customOptions['step'];
- }
- $field = 'count';
- if (isset($customOptions['field'])) {
- $field = $customOptions['field'];
- }
- if (isset($customOptions['reset'])) {
- $currentValue = $step = 0;
- } elseif (!isset($customOptions['current'])) {
- $currentValue = $this->field($field, array($this->alias.'.id'=>$id));
- if ($currentValue === false) {
- return false;
- }
- } else {
- $currentValue = $customOptions['current'];
- }
- $value = (int)$currentValue + (int)$step;
- $data = array($field=>$value);
- if (empty($customOptions['modify'])) {
- $data['modified'] = false;
- }
- if (!empty($customOptions['timestampField'])) {
- $data[$customOptions['timestampField']] = date(FORMAT_DB_DATETIME);
- }
- $this->id = $id;
- return $this->save($data, false);
- }
- /**
- * return the next auto increment id from the current table
- * UUIDs will return false
- *
- * @return int next auto increment value or False on failure
- */
- public function getNextAutoIncrement() {
- $next_increment = 0;
- $query = "SHOW TABLE STATUS WHERE name = '" . $this->tablePrefix . $this->table . "'";
- $result = $this->query($query);
- if (!isset($result[0]['TABLES']['Auto_increment'])) {
- return false;
- }
- return (int)$result[0]['TABLES']['Auto_increment'];
- }
- /**
- * workaround for a cake bug which sets empty fields to NULL in Model::set()
- * we cannot use if (isset() && empty()) statements without this fix
- * @param array $fields (which are supposed to be present in $this->data[$this->alias])
- * @param bool $force (if init should be forced, otherwise only if array_key exists)
- * 2011-03-06 ms
- */
- public function init($fields = array(), $force = false) {
- foreach ($fields as $field) {
- if ($force || array_key_exists($field, $this->data[$this->alias])) {
- if (!isset($this->data[$this->alias][$field])) {
- $this->data[$this->alias][$field] = '';
- }
- }
- }
- }
- /**
- * Fix for non atomic queries (MyISAM etc) and saveAll to still return just the boolean result
- * Otherwise you would have to interate over all result values to find out if the save was successful.
- *
- * @param mixed $data
- * @param array $options
- * @return bool Success
- * 2012-11-10 ms
- */
- public function saveAll($data = null, $options = array()) {
- if (!isset($options['atomic'])) {
- $options['atomic'] = (bool)Configure::read('Model.atomic');
- }
- $res = parent::saveAll($data, $options);
- if (is_array($res)) {
- $res = Utility::isValidSaveAll($res);
- }
- return $res;
- }
- /**
- * enables HABTM-Validation
- * e.g. with
- * 'rule' => array('multiple', array('min' => 2))
- * 2010-01-14 ms
- */
- public function beforeValidate($options = array()) {
- foreach ($this->hasAndBelongsToMany as $k => $v) {
- if (isset($this->data[$k][$k])) {
- $this->data[$this->alias][$k] = $this->data[$k][$k];
- }
- }
- return parent::beforeValidate($options);
- }
- /**
- * @param params
- * - key: functioName or other key used
- * @return bool Success
- * 2010-12-02 ms
- */
- public function deleteCache($key) {
- $key = Inflector::underscore($key);
- if (!empty($key)) {
- return Cache::delete(strtolower(Inflector::underscore($this->alias)) . '__' . $key, 'sql');
- }
- return Cache::clear(false, 'sql');
- }
- /**
- * Generates a SQL subquery snippet to be used in your actual query.
- * Your subquery snippet needs to return a single value or flat array of values.
- *
- * Example:
- *
- * $this->Model->find('first', array(
- * 'conditions' => array('NOT' => array('some_id' => $this->Model->subquery(...)))
- * ))
- *
- * Note: You might have to set `autoFields` to false in order to retrieve only the fields you request:
- * http://book.cakephp.org/2.0/en/core-libraries/behaviors/containable.html#containablebehavior-options
- *
- * @param string $type The type o the query ('count'/'all'/'first' - first only works with some mysql versions)
- * @param array $options The options array
- * @param string $alias You can use this intead of $options['alias'] if you want
- * @param bool $parenthesise Add parenthesis before and after
- * @return string $result sql snippet of the query to run
- * @modified Mark Scherer (cake2.x ready and improvements)
- * @link http://bakery.cakephp.org/articles/lucaswxp/2011/02/11/easy_and_simple_subquery_cakephp
- * 2011-07-05 ms
- */
- public function subquery($type, $options = array(), $alias = null, $parenthesise = true) {
- if ($alias === null) {
- $alias = 'Sub' . $this->alias . '';
- }
- $fields = array();
- $limit = null;
- switch ($type) {
- case 'count':
- $fields = array('COUNT(*)');
- break;
- case 'first':
- $limit = 1;
- break;
- }
- $dbo = $this->getDataSource();
- $default = array(
- 'fields' => $fields,
- 'table' => $dbo->fullTableName($this),
- 'alias' => $alias,
- 'limit' => $limit,
- 'offset' => null,
- 'joins' => array(),
- 'conditions' => array(),
- 'order' => null,
- 'group' => null
- );
- $params = array_merge($default, $options);
- $subQuery = trim($dbo->buildStatement($params, $this));
- if ($parenthesise) {
- $subQuery = '(' . $subQuery . ')';
- }
- return $subQuery;
- }
- /**
- * Wrapper find() to cache sql queries.
- *
- * @access public
- * @param array $conditions
- * @param array $fields
- * @param string $order
- * @param string $recursive
- * @return array
- * 2010-12-02 ms
- */
- public function find($type = null, $query = array()) {
- # reset/delete
- if (!empty($query['reset'])) {
- if (!empty($query['cache'])) {
- if (is_array($query['cache'])) {
- $key = $query['cache'][0];
- } else {
- $key = $query['cache'];
- if ($key === true) {
- $backtrace = debug_backtrace();
- $key = $backtrace[1]['function'];
- }
- }
- $this->deleteCache($key);
- }
- }
- # custom fixes
- if (is_string($type)) {
- switch ($type) {
- case 'count':
- if (isset($query['fields'])) {
- unset($query['fields']);
- }
- break;
- default:
- }
- }
- # having and group clauses enhancement
- if (is_array($query) && !empty($query['having']) && !empty($query['group'])) {
- if (!is_array($query['group'])) {
- $query['group'] = array($query['group']);
- }
- $ds = $this->getDataSource();
- $having = $ds->conditions($query['having'], true, false);
- $query['group'][count($query['group']) - 1] .= " HAVING $having";
- } /* elseif (is_array($query) && !empty($query['having'])) {
- $ds = $this->getDataSource();
- $having = $ds->conditions($query['having'], true, false);
- $query['conditions'][] = '1=1 HAVING '.$having;
- }
- */
- # find
- if (!Configure::read('Cache.disable') && Configure::read('Cache.check') && !empty($query['cache'])) {
- if (is_array($query['cache'])) {
- $key = $query['cache'][0];
- $expires = DAY;
- if (!empty($query['cache'][1])) {
- $expires = $query['cache'][1];
- }
- } else {
- $key = $query['cache'];
- if ($key === true) {
- $backtrace = debug_backtrace();
- $key = $backtrace[1]['function'];
- }
- $expires = DAY;
- }
- $options = array('prefix' => strtolower(Inflector::underscore($this->alias)) . '__', );
- if (!empty($expires)) {
- $options['duration'] = $expires;
- }
- if (!Configure::read('Cache.disable')) {
- Cache::config('sql', $options);
- $key = Inflector::underscore($key);
- $results = Cache::read($key, 'sql');
- }
- if ($results === null) {
- $results = parent::find($type, $query);
- Cache::write($key, $results, 'sql');
- }
- return $results;
- }
- # Without caching
- return parent::find($type, $query);
- }
- /*
- public function _findCount($state, $query, $results = array()) {
- if (isset($query['fields'])) {
- unset($query['fields']);
- }
- pr($results);
- return parent::_findCount($state, $query, $results = array());
- }
- */
- /**
- * This code will add formatted list functionallity to find you can easy replace the $this->Model->find('list'); with $this->Model->find('formattedlist', array('fields' => array('Model.id', 'Model.field1', 'Model.field2', 'Model.field3'), 'format' => '%s-%s %s')); and get option tag output of: Model.field1-Model.field2 Model.field3. Even better part is being able to setup your own format for the output!
- * @see http://bakery.cakephp.org/articles/view/add-formatted-lists-to-your-appmodel
- * @deprecated
- * added Caching
- * 2009-12-27 ms
- */
- protected function _find($type, $options = array()) {
- $res = false; // $this->_getCachedResults($type, $options);
- if ($res === false) {
- if (isset($options['cache'])) {
- unset($options['cache']);
- }
- if (!isset($options['recursive'])) {
- //$options['recursive'] = -1;
- }
- switch ($type) {
- # @see http://bakery.cakephp.org/deu/articles/nate/2010/10/10/quick-tipp_-_doing_ad-hoc-joins_bei_model_find
- case 'matches':
- if (!isset($options['joins'])) {
- $options['joins'] = array();
- }
- if (!isset($options['model']) || !isset($options['scope'])) {
- break;
- }
- $assoc = $this->hasAndBelongsToMany[$options['model']];
- $bind = "{$assoc['with']}.{$assoc['foreignKey']} = {$this->alias}.{$this->primaryKey}";
- $options['joins'][] = array(
- 'table' => $assoc['joinTable'],
- 'alias' => $assoc['with'],
- 'type' => 'inner',
- 'foreignKey' => false,
- 'conditions'=> array($bind)
- );
- $bind = $options['model'] . '.' . $this->{$options['model']}->primaryKey . ' = ';
- $bind .= "{$assoc['with']}.{$assoc['associationForeignKey']}";
- $options['joins'][] = array(
- 'table' => $this->{$options['model']}->table,
- 'alias' => $options['model'],
- 'type' => 'inner',
- 'foreignKey' => false,
- 'conditions'=> array($bind) + (array)$options['scope'],
- );
- unset($options['model'], $options['scope']);
- $type = 'all';
- break;
- # probably deprecated since "virtual fields" in 1.3
- case 'formattedlist':
- if (!isset($options['fields']) || count($options['fields']) < 3) {
- $res = parent::find('list', $options);
- break;
- }
- $this->recursive = -1;
- //setup formating
- $format = '';
- if (!isset($options['format'])) {
- for ($i = 0; $i < (count($options['fields']) - 1); $i++) $format .= '%s ';
- $format = substr($format, 0, -1);
- } else {
- $format = $options['format'];
- }
- //get data
- $list = parent::find('all', $options);
- // remove model alias from strings to only get field names
- $tmpPath2[] = $format;
- for ($i = 1; $i <= (count($options['fields']) - 1); $i++) {
- $field[$i] = str_replace($this->alias . '.', '', $options['fields'][$i]);
- $tmpPath2[] = '{n}.' . $this->alias . '.' . $field[$i];
- }
- //do the magic?? read the code...
- $res = Set::combine($list, '{n}.' . $this->alias . '.' . $this->primaryKey, $tmpPath2);
- break;
- default:
- $res = parent::find($type, $options);
- break;
- }
- if (!empty($this->useCache)) {
- Cache::write($this->cacheName, $res, $this->cacheConfig);
- if (Configure::read('debug') > 0) {
- $this->log('WRITE (' . $this->cacheConfig . '): ' . $this->cacheName, 'cache');
- }
- }
- } else {
- if (Configure::read('debug') > 0) {
- $this->log('READ (' . $this->cacheConfig . '): ' . $this->cacheName, 'cache');
- }
- }
- return $res;
- }
- /*
- USAGE of formattetlist:
- $this->Model->find('formattedlist',
- array(
- 'fields'=>array(
- 'Model.id', // allows start with the value="" tags field
- 'Model.field1', // then put them in order of how you want the format to output.
- 'Model.field2',
- 'Model.field3',
- 'Model.field4',
- 'Model.field5',
- ),
- 'format'=>'%s-%s%s %s%s'
- )
- );
- */
- /**
- * @deprecated
- */
- public function _getCachedResults($type, $options) {
- $this->useCache = true;
- if (!is_array($options) || empty($options['cache']) || Configure::read('debug') > 0 && !(Configure::read('Debug.override'))) {
- $this->useCache = false;
- return false;
- }
- if ($options['cache'] === true) {
- $this->cacheName = $this->alias . '_' . sha1($type . serialize($options));
- } else {
- /*
- if (!isset($options['cache']['name'])) {
- return false;
- }
- */
- $this->cacheName = $this->alias . '_' . sha1($type . serialize($options));
- $this->cacheConfig = $options['cache'];
- //$this->cacheName = $this->alias . '_' . $type . '_' . $options['cache'];
- //$this->cacheConfig = isset($options['cache']['config']) ? $options['cache']['config'] : 'default';
- }
- $results = Cache::read($this->cacheName, $this->cacheConfig);
- return $results;
- }
- /*
- neighbor find problem:
- This means it will sort the results on Model.created ASC and DESC.
- However, in certain situations you would like to order on more than one
- field. For example, on a rating and a uploaddate. Requirements could look
- like: Get next en previous record of a certain Model based on the top
- rated. When the rating is equal those should be ordered on creation date.
- I suggest something similar to:
- $this->Movie->find('neighbors', array(
- 'scope' => array(
- array(
- 'field' => 'rating',
- 'order' => 'DESC',
- 'value' => 4.85
- ),
- array(
- 'field' => 'created',
- 'order' => 'DESC',
- 'value' => '2009-05-26 06:20:03'
- )
- )
- 'conditions' => array(
- 'approved' => true,
- 'processed' => true
- )
- */
- /**
- * core-fix for multiple sort orders
- * @param addiotional 'scope'=>array(field,order) - value is retrieved by (submitted) primary key
- * TODO: fix it
- * 2009-07-25 ms
- */
- protected function _findNeighbors($state, $query, $results = array()) {
- return parent::_findNeighbors($state, $query, $results);
- if (isset($query['scope'])) {
- //TODO
- }
- return parent::find($type, $options);
- }
- /**
- * @param mixed $id: id only, or request array
- * @param array $options
- * - filter: open/closed/none
- * - field (sortField, if not id)
- * - reverse: sortDirection (0=normalAsc/1=reverseDesc)
- * - displayField: ($this->displayField, if empty)
- * @param array $qryOptions
- * - recursive (defaults to -1)
- * TODO: try to use core function, TRY TO ALLOW MULTIPLE SORT FIELDS
- * @return array
- */
- public function neighbors($id = null, $options = array(), $qryOptions = array()) {
- $sortField = (!empty($options['field']) ? $options['field'] : 'created');
- $normalDirection = (!empty($options['reverse']) ? false : true);
- $sortDirWord = $normalDirection ? array('ASC', 'DESC') : array('DESC', 'ASC');
- $sortDirSymb = $normalDirection ? array('>=', '<=') : array('<=', '>=');
- $displayField = (!empty($options['displayField']) ? $options['displayField'] : $this->displayField);
- if (is_array($id)) {
- $data = $id;
- $id = $data[$this->alias]['id'];
- } elseif ($id === null) {
- $id = $this->id;
- }
- if (!empty($id)) {
- $data = $this->find('first', array('conditions' => array('id' => $id), 'contain' => array()));
- }
- if (empty($id) || empty($data) || empty($data[$this->alias][$sortField])) {
- return array();
- } else {
- $field = $data[$this->alias][$sortField];
- }
- $findOptions = array('recursive' => -1);
- if (isset($qryOptions['recursive'])) {
- $findOptions['recursive'] = $qryOptions['recursive'];
- }
- if (isset($qryOptions['contain'])) {
- $findOptions['contain'] = $qryOptions['contain'];
- }
- $findOptions['fields'] = array($this->alias . '.id', $this->alias . '.' . $displayField);
- $findOptions['conditions'][$this->alias . '.id !='] = $id;
- # //TODO: take out
- if (!empty($options['filter']) && $options['filter'] == REQUEST_STATUS_FILTER_OPEN) {
- $findOptions['conditions'][$this->alias . '.status <'] = REQUEST_STATUS_DECLINED;
- } elseif (!empty($options['filter']) && $options['filter'] == REQUEST_STATUS_FILTER_CLOSED) {
- $findOptions['conditions'][$this->alias . '.status >='] = REQUEST_STATUS_DECLINED;
- }
- $return = array();
- if (!empty($qryOptions['conditions'])) {
- $findOptions['conditions'] = Set::merge($findOptions['conditions'], $qryOptions['conditions']);
- }
- $options = $findOptions;
- $options['conditions'] = Set::merge($options['conditions'], array($this->alias . '.' . $sortField . ' ' . $sortDirSymb[1] => $field));
- $options['order'] = array($this->alias . '.' . $sortField . '' => $sortDirWord[1]);
- $this->id = $id;
- $return['prev'] = $this->find('first', $options);
- $options = $findOptions;
- $options['conditions'] = Set::merge($options['conditions'], array($this->alias . '.' . $sortField . ' ' . $sortDirSymb[0] => $field));
- $options['order'] = array($this->alias . '.' . $sortField . '' => $sortDirWord[0]); // ??? why 0 instead of 1
- $this->id = $id;
- $return['next'] = $this->find('first', $options);
- return $return;
- }
- /** Validation Functions **/
- /**
- * Overwrite invalidate to allow last => true
- *
- * @param string $field The name of the field to invalidate
- * @param mixed $value Name of validation rule that was not failed, or validation message to
- * be returned. If no validation key is provided, defaults to true.
- * @param boolean $last If this should be the last validation check for this validation run
- * @return void
- */
- public function invalidate($field, $value = true, $last = false) {
- parent::invalidate($field, $value);
- if (!$last) {
- return;
- }
- $this->validator()->remove($field);
- }
- /**
- * validates a primary or foreign key depending on the current schema data for this field
- * recognizes uuid (char36) and aiid (int10 unsigned) - not yet mixed (varchar36)
- * more useful than using numeric or notEmpty which are type specific
- *
- * @param array $data
- * @param array $options
- * - allowEmpty
- * @return bool Success
- * 2011-06-21 ms
- */
- public function validateKey($data = array(), $options = array()) {
- $keys = array_keys($data);
- $key = array_shift($keys);
- $value = array_shift($data);
- $schema = $this->schema($key);
- if (!$schema) {
- return true;
- }
- $defaults = array(
- 'allowEmpty' => false,
- );
- $options = array_merge($defaults, $options);
- if ($schema['type'] !== 'integer') {
- if ($options['allowEmpty'] && $value === '') {
- return true;
- }
- return Validation::uuid($value);
- }
- if ($options['allowEmpty'] && $value === 0) {
- return true;
- }
- return is_numeric($value) && (int)$value == $value && $value > 0;
- }
- /**
- * checks if the passed enum value is valid
- *
- * @return bool Success
- * 2010-02-09 ms
- */
- public function validateEnum(array $data, $enum = null, $additionalKeys = array()) {
- $keys = array_keys($data);
- $valueKey = array_shift($keys);
- $value = $data[$valueKey];
- $keys = array();
- if ($enum === true) {
- $enum = $valueKey;
- }
- if ($enum !== null) {
- if (!method_exists($this, $enum)) {
- trigger_error('Enum method \'' . $enum . '()\' not exists', E_USER_ERROR);
- return false;
- }
- //TODO: make static
- $keys = $this->{$enum}();
- }
- $keys = array_merge($additionalKeys, array_keys($keys));
- if (!empty($keys) && in_array($value, $keys)) {
- return true;
- }
- return false;
- }
- /**
- * checks if the content of 2 fields are equal
- * Does not check on empty fields! Return TRUE even if both are empty (secure against empty in another rule)!
- *
- * @return bool Success
- * 2009-01-22 ms
- */
- public function validateIdentical($data = array(), $compareWith = null, $options = array()) {
- if (is_array($data)) {
- $value = array_shift($data);
- } else {
- $value = $data;
- }
- $compareValue = $this->data[$this->alias][$compareWith];
- $matching = array('string' => 'string', 'int' => 'integer', 'float' => 'float', 'bool' => 'boolean');
- if (!empty($options['cast']) && array_key_exists($options['cast'], $matching)) {
- # cast values to string/int/float/bool if desired
- settype($compareValue, $matching[$options['cast']]);
- settype($value, $matching[$options['cast']]);
- }
- return ($compareValue === $value);
- }
- /**
- * checks a record, if it is unique - depending on other fields in this table (transfered as array)
- * example in model: 'rule' => array ('validateUnique', array('belongs_to_table_id','some_id','user_id')),
- * if all keys (of the array transferred) match a record, return false, otherwise true
- *
- * @param ARRAY other fields
- * TODO: add possibity of deep nested validation (User -> Comment -> CommentCategory: UNIQUE comment_id, Comment.user_id)
- * @return bool Success
- * 2010-01-30 ms
- */
- public function validateUnique($data, $fields = array(), $options = array()) {
- $id = (!empty($this->data[$this->alias]['id']) ? $this->data[$this->alias]['id'] : 0);
- if (!$id && $this->id) {
- $id = $this->id;
- }
- foreach ($data as $key => $value) {
- $fieldName = $key;
- $fieldValue = $value; // equals: $this->data[$this->alias][$fieldName]
- }
- $conditions = array($this->alias . '.' . $fieldName => $fieldValue, // Model.field => $this->data['Model']['field']
- $this->alias . '.id !=' => $id);
- # careful, if fields is not manually filled, the options will be the second param!!! big problem...
- $fields = (array)$fields;
- if (!array_key_exists('allowEmpty', $fields)) {
- foreach ((array)$fields as $dependingField) {
- if (isset($this->data[$this->alias][$dependingField])) { // add ONLY if some content is transfered (check on that first!)
- $conditions[$this->alias . '.' . $dependingField] = $this->data[$this->alias][$dependingField];
- } elseif (isset($this->data['Validation'][$dependingField])) { // add ONLY if some content is transfered (check on that first!
- $conditions[$this->alias . '.' . $dependingField] = $this->data['Validation'][$dependingField];
- } elseif (!empty($id)) {
- # manual query! (only possible on edit)
- $res = $this->find('first', array('fields' => array($this->alias.'.'.$dependingField), 'conditions' => array($this->alias.'.id' => $id)));
- if (!empty($res)) {
- $conditions[$this->alias . '.' . $dependingField] = $res[$this->alias][$dependingField];
- }
- }
- }
- }
- $this->recursive = -1;
- if (count($conditions) > 2) {
- $this->recursive = 0;
- }
- $res = $this->find('first', array('fields' => array($this->alias . '.id'), 'conditions' => $conditions));
- if (!empty($res)) {
- return false;
- }
- return true;
- }
- /**
- * @param array $data
- * @param array $options
- * - scope (array of other fields as scope - isUnique dependent on other fields of the table)
- * - batch (defaults to true, remembers previous values in order to validate batch imports)
- * example in model: 'rule' => array ('validateUniqueExt', array('scope'=>array('belongs_to_table_id','some_id','user_id'))),
- * http://groups.google.com/group/cake-php/browse_thread/thread/880ee963456739ec
- * //TODO: test!!!
- * @return bool Success
- * @deprecated in favor of validateUnique?
- * 2011-03-27 ms
- */
- public function validateUniqueExt($data, $options = array()) {
- foreach ($data as $key => $value) {
- $fieldName = $key;
- $fieldValue = $value;
- }
- $defaults = array('batch' => true, 'scope' => array());
- $options = array_merge($defaults, $options);
- # for batch
- if ($options['batch'] !== false && !empty($this->batchRecords)) {
- if (array_key_exists($value, $this->batchRecords[$fieldName])) {
- return $options['scope'] === $this->batchRecords[$fieldName][$value];
- }
- }
- # continue with validation
- if (!$this->validateUnique($data, $options['scope'])) {
- return false;
- }
- # for batch
- if ($options['batch'] !== false) {
- if (!isset($this->batchRecords)) {
- $this->batchRecords = array();
- }
- $this->batchRecords[$fieldName][$value] = $scope;
- }
- return true;
- }
- /**
- * Checks if a url is valid AND accessable (returns false otherwise)
- *
- * @param array/string $data: full url(!) starting with http://...
- * @options array
- * - allowEmpty TRUE/FALSE (TRUE: if empty => return TRUE)
- * - required TRUE/FALSE (TRUE: overrides allowEmpty)
- * - autoComplete (default: TRUE)
- * - deep (default: TRUE)
- * @return bool Success
- * 2010-10-18 ms
- */
- public function validateUrl($data, $options = array()) {
- if (is_array($data)) {
- $url = array_shift($data);
- } else {
- $url = $data;
- }
- if (empty($url)) {
- if (!empty($options['allowEmpty']) && empty($options['required'])) {
- return true;
- }
- return false;
- }
- if (!isset($options['autoComplete']) || $options['autoComplete'] !== false) {
- $url = $this->_autoCompleteUrl($url);
- }
- if (!isset($options['strict']) || $options['strict'] !== false) {
- $options['strict'] = true;
- }
- # validation
- if (!Validation::url($url, $options['strict']) && env('REMOTE_ADDR') !== '127.0.0.1') {
- return false;
- }
- # same domain?
- if (!empty($options['sameDomain']) && !empty($_SERVER['HTTP_HOST'])) {
- $is = parse_url($url, PHP_URL_HOST);
- $expected = $_SERVER['HTTP_HOST'];
- if (mb_strtolower($is) !== mb_strtolower($expected)) {
- return false;
- }
- }
- if (isset($options['deep']) && $options['deep'] === false) {
- return true;
- }
- return $this->_validUrl($url);
- }
- /**
- * prepend protocol if missing
- *
- * @param string $url
- * @return string Url
- * 2009-02-27 ms
- */
- protected function _autoCompleteUrl($url) {
- if (mb_strpos($url, '/') === 0) {
- $url = Router::url($url, true);
- } elseif (mb_strpos($url, '://') === false && mb_strpos($url, 'www.') === 0) {
- $url = 'http://' . $url;
- }
- return $url;
- }
- /**
- * checks if a url is valid
- *
- * @param string url
- * @return bool Success
- * 2009-02-27 ms
- */
- protected function _validUrl($url) {
- $headers = Utility::getHeaderFromUrl($url);
- if ($headers === false) {
- return false;
- }
- $headers = implode("\n", $headers);
- $protocol = mb_strpos($url, 'https://') === 0 ? 'HTTP' : 'HTTP';
- return ((bool)preg_match('#^'.$protocol.'/.*\s+[(200|301|302)]+\s#i', $headers) && !(bool)preg_match('#^'.$protocol.'/.*\s+[(404|999)]+\s#i', $headers));
- }
- /**
- * Validation of DateTime Fields (both Date and Time together)
- *
- * @param options
- * - dateFormat (defaults to 'ymd')
- * - allowEmpty
- * - after/before (fieldName to validate against)
- * - min/max (defaults to >= 1 - at least 1 minute apart)
- * @return bool Success
- * 2011-03-02 ms
- */
- public function validateDateTime($data, $options = array()) {
- $format = !empty($options['dateFormat']) ? $options['dateFormat'] : 'ymd';
- if (is_array($data)) {
- $value = array_shift($data);
- } else {
- $value = $data;
- }
- $dateTime = explode(' ', trim($value), 2);
- $date = $dateTime[0];
- $time = (!empty($dateTime[1]) ? $dateTime[1] : '');
- if (!empty($options['allowEmpty']) && (empty($date) && empty($time) || $date == DEFAULT_DATE && $time == DEFAULT_TIME || $date == DEFAULT_DATE && empty($time))) {
- return true;
- }
- /*
- if ($this->validateDate($date, $options) && $this->validateTime($time, $options)) {
- return true;
- }
- */
- if (Validation::date($date, $format) && Validation::time($time)) {
- # after/before?
- $minutes = isset($options['min']) ? $options['min'] : 1;
- if (!empty($options['after']) && isset($this->data[$this->alias][$options['after']])) {
- if (strtotime($this->data[$this->alias][$options['after']]) > strtotime($value) - $minutes) {
- return false;
- }
- }
- if (!empty($options['before']) && isset($this->data[$this->alias][$options['before']])) {
- if (strtotime($this->data[$this->alias][$options['before']]) < strtotime($value) + $minutes) {
- return false;
- }
- }
- return true;
- }
- return false;
- }
- /**
- * Validation of Date fields (as the core one is buggy!!!)
- *
- * @param options
- * - dateFormat (defaults to 'ymd')
- * - allowEmpty
- * - after/before (fieldName to validate against)
- * - min (defaults to 0 - equal is OK too)
- * @return bool Success
- * 2011-03-02 ms
- */
- public function validateDate($data, $options = array()) {
- $format = !empty($options['format']) ? $options['format'] : 'ymd';
- if (is_array($data)) {
- $value = array_shift($data);
- } else {
- $value = $data;
- }
- $dateTime = explode(' ', trim($value), 2);
- $date = $dateTime[0];
- if (!empty($options['allowEmpty']) && (empty($date) || $date == DEFAULT_DATE)) {
- return true;
- }
- if (Validation::date($date, $format)) {
- # after/before?
- $days = !empty($options['min']) ? $options['min'] : 0;
- if (!empty($options['after']) && isset($this->data[$this->alias][$options['after']])) {
- if ($this->data[$this->alias][$options['after']] > date(FORMAT_DB_DATE, strtotime($date) - $days * DAY)) {
- return false;
- }
- }
- if (!empty($options['before']) && isset($this->data[$this->alias][$options['before']])) {
- if ($this->data[$this->alias][$options['before']] < date(FORMAT_DB_DATE, strtotime($date) + $days * DAY)) {
- return false;
- }
- }
- return true;
- }
- return false;
- }
- /**
- * Validation of Time fields
- *
- * @param array $options
- * - timeFormat (defaults to 'hms')
- * - allowEmpty
- * - after/before (fieldName to validate against)
- * - min/max (defaults to >= 1 - at least 1 minute apart)
- * @return bool Success
- * 2011-03-02 ms
- */
- public function validateTime($data, $options = array()) {
- if (is_array($data)) {
- $value = array_shift($data);
- } else {
- $value = $data;
- }
- $dateTime = explode(' ', trim($value), 2);
- $value = array_pop($dateTime);
- if (Validation::time($value)) {
- # after/before?
- if (!empty($options['after']) && isset($this->data[$this->alias][$options['after']])) {
- if ($this->data[$this->alias][$options['after']] >= $value) {
- return false;
- }
- }
- if (!empty($options['before']) && isset($this->data[$this->alias][$options['before']])) {
- if ($this->data[$this->alias][$options['before']] <= $value) {
- return false;
- }
- }
- return true;
- }
- return false;
- }
- //TODO
- /**
- * Validation of Date Fields (>= minDate && <= maxDate)
- * @param options
- * - min/max (TODO!!)
- * 2010-01-20 ms
- */
- public function validateDateRange($data, $options = array()) {
- }
- //TODO
- /**
- * Validation of Time Fields (>= minTime && <= maxTime)
- * @param options
- * - min/max (TODO!!)
- * 2010-01-20 ms
- */
- public function validateTimeRange($data, $options = array()) {
- }
- /**
- * model validation rule for email addresses
- *
- * @return bool Success
- * 2010-01-14 ms
- */
- public function validateUndisposable($data, $proceed = false) {
- $email = array_shift($data);
- if (empty($email)) {
- return true;
- }
- return $this->isUndisposableEmail($email, false, $proceed);
- }
- /**
- * NOW: can be set to work offline only (if server is down etc)
- * Checks if a email is not from a garbige hoster
- *
- * @param string email (necessary)
- * @return boolean true if valid, else false
- * 2009-03-09 ms
- */
- public function isUndisposableEmail($email, $onlineMode = false, $proceed = false) {
- if (!isset($this->UndisposableEmail)) {
- App::import('Vendor', 'undisposable/undisposable');
- $this->UndisposableEmail = new UndisposableEmail();
- }
- if (!$onlineMode) {
- # crashed with white screen of death otherwise... (if foreign page is 404)
- $this->UndisposableEmail->useOnlineList(false);
- }
- if (!class_exists('Validation')) {
- App::uses('Validation', 'Utility');
- }
- if (!Validation::email($email)) {
- return false;
- }
- if ($this->UndisposableEmail->isUndisposableEmail($email) === false) {
- # trigger log
- $this->log('Disposable Email detected: ' . h($email).' (IP '.env('REMOTE_ADDR').')', 'undisposable');
- if ($proceed === true) {
- return true;
- }
- return false;
- }
- return true;
- }
- /**
- * Is blocked email?
- * //TODO: move outside of MyModel?
- *
- * @return bool $ifNotBlacklisted
- * 2009-12-22 ms
- */
- public function validateNotBlocked($params) {
- $email = array_shift($params);
- if (!isset($this->Blacklist)) {
- //App::uses('Blacklist', 'Tools.Model'
- $this->Blacklist = ClassRegistry::init('Tools.Blacklist');
- }
- if ($this->Blacklist->isBlacklisted(Blacklist::TYPE_EMAIL, $email)) {
- return false;
- }
- return true;
- }
- /** General Model Functions **/
- /**
- * CAREFUL: use LIMIT due to Starker Serverlastigkeit! or CACHE it!
- *
- * e.g.: 'ORDER BY ".$this->umlautsOrderFix('User.nic')." ASC'
- *
- * @param string variable (to be correctly ordered)
- * @deprecated
- */
- public function umlautsOrderFix($var) {
- return "REPLACE(REPLACE(REPLACE(REPLACE(REPLACE(REPLACE(REPLACE(".$var.", 'Ä', 'Ae'), 'Ö', 'Oe'), 'Ü', 'Ue'), 'ä', 'ae'), 'ö', 'oe'), 'ü','ue'), 'ß', 'ss')";
- }
- /**
- * set + guaranteeFields!
- * Extends the core set function (only using data!!!)
- *
- * @param mixed $data
- * @param mixed $data2 (optional)
- * @param array $requiredFields Required fields
- * @param array $fieldList Whitelist / Allowed fields
- * @return array
- * 2010-03-11 ms
- */
- public function set($data, $data2 = null, $requiredFields = array(), $fieldList = array()) {
- if (!empty($requiredFields)) {
- $data = $this->guaranteeFields($requiredFields, $data);
- }
- if (!empty($fieldList)) {
- $data = $this->whitelist($fieldList, $data);
- }
- return parent::set($data, $data2);
- }
- /**
- * @param array $fieldList
- * @param array $data (optional)
- * @return array
- * 2011-06-01 ms
- */
- public function whitelist($fieldList, $data = null) {
- $model = $this->alias;
- if ($data === null) {
- $data = $this->data;
- }
- foreach ($data[$model] as $key => $val) {
- if (!in_array($key, $fieldList)) {
- unset($data[$model][$key]);
- }
- }
- return $data;
- }
- /**
- * make sure required fields exists - in order to properly validate them
- * @param array: field1, field2 - or field1, Model2.field1 etc
- * @param array: data (optional, otherwise the array with the required fields will be returned)
- * @return array
- * 2010-03-11 ms
- */
- public function guaranteeFields($requiredFields, $data = null) {
- $guaranteedFields = array();
- foreach ($requiredFields as $column) {
- if (strpos($column, '.') !== false) {
- list($model, $column) = explode('.', $column, 2);
- } else {
- $model = $this->alias;
- }
- $guaranteedFields[$model][$column] = ''; # now field exists in any case!
- }
- if ($data === null) {
- return $guaranteedFields;
- }
- if (!empty($guaranteedFields)) {
- $data = Set::merge($guaranteedFields, $data);
- }
- return $data;
- }
- /**
- * make certain fields a requirement for the form to validate
- * (they must only be present - can still be empty, though!)
- *
- * @param array $fieldList
- * @param bool $allowEmpty (or NULL to not touch already set elements)
- * @return void
- * 2012-02-20 ms
- */
- public function requireFields($requiredFields, $allowEmpty = null) {
- if ($allowEmpty === null) {
- $setAllowEmpty = true;
- } else {
- $setAllowEmpty = $allowEmpty;
- }
- foreach ($requiredFields as $column) {
- if (strpos($column, '.') !== false) {
- list($model, $column) = explode('.', $column, 2);
- } else {
- $model = $this->alias;
- }
- if ($model !== $this->alias) {
- continue;
- }
- if (empty($this->validate[$column])) {
- $this->validate[$column]['notEmpty'] = array('rule' => 'notEmpty', 'required' => true, 'allowEmpty' => $setAllowEmpty, 'message' => 'valErrMandatoryField');
- } else {
- $keys = array_keys($this->validate[$column]);
- if (!in_array('rule', $keys)) {
- $key = array_shift($keys);
- $this->validate[$column][$key]['required'] = true;
- if (!isset($this->validate[$column][$key]['allowEmpty'])) {
- $this->validate[$column][$key]['allowEmpty'] = $setAllowEmpty;
- }
- } else {
- $keys['required'] = true;
- if (!isset($keys['allowEmpty'])) {
- $keys['allowEmpty'] = $setAllowEmpty;
- }
- $this->validate[$column] = $keys;
- }
- }
- }
- }
- /**
- * instead of whitelisting
- * @param array $blackList
- * - array: fields to blacklist
- * - boolean TRUE: removes all foreign_keys (_id and _key)
- * note: one-dimensional
- * @return array
- * 2009-06-19 ms
- */
- public function blacklist($blackList = array()) {
- if ($blackList === true) {
- //TODO
- }
- return array_diff(array_keys($this->schema()), (array)$blackList);
- }
- /**
- * Shortcut method to find a specific entry via primary key
- *
- * @param mixed $id
- * @param string|array $fields
- * @param array $contain
- * @return mixed
- * 2009-11-14 ms
- */
- public function get($id, $fields = array(), $contain = array()) {
- if (is_array($id)) {
- $column = $id[0];
- $value = $id[1];
- } else {
- $column = 'id';
- $value = $id;
- }
- if ($fields === '*') {
- $fields = $this->alias . '.*';
- } elseif (!empty($fields)) {
- foreach ($fields as $row => $field) {
- if (strpos($field, '.') !== false) {
- continue;
- }
- $fields[$row] = $this->alias . '.' . $field;
- }
- }
- $options = array(
- 'conditions' => array($this->alias . '.' . $column => $value),
- );
- if (!empty($fields)) {
- $options['fields'] = $fields;
- }
- if (!empty($contain)) {
- $options['contain'] = $contain;
- }
- return $this->find('first', $options);
- }
- /**
- * Get all related entries that have been used so far
- *
- * @param string $modelName The related model
- * @param string $groupField Field to group by
- * @param string $type Find type
- * @param array $options
- * @return array
- */
- public function getRelatedInUse($modelName, $groupField, $type = 'all', $options = array()) {
- $defaults = array(
- 'contain' => array($modelName),
- 'group' => $groupField,
- 'order' => $this->$modelName->order ? $this->$modelName->order : array($modelName . '.' . $this->$modelName->displayField => 'ASC'),
- );
- if ($type === 'list') {
- $defaults['fields'] = array($modelName . '.' . $this->$modelName->primaryKey, $modelName . '.' . $this->$modelName->displayField);
- }
- $options += $defaults;
- return $this->find($type, $options);
- }
- /**
- * Get all fields that have been used so far
- *
- * @param string $groupField Field to group by
- * @param string $type Find type
- * @param array $options
- * @return array
- */
- public function getFieldInUse($groupField, $type = 'all', $options = array()) {
- $defaults = array(
- 'group' => $groupField,
- 'order' => array($this->alias . '.' . $this->displayField => 'ASC'),
- );
- if ($type === 'list') {
- $defaults['fields'] = array($this->alias . '.' . $this->primaryKey, $this->alias . '.' . $this->displayField);
- }
- $options += $defaults;
- return $this->find($type, $options);
- }
- /**
- * Update a row with certain fields (dont use "Model" as super-key)
- * @param int $id
- * @param array $data
- * @return bool|array Success
- * 2012-11-20 ms
- */
- public function update($id, $data, $validate = false) {
- $this->id = $id;
- return $this->save($data, $validate, array_keys($data));
- }
- /**
- * Automagic increasing of a field with e.g.:
- * $this->id = ID; $this->inc('weight',3);
- *
- * @deprecated use atomic updateAll() instead!
- * @param string fieldname
- * @param int factor: defaults to 1 (could be negative as well - if field is signed and can be < 0)
- */
- public function inc($field, $factor = 1) {
- $value = Set::extract($this->read($field), $this->alias . '.' . $field);
- $value += $factor;
- return $this->saveField($field, $value);
- }
- /**
- * Toggles Field (Important/Deleted/Primary etc)
- * @param STRING fieldName
- * @param INT id (cleaned!)
- * @return ARRAY record: [Model][values],...
- * AJAX?
- * 2008-11-06 ms
- */
- public function toggleField($fieldName, $id) {
- $record = $this->get($id, array('id', $fieldName));
- if (!empty($record) && !empty($fieldName) && $this->hasField($fieldName)) {
- $record[$this->alias][$fieldName] = ($record[$this->alias][$fieldName] == 1 ? 0 : 1);
- $this->id = $id;
- $this->saveField($fieldName, $record[$this->alias][$fieldName]);
- }
- return $record;
- }
- /**
- * truncate TABLE (already validated, that table exists)
- * @param string table [default:FALSE = current model table]
- * @return bool Success
- */
- public function truncate($table = null) {
- if (empty($table)) {
- $table = $this->table;
- }
- $db = ConnectionManager::getDataSource($this->useDbConfig);
- return $db->truncate($table);
- }
- /** Deep Lists **/
- /**
- * recursive Dropdown Lists
- * NEEDS tree behavior, NEEDS lft, rght, parent_id (!)
- * //FIXME
- * 2008-01-02 ms
- */
- public function recursiveSelect($conditions = array(), $attachTree = false, $spacer = '-- ') {
- if ($attachTree) {
- $this->Behaviors->load('Tree');
- }
- $data = $this->generateTreeList($conditions, null, null, $spacer);
- return $data;
- }
- /**
- * from http://othy.wordpress.com/2006/06/03/generatenestedlist/
- * NEEDS parent_id
- * //TODO refactor for 1.2
- *
- * @deprecated use generateTreeList instead
- * 2009-08-12 ms
- */
- public function generateNestedList($conditions = null, $indent = '--') {
- $cats = $this->find('threaded', array('conditions' => $conditions, 'fields' => array(
- $this->name . '.id',
- $this->name . '.name',
- $this->name . '.parent_id')));
- $glist = $this->_generateNestedList($cats, $indent);
- return $glist;
- }
- /**
- * from http://othy.wordpress.com/2006/06/03/generatenestedlist/
- * @deprecated use generateTreeList instead
- * 2009-08-12 ms
- */
- public function _generateNestedList($cats, $indent = '--', $level = 0) {
- static $list = array();
- $c = count($cats);
- for ($i = 0; $i < $c; $i++) {
- $list[$cats[$i][$this->alias]['id']] = str_repeat($indent, $level) . $cats[$i][$this->alias][$this->displayField];
- if (!empty($cats[$i]['children'])) {
- $this->_generateNestedList($cats[$i]['children'], $indent, $level + 1);
- }
- }
- return $list;
- }
- }
|