Overview
News
Documents
Forums
Wiki
People
Subscribe to Feeds
Описание
=========
Вся система работы с контентными типами находится в пакете `z3ext.content.type
`_ определяет два поля, `title` и `description`.
Это очень важно чтобы каждый контентный тип имел эти поля, потому
что они используютя во различных частях системы. Как вы видите интерфейс
очень простой. Наш `MessageBoard` клас будет иметь только `title` и `description`.
Теперь интерфейс для `Message`::
from zope import schema, interface
from z3ext.richtext.field import RichText
class IMessage(interface.Interface):
"""A message object."""
title = schema.TextLine(
title=u"Title/Subject",
description=u"Title and/or subject of the message.",
default=u"",
required=True)
body = RichText(
title=u"Message Body",
description=u"This is the actual message. Type whatever you wish.",
default=u"",
required=True)
Для этого интерфейса мы не исползуем IItem, но мы все равно должны
предоставить доступ к `description`. Для `body` мы используем `RichText field
`_
из пакета `z3ext.richtext `_
Реализация класов
=================
Начнем с простого клаcса `MessageBoard`::
from zope import interface
from z3ext.content.container import ContentContainer
from z3ext.tutorial.interfaces import IMessageBoard
class MessageBoard(ContentContainer):
"""A very simple implementation of a message board """
interface.implements(IMessageBoard)
Этот клас очень простой, единственно нужно пояснение по поводу `ContentContainer`.
Наследование от ContentContainer сделанно просто чтобы упростить реализацию.
`ContentContainer `_
есть не что иное как `BTreeContainer` из `zope.app.container`. Также он реализует
интерфейс `IContentContainer `_.
В отличае от стандартного контейнера в котором если есть доступ к
методу `__delitem__`, можно удалить любой элемент контейнера,
в `ContentContainer` нужно еще иметь permission `z3ext.DeleteContent` для самого
удаляемого элемента. Несмотря на то что клас очень простой этого достаточно
для создания достаточно сложных приложений.
Теперь клас для `Message`::
from zope import interface
from z3ext.content.item import PeristentItem
from z3ext.tutorial.interfaces import IMessage
class Message(PersistentItem):
"""A simple implementation of a message."""
interface.implements(IMessage)
Этот клас использует `PersistentItem`. Что примечательного в
`Item `_. Этот клас использует несколько интерфейсов
маркеров, `IAttributeAnnotatable` и `IOwnerAware `_.
И хранит значения в title и description в `ICMFDublinCore`.
Немного информации о владелце обьекта `IOwnership `_.
object ownership реализуется в пакете
`z3ext.ownership `_,
`messageboard.py `_,
`topic.py `_
Регистрация контентных типов в z3ext
=====================================
Последний шаг в реализации контентного типа это регистрация в z3ext. Это
делается с помощью директивы `z3ext:content`.
Регистрация для `Message`, контент тип называется `z3ext.tutorial.Message`::
Детальное описание директивы `z3ext:content
`_
name
Имя регистрируемого типа, уникально в системе.
title
Название типа используемого для пользовательского интерфейса
description
Краткое описание типа используемого для пользовательского интерфейса
schema
Интерфейс который описывает контент тип, также используется для
генерации `add form` и `edit form`
class
Класс обьекта
contains
Список типов которые может содержать данный тип
containers
Контент типы которые могут содержать данный тип
contenttype
`custom` реализация `IContentType`
permission
Permission который позволяет добавлять данный контент тип в контекст
Что происходит в процесе регистрации контент типа в z3ext. Во первых
происходит создание специального обьекта который реализует интерфейс
IContentType. Так же для каждого типа происходит создание интерфейса.
Название интерфейса генерится из имени контент типа, например для
нашего типа 'z3ext.tutorial.Message' сгенерится интерфейс z3ext_tutorial_Message
Этот интерфейс будет доступен таким образом::
z3ext.content.z3ext_tutorial_Message
Также созданный IContentType обьект будет реализовывать этот интерфейс.
IContentType обьект контролирует множество аспектов жизни контент типа.
Создание обьекта, проверка permissions, contraints, формы добавления, и много
другое. Вы можете предоставить вашу собственную реализацию этого
обьекта и это открывает намного больше возможновтей. Допустим при добавлении
обьекта вы можете добавлять его в другое место отльчное от того где
создается контент. Так же с помощиью этого обьекты вы можете создавать
контент в питоновском коде. Этот обьект регистрируется в системе как утилита
с таким же именем как и конент тип. т.е. вы можете получить этот
обьект таким образом::
from zope.component import getUtility
from z3ext.content.interfaces import IContentType
getUtility(IContentType name='z3ext.tutorial.Message')
И создать контентный обьект так::
contenttype = getUtility(IContentType name='z3ext.tutorial.Message')
message = contenttype.create()
Можно также добавить контент тип в контексте, на этом этапе происходит проверка
permission, также проверяется `contraints` (containers, contains)::
# вам нужен контекст `context`
contenttype = contenttype.__bind__(context)
contenttype.add(content, name='object name')
Теперь регистрация для `MessageBoard`. Единственное отличие аттрибут `contains`,
который указывает, что `MessageBoard` может содержать только
`z3ext.tutorial.Topic` обьекты.::
Подводя итоги
=============
Весь процес создания контент тиапов сводится к нескольким шагам
1. Создание интерфейсов
2. Реализация класов
3. Регистрация конент типов с помощью `z3ext:content` директивы
Замечания по реализации
========================
Мы используем IContainerNamesContainer для MessageBoard и Topic, чтобы програмно
выбирать `id` для топиков и сообщений.
Links
~~~~~
* Egg `z3ext.content.type
Russian section
ActionsNotificationsLog in
|
Создание конетных типов в z3extЭта глава содержит базовую информацию о контентной системе z3ext.
Разработчик должен быть знаком с основными концепциями и иметь
опыт работы с zope3. Здесь используется MessageBoard пакет который
используется в "Zope Developer's Book" Stephen Ritcher.
Мы создадим версию MessageBoard для z3ext.
|
SearchSpaces
|
