File Collections.lua

Functions

Collections:getCollPath (coll, sep) Get path to collection or set.
Collections:getFullCollPath (coll, sep) Get path to collection or set, except if parent is publish service, it's included as root component in path.
Collections:new (t) Constructor for new instance.
Collections:newClass (t) Constructor for extending class.


Functions

Collections:getCollPath (coll, sep)
Get path to collection or set.

Parameters:

  • coll: (Lr collection, or set, required) can not be nil, but can be a special collection.
  • sep: (string, default: app--path-sep) path separator.

Usage:

    assuming coll is a collection, even if special. 

Return values:

  1. path (string) If no parent returns collection name, even if special.
  2. comp (array of strings) components, in case you want to roll your own path or sub-path.. last element is name of collection itself.
Collections:getFullCollPath (coll, sep)
Get path to collection or set, except if parent is publish service, it's included as root component in path.

Parameters:

  • coll: (LrCollection, required) can not be nil, but can be a special collection.
  • sep: (string, default: app--path-sep) path separator.

Usage:

    assuming coll is a collection, even if special. 

Return values:

  1. path (string) If no parent returns collection name, even if special.
  2. comp (array of strings) components, in case you want to roll your own path or sub-path.. last element is name of collection itself.
Collections:new (t)
Constructor for new instance.

Parameters:

  • t:
Collections:newClass (t)
Constructor for extending class.

Parameters:

  • t:

Valid XHTML 1.0!