Spec-Zone.ru › CakePHP 2.8

Класс ClassRegistry

Коллекции классов.

Хранилище объектов класса, каждый из которых зарегистрирован с ключом. Если вы попытаетесь добавить объект с тем же ключом дважды, ничего не произойдёт. Если вам нужен второй экземпляр объекта, присвойте ему другой ключ.

Пакет: Cake\Утилиты
Авторские права: Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
Лицензия: Лицензия MIT
Расположение: Cake/Utility/ClassRegistry.php

Краткое описание свойств

  • $_config protected
    array
    Параметры по умолчанию для конструктора, индексированные по типу
  • $_map protected
    array
    Имена имён классов, сопоставленных с объектом в реестре.
  • $_objects protected
    array
    Имена классов с их объектами.

Краткое описание методов

  • _duplicate() protected
    Проверяет, является ли $alias дубликатом $class Object
  • _getMap() protected
    Возвращает имя класса в реестре.
  • addObject() public static
    Добавляет $object в реестр, связывая его с именем $key.
  • config() public static
    Устанавливает параметры конструктора по умолчанию для типа объекта
  • flush() public static
    Очищает все объекты из ClassRegistry.
  • getInstance() public static
    Возвращает единственный экземпляр ClassRegistry.
  • getObject() public static
    Возвращает объект, соответствующий заданному ключу.
  • init() public static

    Загружает класс, регистрирует объект в реестре и возвращает экземпляр объекта. ClassRegistry::init() используется в качестве фабрики для моделей и обрабатывает правильное внедрение настроек, что помогает в тестировании.

  • isKeySet() public static
    Возвращает true, если заданный ключ присутствует в ClassRegistry.
  • keys() public static
    Получить все ключи из реестра.
  • map() public static
    Добавляет пару ключ-значение в реестр, чтобы сопоставить имя с классом в реестре.
  • mapKeys() public static
    Получить все ключи из карты в реестре.
  • removeObject() public static
    Удаляет объект, соответствующий заданному ключу.

Подробное описание методов

_duplicate()source protected

_duplicate( string $alias , string $class )

Проверяет, является ли $alias дубликатом $class Object

Параметры

строка $alias
Ключ для проверки.
строка $class
Имя класса.

Возвращает

boolean

_getMap()source protected

_getMap( string $key )

Возвращает имя класса в реестре.

Параметры

строка $key
Ключ для поиска в карте

Возвращает

строка
Сопоставленное значение

addObject()source public static

addObject( string $key , object $object )

Добавляет $object в реестр, связывая его с именем $key.

Параметры

строка $key
Ключ для объекта в реестре
объект $object
Объект для хранения

Возвращает

boolean
True, если объект был записан, false, если $key уже существует

config()source public static

config( string $type , array $param array() )

Устанавливает параметр конструктора по умолчанию для типа объекта

Параметры

строка $type
Тип объекта. Если этот параметр опущен, по умолчанию используется "Модель"
массив $param опционально array()

Параметр, который будет передан в конструкторы объектов при создании объектов типа $type

Возвращает

смешанное

Пустое значение, если $param устанавливается. В противном случае, если передан только $type, возвращает ранее установленное значение $param или null, если оно не установлено.


flush()source public static

flush( )

Очищает все объекты из ClassRegistry.

getInstance()source public static

getInstance( )

Возвращает единственный экземпляр ClassRegistry.

Возвращает

ClassRegistry
экземпляр

getObject()source public static

getObject( string $key )

Возвращает объект, соответствующий заданному ключу.

Параметры

строка $key
Ключ искомого объекта

Возвращает

смешанное
Объект, хранящийся в реестре, или boolean false, если объект не существует.

init()source public static

init( string|array $class , boolean $strict false )

Загружает класс, регистрирует объект в реестре и возвращает экземпляр объекта. ClassRegistry::init() используется в качестве фабрики для моделей и обрабатывает правильное внедрение настроек, что помогает в тестировании.

Примеры Простое использование: Получить экземпляр модели Post ClassRegistry::init('Post');<pre>Expanded:array('class' => 'ClassName', 'alias' => 'AliasNameStoredInTheRegistry');```

Классы моделей могут принимать необязательные <span class="php-keyword1">array</span>(<span class="php-quote">'id'</span> =&gt; <span class="php-var">$id</span>, <span class="php-quote">'table'</span> =&gt; <span class="php-var">$table</span>, <span class="php-quote">'ds'</span> =&gt; <span class="php-var">$ds</span>, <span class="php-quote">'alias'</span> =&gt; <span class="php-var">$alias</span>);

Когда $class является массивом с числовыми ключами, несколько экземпляров class будут сохранены в реестре, и ни один экземпляр объекта не будет возвращен массив( массив('class' => 'ClassName', 'alias' => 'AliasNameStoredInTheRegistry'), массив('class' => 'ClassName', 'alias' => 'AliasNameStoredInTheRegistry'), массив('class' => 'ClassName', 'alias' => 'AliasNameStoredInTheRegistry') ); ```

Параметры

строка|массив $class

в виде строки или массива с одним ключом => значение, создается экземпляр, хранится в реестре и возвращается.

логическое значение $strict опционально false

если установлено в true, оно вернет false, если класс не был найден, вместо того, чтобы пытаться создать AppModel

Возвращает


экземпляр $class класса ClassName.

Исключения

CakeException
при попытке создать интерфейс или абстрактный класс.

isKeySet()source public static

isKeySet( string $key )

Возвращает true, если заданный ключ присутствует в ClassRegistry.

Параметры

строка $key
Ключ для поиска

Возвращает

boolean
true, если ключ существует в реестре, false в противном случае

keys()source public static

keys( )

Получить все ключи из реестра.

Возвращает

массив
Множество ключей, хранящихся в реестре
END_OF_DOCUMENT_MARKER

map()source public static

map( string $key , string $name )

Добавить пару ключ-значение в реестр для сопоставления имени с классом в реестре.

Параметры

строка $key
Ключ для включения в карту
строка $name
Ключ, который сопоставляется

mapKeys()source public static

mapKeys( )

Получить все ключи из карты в реестре.

Возвращает

массив
Ключи карты реестра

removeObject()source public static

removeObject( string $key )

Удалить объект, соответствующий заданному ключу.

Параметры

строка $key
Ключ объекта для удаления из реестра

Подробное описание свойств

$_configsource

protected массив

Параметры по умолчанию для конструктора, индексированные по типу

array()

$_mapsource

protected массив

Имена имён классов, сопоставленных с объектом в реестре.

array()

$_objectssource

protected массив

Имена классов с их объектами.

array()

© 2005–2016 The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
http://api.cakephp.org/2.8/class-ClassRegistry.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API