PHP в SouthPark » Модели

Модели и контроллеры CakePHP в подпапках

Владимир Лучанинов — Tue, 04 Dec 2007 12:42:56 +0000

Когда накапливается больше 20 контроллеров и моделей, то начинает казаться не такой уже и хорошей идея жёсткого закрепления папок, куда нужно помещать файлы определённого типа. Конечно, есть $modelPaths и $controllerPaths, но каждый раз назначать их вручную не так уж и приятно.

plain text

PHP:

$modelPaths = array('/path_to_model_folder_A/', '/path_to_model_folder_B/');

В посте cakebaker.42dh.com/2007/11/22/organizing-your-code-with-folders/ рассказывается, что в последних версиях CakePHP можно создавать любые подпапки и Cake сам поймёт, где что искать.
Но у меня, во-первых, не получилось сходу это сделать и некоторые проекты не могут работать на последних night-билдах. Поэтому я использую альтернативное решение (почти всё одолжено отсюда - bakery.cakephp.org/articles/view/flexible-controller-and-modelpaths)

Просто добавьте этот код в config/bootstrap.php

plain text

PHP:

function getSubFolders($baseDir) {
$result = array();
$cwd =getcwd();
chdir($baseDir);
$dirs = glob("*", GLOB_ONLYDIR);
if (sizeof($dirs)> 0) {
foreach($dirs as $dir) {
$result[] = $baseDir.DS.$dir.DS;
}
}
chdir($cwd);
return $result;
}
$modelPaths = array_diff(getSubFolders(APP . 'models'), array('behaviors', 'datasources'));
$controllerPaths = array_diff(getSubFolders(APP . 'controllers'), array('components'));

Autocomplete для моделей в CakePHP

Владимир Лучанинов — Thu, 01 Nov 2007 16:48:51 +0000

"Магия" CakePHP, которая позволяет делать программы с минимальным количеством кода, имеет свои недостатки. Например, в контроллере редакторы не понимают, что есть модели и какого они типа. А autocomplete - это чудесная штука, без которой постоянно надо лезть в API.

Наконец меня это достало и я полез в документацию Zend, чтобы научить его понимать философию Cake. Оказывается, там можно написать /* @var $myVar Test */, чтобы редактор понял, что $myVar имеет является объектом класса Test. На CakePHP-форуме предложили такой вариант:

plain text

PHP:

/* @var MyModel MyModel */
$MyModel=$this->MyModel;
$MyModel->...

Это работает, конечно, но писать в каждом action такую конструкцию и вводить новую переменную как-то не очень хочется. Я для себя придумал такое решение:

То есть вручную объявляется переменная с названием модели и ей с помощью комментариев указывается тип.

Комментировать код бывает очень полезно .

Кеширование с помощью статических переменных и в моделях CakePHP

Владимир Лучанинов — Mon, 22 Oct 2007 21:23:48 +0000

Как вы оцениваете свой уровень как программиста? Несмотря на то, что меня Влад дважды похвалил , я свой уровень оцениваю на 3 с плюсом (по 5-бальной шкале). Каждый день узнаю такие интересные финты, что хочется посыпать голову пеплом, за то, что сам до этого не додумался.

Сегодня узнал способ легко кешировать результаты функции, которые не меняются при условии одинаковых входящих параметров.

plain text

PHP:

function test($input) {
static $cache = array();
if (isset($cache[$input])) return $cache[$input];
// Сама функция, которая как на зло очень долгая
// Обрабатываем $input и получаем $result
return $cache[$input] = $result;
}

Если результаты очень объёмные и слишком расточительно кешировать всё, можно проверять время и кешировать только то, расчёт чего занимает больше 1 секунды.

plain text

PHP:

function test($input) {
static $cache = array();
if (isset($cache[$input])) return $cache[$input];
$startTime = microtime(true);
// Сама функция, которая как на зло иногда быстрая, а иногда очень долгая
// Обрабатываем $input и получаем $result
if (microtime(true)-$startTime > 1) $cache[$input] = $result;
return $result;
}

Я иногда делаю кеширование в моделях CakePHP. Причины кеширования - таблица содержит больше 200 тысяч записей (схожие принципы используются в других таблицах с десятками миллионов записей), запросов очень много, но в течение дня запросы часто идут к одним и тем же записям. Дописывается в таблицу что-то очень редко. Полностью модель довольно сложная и имеет множество взаимосвязей, я показываю только маленькую часть, чтобы можно было понять принцип.

plain text

PHP:

class Word extends AppModel {
var $name = 'Word';
var $validate = array(
'id' => VALID_NUMBER,
'name' => VALID_NOT_EMPTY,
);
var $actsAs = array('NameList'=>array());
var $cache = array();
function __construct($id=false, $table=null, $ds=null) {
$this->cache = Cache::read('word_list');
if ($this->cache===false) {
$this->cache = array();
}
return parent::__construct($id, $table, $ds);
}
function __destruct() {
Cache::write('word_list', $this->cache);
//return parent::__destruct(); // AppModel hasn't __destruct method
}
function getNames($ids) {
$newIds = array();
$result = array();
foreach ($ids as $id) {
if (!isset($this->cache[$id])) {
$newIds[] = $id;
} else {
$result[$id] = $this->cache[$id];
}
}
$newIds = $this->generateList(array('Word.id'=>$newIds));
if (!empty($newIds)) foreach ($newIds as $id=>$name) {
$this->cache[$id] = $name;
$result[$id] = $name;
}
return $result;
}
}
?>

Тестирование моделей в CakePHP

Владимир Лучанинов — Fri, 19 Oct 2007 21:04:28 +0000

