XpressEngine Core  1.11.2
 All Classes Namespaces Files Functions Variables Pages
Public Member Functions | Public Attributes | List of all members
layoutModel Class Reference
Inheritance diagram for layoutModel:
layout ModuleObject BaseObject

Public Member Functions

 init ()
 
 getLayoutList ($site_srl=0, $layout_type="P", $columnList=array())
 
 getLayoutInstanceListForJSONP ()
 
 getLayoutInstanceList ($siteSrl=0, $layoutType= 'P', $layout=null, $columnList=array())
 
 isExistsLayoutFile ($layout, $layoutType)
 
 getLayout ($layout_srl)
 
 getLayoutRawData ($layout_srl, $columnList=array())
 
 getLayoutPath ($layout_name="", $layout_type="P")
 
 getDownloadedLayoutList ($layout_type="P", $withAutoinstallInfo=false)
 
 sortLayoutByTitle ($a, $b)
 
 getInstalledLayoutCount ($layoutType= 'P')
 
 _getInstalledLayoutDirectories ($layoutType= 'P')
 
 getLayoutInfo ($layout, $info=null, $layout_type="P")
 
 getUserLayoutImageList ($layout_srl)
 
 getUserLayoutIniConfig ($layout_srl, $layout_name=null)
 
 getUserLayoutPath ($layout_srl)
 
 getUserLayoutImagePath ($layout_srl)
 
 getUserLayoutCss ($layout_srl)
 
 getUserLayoutFaceOffCss ($layout_srl)
 
 _getUserLayoutFaceOffCss ($layout_srl)
 
 getUserLayoutTempFaceOffCss ($layout_srl)
 
 getUserLayoutHtml ($layout_srl)
 
 getUserLayoutTempHtml ($layout_srl)
 
 getUserLayoutIni ($layout_srl)
 
 getUserLayoutTempIni ($layout_srl)
 
 getUserLayoutCache ($layout_srl, $lang_type)
 
 getLayoutCache ($layout_name, $lang_type, $layout_type='P')
 
 getDefaultLayoutIni ($layout_name)
 
 getDefaultLayoutHtml ($layout_name)
 
 getDefaultLayoutCss ($layout_name)
 
 getDefaultLayoutPath ()
 
 useDefaultLayout ($layout_name)
 
 setUseUserLayoutTemp ($flag='temp')
 
 getUserLayoutTempFileList ($layout_srl)
 
 getUserLayoutFileList ($layout_srl)
 
 doActivateFaceOff (&$layout_info)
 
- Public Member Functions inherited from layout
 moduleInstall ()
 
 checkUpdate ()
 
 moduleUpdate ()
 
 recompileCache ()
 
- Public Member Functions inherited from ModuleObject
 setModule ($module)
 
 setModulePath ($path)
 
 setRedirectUrl ($url= './', $output=NULL)
 
 getRedirectUrl ()
 
 setMessage ($message= 'success', $type=NULL)
 
 setMessageType ($type)
 
 getMessageType ()
 
 setRefreshPage ()
 
 setAct ($act)
 
 setModuleInfo ($module_info, $xml_info)
 
 stop ($msg_code)
 
 setTemplateFile ($filename)
 
 getTemplateFile ()
 
 setTemplatePath ($path)
 
 getTemplatePath ()
 
 setEditedLayoutFile ($filename)
 
 getEditedLayoutFile ()
 
 setLayoutFile ($filename)
 
 getLayoutFile ()
 
 setLayoutPath ($path)
 
 getLayoutPath ($layout_name="", $layout_type="P")
 
 proc ()
 
- Public Member Functions inherited from BaseObject
 __construct ($error=0, $message= 'success')
 
 setError ($error=0)
 
 getError ()
 
 setHttpStatusCode ($code= '200')
 
 getHttpStatusCode ()
 
 setMessage ($message= 'success', $type=NULL)
 
 getMessage ()
 
 add ($key, $val)
 
 adds ($object)
 
 get ($key)
 
 gets ()
 
 getVariables ()
 
 getObjectVars ()
 
 toBool ()
 
 toBoolean ()
 

Public Attributes

 $useUserLayoutTemp = null
 
