Plone API

Get Started. It's Free
or sign up with your email address
Rocket clouds
Plone API by Mind Map: Plone API

1. Per-type behaviour

1.1. Type metadata

1.1.1. getToolByName(context, 'portal_types')

1.1.2. portal_types[fti_name]

1.1.3. fti properties

1.2. Cataloging

1.2.1. Methods/attributes indexed directly

1.2.2. plone.indexer

1.3. Default view

1.3.1. ISelectableBrowserDefault

1.3.2. Method aliases

1.3.3. browser:defaultView

1.3.4. The view() method

1.4. Dynamic local roles

1.4.1. borg.localrole adapter

1.5. Workflow chain

1.5.1. IWorkflowChain

1.5.2. WorkflowTool.setChainForTypes()

1.5.3. WorkflowTool.getDefaultChain()

1.5.4. WorkflowTool.setDefaultChain()

1.5.5. WorkflowTool.listChainOverrides()

1.6. Folder behaviour

1.6.1. INonStructuralFolder

1.6.2. isPrincipaFolderish

1.6.3. ObjectManagerAPI (what is expected of a minimal folder?)

1.6.4. fti.global_allow

1.6.5. fti.filter_content_types

1.6.6. fti.allowed_content_types

1.7. Discussion

1.7.1. fti.allow_discussion

1.8. Versioning

1.8.1. ?

1.9. Icon

1.9.1. IPloneView.getIcon()

2. Site state

2.1. Get root

2.1.1. getUtility(ISiteRoot)

2.1.2. getToolByName(context, 'portal_url').getPortalObject()

2.1.3. getSite()

2.1.4. navigation root

2.2. Current settings

2.2.1. IPortalState/@@plone_portal_state

2.2.2. getToolByName(context, 'portal_properties')

2.2.3. portal_properties[property_sheet_name]

2.2.4. property API

2.2.5. plone.registry

2.2.6. various tools?

2.2.7. @@plone view

2.3. Get tools

2.3.1. getToolByName()

2.3.2. getUtility()

3. Users

3.1. User CRUD

3.1.1. PAS APIs

3.1.2. MembershipTool

3.1.3. RegistrationTool

3.2. Group GRUD

3.2.1. PAS APIs

3.2.2. GroupsTool

3.2.3. GroupDataTool

3.3. User properties

3.3.1. user.getProperty()

3.3.2. member.getProperty()

3.3.3. MemberDataTool methods

3.4. Roles

3.4.1. user.getRoles()

3.4.2. user.getRolesInContext()

3.4.3. validRoles()

3.4.4. _addRole()

3.5. Groups

3.5.1. user.getGroups()

3.6. PAS Plugins

3.6.1. Plugin CRUD

3.6.2. Plugin activation

3.6.3. Plugin interfaces

4. Object state

4.1. Common

4.1.1. IContextState/@@plone_context_state

4.2. Id

4.2.1. UID() (Archetypes)

4.2.2. zope.[app.]intid methods

4.3. URL

4.3.1. absolute_url()

4.3.2. getPhysicalPath()

4.3.3. request.physicalPath*()

4.4. Schema data

4.4.1. Archetypes

4.4.2. queryContentType()

4.4.3. zope.schema.getFields()

4.4.4. zope.schema.Field.get()/set()

4.4.5. getTypeInfo

4.5. Workflow

4.5.1. getInfoFor()

4.5.2. doActionFor()

4.5.3. Workflow API

4.5.3.1. States

4.5.3.2. Transitions

4.5.3.3. Workflow variables

4.6. Security

4.6.1. manage_permission()

4.6.2. getSecurityManager()

4.6.3. AccessControl.checkPermission() vs. zope.security.checkPermission()

4.6.4. Defining new permissions

4.6.4.1. ZCML

4.6.4.2. setDefaultRoles()

4.6.4.3. collective.autopermission

4.6.5. permissionsOfRole() / rolesOfPermission()

4.6.6. Protecting

4.6.6.1. <class><require /></class>

4.6.6.2. ClassSecurityInfo

