cornerstone.ui.result 1.0-beta1

A result can have the following attributes:

• for=”*” (the interface the result is bound to)

• class=”.env.TestResult” (the class providing the results itself)

• permission=”zope.Public” (the permission to view the result)

• name=’testresult’ (the name under which the result can be called as contentprovider)

• slicesize=”20” (the size of the result slice, optional)

• threshold=”20” (the threshold how many results are required to display batches, optional)

A Batch can have the following attributes:

• domain=”testbatch” (the domain of this batch. this is used to differ the batch from perhaps other rendered batches on the same page)

• vocab=”.env.TestBatchVocab” (the class providing the batch vocab)

• template=”templates/batch.pt” (the template used to render the batch, optional)

• firstpagelink=”True” (flag wether to display the firstpagelink or not, optional)

• lastpagelink=”True” (flag wether to display the lastpagelink or not, optional)

• prevpagelink=”True” (flag wether to display the prevpagelink or not, optional)

• nextpagelink=”True” (flag wether to display the nextpagelink or not, optional)

• batchrange=”30” (the batchrange. defines how many pages are displayed, f.e. “<< < … 5 6 7 8 … > >>”, optional)

• masters=”anotherbatchdomain” (Batch(es) the defined batch depends on, the value must be the domain of the batch(es) you want to consider)

• title=”The Title” (An optional title to label the batch)

• forcedisplay=”True” (An optional flag wether to force batch displaying or not)

• querywhitelist=”sort” (Query Params to be considered when generating urls. This is needed if you have to use some additional params in the slice)

The slice definitions are treated as viewlet definitions and therefor follow

the viewlet definition rules:

• class=”.browser.directory.DirectoryListingSlice”

• name=”directoryslice”

• template=”templates/directory_listing.pt”

• allowed_interface=”Products.Directory.browser.interfaces.IDirectoryListing”

The example pointed above implements an alphabatched directory listing and

subclasses therfor this objects:

• cornerstone.ui.result.result.ResultBase

• cornerstone.ui.result.batch.AlphaBatchVocabBase

• cornerstone.ui.result.slice.AlphaBatchedSliceBase

The result class:

class DirectoryListingResult(ResultBase):

    name = 'directory.directorylisting'

    @property
    def results(self):
        return self._getEntries({
            'meta_type': 'DirectoryEntry',
            'path': '/'.join(self.context.getPhysicalPath()),
        })

    def _getEntries(self, query):
        catalog = getToolByName(self.context, 'membrane_tool')
        brains = catalog(**query)
        entries = []
        for brain in brains:
            entry = dict()
            entry['name'] = brain.Title
            entry['email'] = brain.getEmail
            entry['url'] = brain.getURL()
            entry['review_state'] = brain.review_state
            entries.append(entry)
        return entries

Consider:

• since there is no senceful way to determine the name under which a specific ViewletManager is registered out of itself you must provide the name attribute.

• further you have to provide the results. in the example above it is a list of dictionaries. of course this is the format (list of dicts) the framework can handle well at the moment. in future there will be also base implementations be able to handle catalog brains.

• the result implementing class is used by the other needed classes to extract the batch informations and the slice informations

The batch vocab class:

# pages definitions will be looked up by an adapter in future
pages = [
    'A', 'B', 'C', 'D', 'E', 'F', 'G', 'H', 'I', 'J', 'K', 'L', 'M',
    'N', 'O', 'P', 'Q', 'R', 'S', 'T', 'U', 'V', 'W', 'X', 'Y', 'Z',
]

class DirectoryBatchVocab(AlphaBatchVocabBase):

    @property
    def vocab(self):
        visibles = self.getVisiblesFromDictList('name')
        return self.generateVocab(visibles, pages)

Consider:

• The base class AlphaBatchVocabBase can handle results which are a list of dicts and does most of the work for you. As written earlier there should be also a base implementation for handling brain based result lists.

• the page list is needed to calculate an alphabatch (it is not necessary for numeric batches) and must be available in the class defining the batch vocab and the result slice itself, see below. This should be looked up by an interface in future

The slice class:

class DirectoryListingSlice(AlphaBatchedSliceBase):

    @property
    def entries(self):
        key = 'name'
        batchname = 'directorybatch'
        self.pages = pages
        self.sortResults(key)
        current = self.determineCurrentPage(batchname, key)
        return self.generateCurrentSlice(current, key)

Enable KSS:

KSS is enabled by defult when applying the extension profile.

To enable kss for anonymous users too, you have to change the condition of kukit.js in the portal_javascripts resource registry.

Consider:

• In this subclass the same rules for results applies as for the batch vocab base class.

• you have to provide the batchname this slice is used for

• the pages global is here used too. see statement why framework is alpha state.