- Public Attributes inherited from ModuleObject
 $mid = NULL
 string to represent run-time instance of Module (XE Module) More...
 
 $module = NULL
 Class name of Xe Module that is identified by mid. More...
 
 $module_srl = NULL
 integer value to represent a run-time instance of Module (XE Module) More...
 
 $module_info = NULL
 an object containing the module information More...
 
 $origin_module_info = NULL
 
 $xml_info = NULL
 an object containing the module description extracted from XML file More...
 
 $module_path = NULL
 a path to directory where module source code resides More...
 
 $act = NULL
 a string value to contain the action name More...
 
 $template_path = NULL
 a path of directory where template files reside More...
 
 $template_file = NULL
 name of template file More...
 
 $layout_path = ''
 a path of directory where layout files reside More...
 
 $layout_file = ''
 name of layout file More...
 
 $edited_layout_file = ''
 name of temporary layout files that is modified in an admin mode More...
 
 $stop_proc = FALSE
 a flag to indicating whether to stop the execution of code. More...
 
 $module_config = NULL
 
 $ajaxRequestMethod = array('XMLRPC', 'JSON')
 
 $gzhandler_enable = TRUE
 
- Public Attributes inherited from BaseObject
 $error = 0
 
 $message = 'success'
 
 $variables = array()
 
 $httpStatusCode = NULL
 

Detailed Description

Author
NAVER (devel.nosp@m.oper.nosp@m.s@xpr.nosp@m.esse.nosp@m.ngine.nosp@m..com)
Version
0.1 Model class of the layout module

Definition at line 9 of file layout.model.php.

Member Function Documentation

layoutModel::_getInstalledLayoutDirectories (   $layoutType = 'P')

Get list of layouts directory

Parameters
string$layoutType(P : PC, M : Mobile)
Returns
array

Definition at line 411 of file layout.model.php.

layoutModel::_getUserLayoutFaceOffCss (   $layout_srl)

Import faceoff css from css module handler

Parameters
int$layout_srl
Returns
string

Definition at line 810 of file layout.model.php.

layoutModel::doActivateFaceOff ( &  $layout_info)

faceOff related services for the operation run out

Deprecated:
Parameters
object$layout_info
Returns
void

Definition at line 1016 of file layout.model.php.

layoutModel::getDefaultLayoutCss (   $layout_name)

default layout css to prevent arbitrary changes by a user

Parameters
string$layout_name
Returns
string

Definition at line 936 of file layout.model.php.

layoutModel::getDefaultLayoutHtml (   $layout_name)

default layout html to prevent arbitrary changes by a user

Parameters
string$layout_name
Returns
string

Definition at line 926 of file layout.model.php.

layoutModel::getDefaultLayoutIni (   $layout_name)

default layout ini to prevent arbitrary changes by a user

Parameters
string$layout_name
Returns
string

Definition at line 916 of file layout.model.php.

layoutModel::getDefaultLayoutPath ( )

default layout path to prevent arbitrary changes by a user

Deprecated:
Returns
string

Definition at line 946 of file layout.model.php.

layoutModel::getDownloadedLayoutList (   $layout_type = "P",
  $withAutoinstallInfo = false 
)

Get a type and information of the layout A type of downloaded layout

Parameters
string$layout_type(P : PC, M : Mobile)
boolean$withAutoinstallInfo
Returns
array info of layout

Definition at line 322 of file layout.model.php.

layoutModel::getInstalledLayoutCount (   $layoutType = 'P')

Get a count of layout

Parameters
string$layoutType(P : PC, M : Mobile)
Returns
int

Definition at line 400 of file layout.model.php.

layoutModel::getLayout (   $layout_srl)

Get one of layout information created in the DB Return DB info + XML info of the generated layout

Parameters
int$layout_srl
Returns
object info of layout

Definition at line 259 of file layout.model.php.

layoutModel::getLayoutCache (   $layout_name,
  $lang_type,
  $layout_type = 'P' 
)

layout cache

Parameters
int$layout_srl
string$lang_type
Returns
string

Definition at line 899 of file layout.model.php.

layoutModel::getLayoutInfo (   $layout,
  $info = null,
  $layout_type = "P" 
)

Get information by reading conf/info.xml in the module It uses caching to reduce time for xml parsing ..

Parameters
string$layout
object$info
string$layoutType(P : PC, M : Mobile)
Returns
object info of layout

Definition at line 441 of file layout.model.php.

layoutModel::getLayoutInstanceList (   $siteSrl = 0,
  $layoutType = 'P',
  $layout = null,
  $columnList = array() 
)

Get layout instance list

Parameters
int$siteSrl
string$layoutType(P : PC, M : Mobile)
string$layoutname of layout
array$columnList
Returns
array layout lists in site

Definition at line 121 of file layout.model.php.

layoutModel::getLayoutInstanceListForJSONP ( )

Get the list layout instance with thumbnail link. for setting design.

Returns
void

Definition at line 75 of file layout.model.php.

layoutModel::getLayoutList (   $site_srl = 0,
  $layout_type = "P",
  $columnList = array() 
)

