Amiro.CMS API Reference
Amiro.Ru / Manual
Loading search...

The AMI_PageManager class

• Introduction

Site Manager pages service class.

• Class synopsis

AMI_PageManager {
/* Methods */
// Returns default (main) page Id for locale in Site Manager.
public static getDefaultPageId ( [ bool $reload = FALSE ], [ string $locale = 'auto' ] ) returns int;
// Returns default (main) page Id for locale in Site Manager.
public static getDefaultPageIds ( [ bool $reload = FALSE ] ) returns array;
// Returns module link by its id and page id.
public static getModLink ( string $modId, [ string $locale = 'en' ], [ int $pageId = 0 ], [ bool $suppressError = FALSE ], [ bool $prependLocale = FALSE ] ) returns string|false;
// Searchs page in Page Manager by link.
public static searchByLink ( string $link, [ bool $asModel = TRUE ] ) returns AMI::getResourceModel('pages/table/item')|array;
// Returns module link by its id and page id.
public getPageItemData ( string $modId, string $locale, int $pageId ) returns mixed;
}
Tags:
since 5.10.0

• Class Methods

// Returns default (main) page Id for locale in Site Manager.
public static getDefaultPageId ( [ bool $reload = FALSE ], [ string $locale = 'auto' ] ) returns int;
  • bool $reload
    Flag specifying to reload data from locales model
  • string $locale
    Locale, if not passed current data locale will be used
// Returns default (main) page Id for locale in Site Manager.
public static getDefaultPageIds ( [ bool $reload = FALSE ] ) returns array;
  • bool $reload
    Flag specifying to reload data from locales model
  • string $modId
    Module id
  • string $locale
    Locale
  • int $pageId
    Page id (used for multipage modules)
  • bool $suppressError
    Flag specifying to suppress error if there is no page in page manager (since 5.14.4)
  • bool $prependLocale
    Flag specifying to prepend locale part for multilingual mode (since 5.14.8)
  • string $link
    Link
  • bool $asModel
    Flag specifying to return result as table item model
Tags:
since 6.0.2
// Returns module link by its id and page id.
public getPageItemData ( string $modId, string $locale, int $pageId ) returns mixed;
  • string $modId
    Module id
  • string $locale
    Locale
  • int $pageId
    Page id (used for multipage modules)