справочник_по_api:data_mappers:jig_mapper

Вы находитесь здесь: Главная » справочник_по_api » data_mappers » jig_mapper
Эта страница только для чтения. Вы можете посмотреть её исходный текст, но не можете его изменить. Сообщите администратору, если считаете, что это неправильно.
====== Jig Mapper ======

Jig Object-Document-Mapper - это реализация абстрактного класса Cursor. В этой статье описаны унаследованные методы.

Пространство имен: \DB\Jig

Расположение файла:lib/db/jig/mapper.php

===== Инициализация =====

Чтобы использовать Jig ODM, создайте соединение Jig DB. Например:
<code php>
$mapper = new \DB\Jig\Mapper(\DB\Jig $db, string $file);
</code>
Если вы хотите создать класс модели, то:
<code php>
$f3->set('DB',new DB\Jig('data/'));

class User extends \DB\Jig\Mapper {
    public function __construct() {
        parent::__construct( \Base::instance()->get('DB'), 'users.json' );
    }
}

$user = new User();
$user->load(array('@_id = ?','515c570f28de6'));
// etc.
</code>
<WRAP center round info 60%>
Первичный ключ документов Jig назван _id.
</WRAP>

===== Синтаксис =====
==== $ filter ====

$filter в Jig  имеет следующую структуру:
<code php>
// array value for parameterized queries
array( string $expr [, string $bindValue1 [, string $bindValue2 [, ...]]] )
</code>
Часть $expr должна содержать допустимый кода, где все поля mapper'а начинается с символа <wrap hi>@</wrap>. Вы можете привязать к ним значения с помощью позиционных или именованных токенов. Вот пример:
<code php>
// positional tokens
array('@username = ? and @password = ?','John','acbd18db4cc2f85cedef654fccc4a4d8')
// named tokens
array('@username = :user and @password = :pw',':user'=>'John',':pw'=>'acbd18db4cc2f85cedef654fccc4a4d8')
</code>
<WRAP center round important 60%>
Важно: Jig - это средство сопоставления документов без схемы, поэтому поля документа могут отличаться от одной записи к другой. Чтобы создать допустимую строку $expr, не забудьте добавить дополнительные проверки существования полей, чтобы предотвратить появление странных ошибок неопределенных переменных. Для этого используется isset:
</WRAP>

<code php>
array(
    '(isset(@username) && @username == ?) && (isset(@password) && @password = ?)',
    'John','acbd18db4cc2f85cedef654fccc4a4d8'
    )
</code>
Вы можете использовать все распространенные операторы сравнения в своем выражении, одиночное работает <wrap hi>=</wrap>.
=== Search===

Лучший способ поиска в Jig - использовать следующие  условия preg_match:
<code php>
$userList = $user->find(array('(isset(@email) && preg_match(?,@email))','/gmail/'));
// returns all users with an email address that contains GMAIL

// ends with gmail.com => /gmail\.com$/
// starts with john  => /^john/
</code>
Эквивалент оператора IN в SQL выглядит так:
<code php>
$user->find(array('in_array('_id',array(1,2,3))'));
</code>
Если в вашем документе используется поле массива, то есть теги, вы можете найти все сообщения по тегу, просто меняя параметры in_array:
<code php>
$post->find(array('isset(@tags) && in_array("fat-free",@tags)'));
</code>
==== $ option ====

Аргумент Jig $option  принимает имеет структуру:
<code php>
array(
	'order' => string $orderClause,
	'limit' => integer $limit,
	'offset' => integer $offset
)
  </code>
то есть:
<code php>
array(
	'order' => 'score SORT_DESC, team_name SORT_ASC',
	'limit' => 20,
	'offset' => 0
)
</code>
===== Методы =====

==== exists ====

**Вернет TRUE, если данное поле определено**
<code php>
bool exists( string $key )
</code>
==== set ====

**Присвойте значение полю**
<code php>
scalar|FALSE set( string $key, scalar $val )
</code>
Этот класс использует преимущества класса Magic и интерфейса ArrayAccess. Это означает, что вы можете устанавливать и получать переменные с прямым доступом следующим образом:
<code php>
$mapper->foo = 'bar';
$mapper['foo'] = 'bar';
</code>
==== get ====

**Получить значение поля**
<code php>
scalar|FALSE get( string $key )
  </code>
==== clear ====

**Очистить значение поля**
<code php>
NULL clear( string $key )
</code>
==== fields ====

**Возвращает имена полей объекта mapper'а**
<code php>
array fields( )
</code>
==== cast==

**Возвращает поля объектов mapper'а в виде ассоциативного массива**
<code php>
array cast( [ object $obj = NULL ] )
</code>
==== token ====

**Преобразование токенов в строковом выражении в имена переменных**
<code php>
string token( string $str )
</code>
==== find ====

**Возвращает записи, соответствующих заданному критерию**
<code php>
array|FALSE find( [ array $filter = NULL [, array $options = NULL [, int $ttl = 0 [, bool $log = TRUE ]]]] )
</code>
==== coutn ====

**Подсчет записей, соответствующих заданному критерию**
<code php>
int count( [ array $filter = NULL [, $ttl = 0 ]] )
</code>
==== insert ====

**Вставить новую запись**
<code >
array insert( )
</code>
==== update ====

**Обновить текущую запись**
<code>
array update( )
</code>
==== erase ====

**Удалить текущую запись**
<code>
bool erase( [ array $filter = NULL ] )
</code>
==== copyfrom ====

**Сопоставить объект mapper'а с помощью массива**
<code php>
NULL copyfrom( array | string $var [, callback $func = NULL ] )
</code>
Этот метод позволяет сопоставить элементы массива из hive с БД в таблице которой имена полей соответсвуют именам ключей этого массива.

$func - это функция обратного вызова, применяемая к переменной массива hive:
<code php>
if ($func)  $var = $func($var);
</code>
==== copyto ====

**Заполните переменную массива hive полями mapper'а**
<code>
NULL copyto( string $key )
</code>
==== factory ====

**Преобразование массива в объект mapper'а**
<code php>
protected object factory( string $id, array $row )
</code>
Этот метод, с областью видимости protected, используется внутри метода select.
Вы посетили:
Поиск

Навигация

Руководство

API

Ядро

Базы данных

Date mappers

Шаблонизация

Веб-сервисы

Разное

Печать/экспорт

Инструменты