Мне понравилось тестировать как можно больше всего в CakePHP. О том как тестировать компоненты, я уже писал, теперь пришло время моделей.

В поисках подходящего the fucking manual я набрёл на Testing Models with CakePHP 1.2 test suite на bakery.cakephp.org.
И всё очень хорошо расписано, но, блин, не работает и всё. Поэтому не читайте то, что там написано. Я ~~тщательно изучив исходники~~ методом научного тыка сделал так, чтобы всё работало.

Идеология тестирования моделей в CakePHP
Модели работают с базой данных и соответственно надо проверить насколько хорошо это получается. Я сторонник fat Models, thin Controllers и стараюсь переносить всю логику работы с данными в модели. Поэтому проверять надо много.

Можно указать отдельное подключение для тестовой базы данных в app/config/database.php в переменной $test. Обычно подходят те же значения, что и в $default. Если вы уберёте $test, то CakePHP сам установит её такой же как и $default. В любом случае, не волнуйтесь, потому что для тестовых таблиц будет добавлен префикс test_suite.

Для создания тестовых таблиц используются fixtures. Они создают тестовые таблицы до проведения теста, перед каждым тестом загружают туда тестовые данные, после каждого теста очищают тестовые таблицы и после последнего теста удаляют их.

Создание Fixtures
Как говорится "сначала было слово", вот мы и создадим fixture для модели Word.

app/test/fixtures/word_test_fixture.php

plain text

PHP:

class WordTestFixture extends CakeTestFixture {
var $name = 'WordTest';
var $useTable = 'words';
var $import = 'Word';
var $records = array(
array('id'=>1, 'name'=>'Table'),
array('id'=>2, 'name'=>'boy'),
array('id'=>3, 'name'=>'girl'),
);
}
?>

Эта fixture создаст таблицу test_suite_words ($useTable), и возьмёт поля с таблицы, которую использует модель Word ($import). После этого она заполнит их записями из $records.

Обычно лучше вносить свои тестовые данные, но если надо брать данные из существующей таблицы то надо $import определить так

plain text

PHP:

var $import = array('model' => 'Word', 'records' => true);

Тогда $records указвать не нужно. Вместо model можно указать table. Также можно указать connection.

При желании можно было бы не брать поля из существующей таблицы, а вручную указать их. Это может быть удобно, если таблица ещё не создана. Вот этот же пример с указаниеми полей.

plain text

PHP:

class WordTestFixture extends CakeTestFixture {
var $name = 'WordTest';
var $useTable = 'words';
var $fields = array(
'id' => array('type'=>'integer', 'key'=>'primary'),
'name' => array('type'=>'string', 'length'=>255, 'null'=>false),
'created' => 'datetime',
);
var $records = array(
array('id'=>1, 'name'=>'Table'),
array('id'=>2, 'name'=>'boy'),
array('id'=>3, 'name'=>'girl'),
);
}
?>

Опции для $fields:

type: VARCHAR - string, TEXT - text, INT - integer, FLOAT - float, DATETIME - datetime, TIMESTAMP - timestamp, TIME - time, DATE - date, BLOB - binary
key: primary, если поле AUTO_INCREMENT и PRIMARY KEY
length: если надо указать длину
null: если true, то разрешить NULL, если false, то запретить NULL
default: значение по умолчанию

Если не надо задавать дополнительных опций, то можно писать одной строкой, не создавая массив. Так например сделано в предыдущем примере для created.

Созание теста
Загружаем тестируемую модель

plain text

PHP:

loadModel('Word');

Для того, чтобы использовать fixtures, надо создать потомка тестируемой модели и уже его тестировать.

plain text

PHP:

class WordTest extends Word {
var $name = 'WordTest';
var $useTable = 'words';
var $useDbConfig = 'test_suite';
}

Дописываем тест и получаем
app/tests/cases/models/word.test.php

plain text

PHP:

loadModel('Word');
class WordTest extends Word {
var $name = 'WordTest';
var $useTable = 'words';
var $useDbConfig = 'test_suite';
}
class WordTestCase extends CakeTestCase {
var $fixtures = array('word_test');
var $model = null;
function setUp() {
}
function testCreate() {
$this->model =& new WordTest();
}
function testListFlipLow() {
$result = $this->model->generateListFlipLow();
$expected = array(
'table' => 1,
'boy' => 2,
'girl' => 3,
);
$this->assertEqual($result, $expected);
}
function testAdd() {
$result = $this->model->add('Test');
$this->assertEqual($result, 4);
$result = $this->model->generateListFlipLow();
$expected = array(
'table' => 1,
'boy' => 2,
'girl' => 3,
'test' => 4,
);
$this->assertEqual($result, $expected);
}
function tearDown() {
}
}
?>

Обратите внимание, что setUp и tearDown запускаются до и после каждого теста.

А теперь сама модель из
app/models/word.php

plain text

PHP:

class Word extends AppModel {
var $name = 'Word';
var $validate = array(
'id' => VALID_NUMBER,
'name' => VALID_NOT_EMPTY,
);
/**
* Adds a word and returns id
*
* @param string $name
* @return integer If failed to save returns false
*/
function add($name) {
$item = array(
'name' => $name,
);
$this->create();
if ($this->save($item)) {
return $this->getInsertId();
} else {
return false;
}
}
/**
* Generates list of lowercase names and its ids
*
* @return array (a(name=>id), ...)
*/
function generateListFlipLow(&$model) {
$items = $this->generateList();
foreach ($items as $id=>$name) {
$items[$id] = low($name);
}
return array_flip($items);
}
}
?>

Запускаем server.com/test.php и радуемся тому, что тесты работают