Spec-Zone.ru › CakePHP 2.7

Класс ClassRegistry

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

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

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

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

_duplicatesource protected

_duplicate( string $alias , string $class )

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

Параметры

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

Возвращает

boolean
bool

_getMapsource protected

_getMap( string $key )

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

Параметры

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

Возвращает

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

addObjectsource public static

addObject( string $key , object $object )

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

Параметры

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

Возвращает

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

configsource public static

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

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

Параметры

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

Возвращает

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

flushsource public static

flush( )

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

getInstancesource public static

getInstance( )

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

Возвращает

ClassRegistry
экземпляр

getObjectsource public static

getObject( string $key )

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

Параметры

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

Возвращает

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

initsource public static

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

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

Примеры Простое использование: Получение экземпляра модели Post ClassRegistry::init('Post');

Расширенное: array('class' => 'ClassName', 'alias' => 'AliasNameStoredInTheRegistry');

Классы моделей могут принимать необязательные array('id' => $id, 'table' => $table, 'ds' => $ds, 'alias' => $alias);

Когда $class — массив с числовыми ключами, в реестре будут храниться несколько экземпляров класса, ни один экземпляр объекта не будет возвращен

array(
        array('class' => 'ClassName', 'alias' => 'AliasNameStoredInTheRegistry'),
        array('class' => 'ClassName', 'alias' => 'AliasNameStoredInTheRegistry'),
        array('class' => 'ClassName', 'alias' => 'AliasNameStoredInTheRegistry')
);

Параметры

строка/массив $class
в виде строки или массива с одиночным ключом => значение, экземпляр будет создан, сохранен в реестре и возвращен.
булево $strict необязательный false
если установлено в true, то вернет false, если класс не найден, вместо попытки создать AppModel

Возвращает

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

Исключение

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

isKeySetsource public static

isKeySet( string $key )

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

Параметры

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

Возвращает

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

keyssource public static

keys( )

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

Возвращает

array
Набор ключей, хранящихся в реестре

mapsource public static

map( string $key , string $name )

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

Параметры

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

mapKeyssource public static

mapKeys( )

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

Возвращает

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

removeObjectsource 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.7/class-ClassRegistry.html

Spec-Zone.ru

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