4.6.6.3. <browser:page />

4.7. Metadata

4.7.1. IDublinCore

4.7.2. getId()

5. OFS

5.1. Content object CRUD

5.1.1. invokeFactory()

5.1.2. createObject()

5.1.3. _createObjectByType()

5.1.4. OFS API

5.1.5. plone.folder API

5.2. Copy/paste

5.2.1. OFS copy/paste

5.3. Clone

5.3.1. OFS clone

5.3.2. Python copy?

5.4. Folder listing

5.4.1. OFS

5.4.2. plone.folder

5.4.3. getFolderContents.py

5.5. Traversal

5.5.1. aq_inner

5.5.2. aq_parent

5.5.3. aq_chain

5.5.4. __parent__

5.5.5. restrictedTraverse()

5.5.6. unrestrictedTraverse()

6. Search

6.1. Catalog search

6.1.1. getToolByName(context, 'portal_catalog')

6.1.2. catalog() / catalog.searchResults()

6.1.3. catalog.unrestrictedSearchResults()

6.2. Brains

6.2.1. getObject()

6.2.2. getURL()

6.2.3. getPath()

6.2.4. Exposure of metadata

6.3. Catalog indexes/metadata

6.3.1. Index CRUD

6.3.2. Column CRUD

7. Storage

7.1. Persistence

7.1.1. Persistent base class

7.1.2. _p_jar

7.1.3. _p_changed

7.1.4. _p_mtime

7.2. BTrees

7.2.1. How/when to use

7.3. Annotations

7.3.1. IAnnotatable

7.3.2. IAttributeAnnotatable

7.3.3. IAnnotations

7.3.4. zope.annotation.factory

7.4. Transactions

7.4.1. commit()

7.4.2. savepoint()

7.4.3. abort()

7.4.4. doom()

7.4.5. get()

8. Portlets

8.1. Creating portlets

8.2. Assignment CRUD

8.3. Blacklisting

9. Content rules

9.1. Creating actions/conditions

9.2. Content rule CRUD

9.3. Rule assignments

10. Tiles

10.1. Creating tiles

11. Templates

11.1. Creating views

11.2. Creating viewlets

11.3. TAL

11.4. Utility functions

11.4.1. pretty_title_or_id

11.4.2. batching

11.5. documentation of the templates and scripts in the CMFPlone layers and what they do

11.6. Javascript helpers

11.6.1. collapsibles

11.6.2. cookie functions

11.6.3. tabbed forms

11.6.4. table sorter

12. Forms

12.1. Edit forms

12.2. Page forms

12.3. Sub forms

13. Types

13.1. Archetypes

13.2. Dexterity

14. Object events

14.1. CRUD

14.1.1. IObjectAddedEvent

14.1.2. IObjectRemovedEvent

14.1.3. IObjectMovedEvent

14.1.4. IObjectCreatedEvent

14.1.5. IObjectModifiedEvent

14.2. Workflow

14.2.1. IActionSucceededEvent

14.2.2. IBeforeTransitionEvent

14.2.3. IAfterTransitionEvent

14.3. Traversal

14.4. Transactions

15. GenericSetup

15.1. metadata.xml

15.2. structure/

15.3. actions.xml

15.4. browserlayer.xml

15.5. catalog.xml

15.6. componentregistry.xml

15.7. controlpanel.xml

15.8. css_registry.xml

15.9. factorytool.xml

15.10. jsregistry.xml

15.11. kssregistry.xml

15.12. memberdata_properties.xml

15.13. portal_atct.xml

15.14. portlets.xml

15.15. contentrules.xml

15.16. properties.xml

15.17. propertiestool.xml

15.18. rolemap.xml

15.19. skins.xml

15.20. types.xml + types/*

15.21. workflows.xml + workflows/*

15.22. viewlets.xml

16. Tools

16.1. Create/install tool

16.2. Local utility

16.2.1. Registration

16.2.2. ++etc++site

17. i18n / l10n

17.1. toLocalizedTime

17.2. zope.i18n.translate

17.3. i18n vs. locales folder

17.4. i18ndude