Get a layout list created in the DB If you found a new list, it means that the layout list is inserted to the DB

Deprecated:
Parameters
int$site_srl
string$layout_type(P : PC, M : Mobile)
array$columnList
Returns
array layout lists in site

Definition at line 34 of file layout.model.php.

layoutModel::getLayoutPath (   $layout_name = "",
  $layout_type = "P" 
)

Get a layout path

Parameters
string$layout_name
string$layout_type(P : PC, M : Mobile)
Returns
string path of layout

Definition at line 292 of file layout.model.php.

layoutModel::getLayoutRawData (   $layout_srl,
  $columnList = array() 
)

Definition at line 273 of file layout.model.php.

layoutModel::getUserLayoutCache (   $layout_srl,
  $lang_type 
)

user layout cache TODO It may need to remove the file itself

Parameters
int$layout_srl
string$lang_type
Returns
string

Definition at line 888 of file layout.model.php.

layoutModel::getUserLayoutCss (   $layout_srl)

css which is set by an administrator on the layout setting page

Parameters
int$layout_srl
Returns
string

Definition at line 789 of file layout.model.php.

layoutModel::getUserLayoutFaceOffCss (   $layout_srl)

Import faceoff css from css module handler

Parameters
int$layout_srl
Returns
string

Definition at line 799 of file layout.model.php.

layoutModel::getUserLayoutFileList (   $layout_srl)

Saved file list for User Layout

Parameters
int$layout_srl
Returns
array files info

Definition at line 991 of file layout.model.php.

layoutModel::getUserLayoutHtml (   $layout_srl)

user layout html

Parameters
int$layout_srl
Returns
string

Definition at line 830 of file layout.model.php.

layoutModel::getUserLayoutImageList (   $layout_srl)

Return a list of images which are uploaded on the layout setting page

Parameters
int$layout_srl
Returns
array image list in layout

Definition at line 742 of file layout.model.php.

layoutModel::getUserLayoutImagePath (   $layout_srl)

get user layout image path

Parameters
int$layout_srl
Returns
string

Definition at line 779 of file layout.model.php.

layoutModel::getUserLayoutIni (   $layout_srl)

user layout ini

Parameters
int$layout_srl
Returns
string

Definition at line 858 of file layout.model.php.

layoutModel::getUserLayoutIniConfig (   $layout_srl,
  $layout_name = null 
)

Get ini configurations and make them an array.

Parameters
int$layout_srl
string$layout_name
Returns
array

Definition at line 753 of file layout.model.php.

layoutModel::getUserLayoutPath (   $layout_srl)

get user layout path

Parameters
int$layout_srl
Returns
string

Definition at line 769 of file layout.model.php.

layoutModel::getUserLayoutTempFaceOffCss (   $layout_srl)

get user layout tmp html

Parameters
int$layout_srl
Returns
string

Definition at line 820 of file layout.model.php.

layoutModel::getUserLayoutTempFileList (   $layout_srl)

Temp file list for User Layout

Parameters
int$layout_srl
Returns
array temp files info

Definition at line 977 of file layout.model.php.

layoutModel::getUserLayoutTempHtml (   $layout_srl)

user layout tmp html

Parameters
int$layout_srl
Returns
string

Definition at line 848 of file layout.model.php.

layoutModel::getUserLayoutTempIni (   $layout_srl)

user layout tmp ini

Parameters
int$layout_srl
Returns
string

Definition at line 876 of file layout.model.php.

layoutModel::init ( )

Initialization

Returns
void

Definition at line 21 of file layout.model.php.

layoutModel::isExistsLayoutFile (   $layout,
  $layoutType 
)

If exists layout file returns true

Parameters
string$layoutlayout name
string$layoutTypeP or M
Returns
bool

Definition at line 226 of file layout.model.php.

layoutModel::setUseUserLayoutTemp (   $flag = 'temp')

Set user layout as temporary save mode

Parameters
string$flag(default 'temp')
Returns
void

Definition at line 967 of file layout.model.php.

layoutModel::sortLayoutByTitle (   $a,
  $b 
)

Sort layout by title

Definition at line 372 of file layout.model.php.

layoutModel::useDefaultLayout (   $layout_name)

faceoff is

Parameters
string$layout_name
Returns
boolean (true : faceoff, false : layout)

Definition at line 956 of file layout.model.php.

Member Data Documentation

layoutModel::$useUserLayoutTemp = null

Definition at line 15 of file layout.model.php.

The documentation for this class was generated from the following file:
Generated on Tue Dec 18 2018 17:04:30 for XpressEngine Core by   doxygen 1.8.5