Class CMS_rowsCatalog

Description
Description | Methods (details) Constants

Class CMS_rowsCatalog

Represents a collection of rows

Located in /automne/classes/modules/standard/rowscatalog.php (line 26) 

CMS_grandFather
   |
   --CMS_rowsCatalog
Method Summary
Description | Constants Methods (details)
static boolean fromArray (array $data, array $params, CMS_language $cms_language,  &$idsRelation,  &$infos, array $idsRelation, string $infos)
static void getAll ([ $includeInactive = false], [ $keyword = ''], [ $groups = array()], [ $rowIds = array()], [ $user = false], [integer $tplId = false], [string $csId = false], [integer $start = 0], [integer $limit = 0], [ $returnObjects = true], [ &$score = array()], CMS_profile_user $cms_user, integer $count)
static array(string) getAllGroups ([ $returnStack = false], [ $reset = false])
static array getAllIcons ()
static CMS_row getByID (integer $id, [integer $tagID = false])
static array getByModules ([array $modules = array()], [boolean $returnObjects = true], [boolean $exclusive = true])
static a getCloneFromID ([anyRowID $rowID = 0], [String $label = false], [boolean $setPrivate = false])
static array getPagesByRow (integer $rowID, [boolean $returnObjects = false], [boolean $public = false])
static array getRowsByPage (integer $pageId, [boolean $returnObjects = false])
static mixed rowExists (string $module, string $uuid)
static boolean uuidExists (string $uuid)
Methods
Description | Constants Methods (details)
static fromArray (line 477)

Import module from given array datas

  • return: : true on success, false on failure
  • access: public
static boolean fromArray (array $data, array $params, CMS_language $cms_language,  &$idsRelation,  &$infos, array $idsRelation, string $infos)
  • array $data: The module datas to import
  • array $params: The import parameters. array( module => false|true : the module to create rows (required) create => false|true : create missing objects (default : true) update => false|true : update existing objects (default : true) files => false|true : use files from PATH_TMP_FS (default : true) )
  • CMS_language $cms_language: The CMS_langage to use
  • array $idsRelation: : Reference : The relations between import datas ids and real imported ids
  • string $infos: : Reference : The import infos returned
  • &$idsRelation
  • &$infos
static getAll (line 56)

Return all the rows available

  • access: public
static void getAll ([ $includeInactive = false], [ $keyword = ''], [ $groups = array()], [ $rowIds = array()], [ $user = false], [integer $tplId = false], [string $csId = false], [integer $start = 0], [integer $limit = 0], [ $returnObjects = true], [ &$score = array()], CMS_profile_user $cms_user, integer $count)
  • CMS_profile_user $cms_user: : restrict to user rights on modules (default : false)
  • integer $tplId: : restrict to rows usable in given template (default : false)
  • string $csId: : restrict to rows usable in given clientspace (default : false)
  • integer $start: : start position
  • integer $limit: : limit position
  • integer $count: : number of rows founded (passed by reference)
  • $includeInactive
  • $keyword
  • $groups
  • $rowIds
  • $user
  • $returnObjects
  • &$score
static getAllGroups (line 184)

Get All Groups Static function

  • access: public
static array(string) getAllGroups ([ $returnStack = false], [ $reset = false])
  • $returnStack
  • $reset
static getAllIcons (line 387)

Return all rows icons available on the server

  • return: : rows images path (from webroot)
  • access: public
static array getAllIcons ()
static getByID (line 36)

Return a row by its ID (and tagID)

  • access: public
static CMS_row getByID (integer $id, [integer $tagID = false])
  • integer $id: The DB ID of the wanted row
  • integer $tagID: The tag ID attribute of the wanted row
static getByModules (line 412)

Return all rows which uses given modules

  • return: : rows
  • access: public
static array getByModules ([array $modules = array()], [boolean $returnObjects = true], [boolean $exclusive = true])
  • array $modules: modules : the modules codename to search rows for
  • boolean $returnObjects: returnObjects : does the function return array of ids or array of objects (default)
  • boolean $exclusive: exclusive : does the function return rows which only contain requested modules (default : true)
static getCloneFromID (line 231)

public static getCloneFromID

Clones a Row, changes some attributes and writes it to persistence (MySQL for now)

  • return: valid new CMS_row
static a getCloneFromID ([anyRowID $rowID = 0], [String $label = false], [boolean $setPrivate = false])
  • boolean $setPrivate: Should the template be set as a private one ? ALSO determines if the new row should point to the same file
  • anyRowID $rowID: as the ID of Row to be cloned
  • String $label: label receive a new label for this Row
static getPagesByRow (line 297)

Return pages IDs coresponding of a given row ID

  • return: : pages IDs or pages objects
  • access: public
static array getPagesByRow (integer $rowID, [boolean $returnObjects = false], [boolean $public = false])
  • integer $rowID: rowID : the row to get pagesIDs
  • boolean $returnObjects: returnObjects : to return pages objects or pages IDs
  • boolean $public: public : targets edited or public clientspaces
static getRowsByPage (line 339)

Return rows ID used by a given page

  • return: : rows IDs or rows objects
  • access: public
static array getRowsByPage (integer $pageId, [boolean $returnObjects = false])
  • integer $pageId: pageId : the row to get pagesIDs
  • boolean $returnObjects: returnObjects : to return rows objects or rows IDs (default : false)
static rowExists (line 527)

Does a row exists with given parameters this method is use by fromArray import method to know if an imported row already exist or not

  • return: : integer id if exists, false otherwise
  • access: public
static mixed rowExists (string $module, string $uuid)
  • string $module: The module codename to check
  • string $uuid: The row uuid to check
static uuidExists (line 562)

Does given uuid already exists for rows

  • access: public
static boolean uuidExists (string $uuid)
  • string $uuid: The uuid to check

Inherited Methods

Inherited From CMS_grandFather

CMS_grandFather::autoload()
CMS_grandFather::hasError()
CMS_grandFather::log()
CMS_grandFather::PHPErrorHandler()
CMS_grandFather::raiseError()
CMS_grandFather::setDebug()
CMS_grandFather::setLog()
CMS_grandFather::_raiseError()
CMS_grandFather::__call()
Class Constants
Description | Constants (details) | Methods (details)

Inherited Constants

Inherited from CMS_grandFather

CMS_grandFather::ERROR_LOG
 CMS_grandFather::SYSTEM_LABEL

Documentation generated on Wed, 15 Feb 2012 15:38:42 +0100 by phpDocumentor 1.4.3