Admin_ContentPage Module.
Administration module to manage website pages. More...

Inheritance diagram for Admin_ContentPage:

Public Member Functions
	__construct ($path_type)

	install ()

	uninstall ()

	is_installed ()

	update ($version, $more='')

	get_adminStatisticsValueTitles ($pages, $type=null)

	get_rights ()

	get_adminEngineSpecificMenus ()

	get_adminEngineSpecificMenuItems ()

	init_admin ()

	execute_request ()

	get_sitePages ($lg=null, $where='')

	get_sitePageLink ($page='', $lg='', $params=array())

	get_siteKeyPageLink ($key='', $lg='', $params=array())

	get_siteHomePageLink ()

	set_siteHomePage ($pId)

	get_newPage ()

	get_adminSearchEngineResultsInfos ($lib='', $ids=array())

	get_configValue ($param, $default=false)

	get_keyPage ($key)

	set_keyPage ($key, $value=null)

	get_navigationRoot ($key)

	initialise_configDisplay ()

	display_configDisplay ()

	initialise_configEdition ($form)

	display_configEdition ()

	save_configuration ()

	get_sitemapLinks ()

Public Member Functions inherited from Module
	__construct ($name, $path_type)

	Module ($name, $path_type)

	get_help ()

	display_help ()

	set_theme ($theme)

	get_translation ($value, $data=array())

	get_adminEditionLanguage ()

	get_contentList ()

	preInit_admin ()

	display_admin ()

	init_parent_admin ()

	get_adminLink ($params=array(), $module=null)

	get_adminJSLink ($params=array(), $module=null)

	init_site ($content=1, $params=array(), $index=null)

	display_site ()

	set_selectedLayout ($layout='', $location='')

	get_adminLayout ($layout='')

	get_siteLayout ()

	get_adminEngineGenericMenus ()

	get_adminEngineGenericMenuItems ()

	get_adminEngineGenericInit ()

	get_adminEngineGenericDisplay ()

	get_adminInternalNotifications ()

	get_adminControlPanelAction ()

	get_adminStatisticsSpecificOptions ($object=null)

	check_right ($info)

	get_fileInputButtons ($buttons=array(), $delete=true)

	get_dateInputButtons ($update=true, $reset=true)

	init_generic ()

Public Member Functions inherited from Plugin
	__construct ($name, $plugin_type, $path_type)

	get_version ()

	load_library ($library='')

	load_file ($file='')

	load_varFile ($file='')

	load_engineFile ($file='')

	get_engineFileURL ($file='', $path=false)

	get_fileURL ($file='', $path=null, $default='')

	get_varFileURL ($file='', $path=false, $default='')

	get_filePath ($file='')

	get_varFilePath ($file='')

	add_JSFile ($file)

	add_JSEngineFile ($file)

	add_JSExternFile ($file)

	add_JSScript ($script, $unique=false)

	add_JSPreScript ($script, $unique=false)

	add_JSWindowEventScript ($event, $script, $unique=false)

	add_JSLoadScript ($script, $unique=false)

	add_JSUnloadScript ($script, $unique=false)

	add_styleFile ($file, $media='', $condition='')

	add_styleScript ($css)

	add_styleIncludedFile ($file)

	add_StyleExternFile ($file, $media='', $condition='')

	set_RSSFeed ($title, $url)

	add_headerExtra ($content='')

	add_translation ($more='', $lg=null)

	get_languages ()

	execute_onCaMykSInitialise ()

	execute_onCaMykSPageLoad ()

	execute_onCaMykSBodyOpen ()

	execute_onCaMykSBodyClose ()

	execute_onCaMykSAdminPageLoad ()

	execute_onCaMykSAdminBodyOpen ()

	execute_onCaMykSAdminBodyClose ()

	execute_onCaMykSTerminate ()

	get_requestLink ($params=array())

	get_requestJSLink ($params=array())

	get_varFile ($file)

Public Attributes
	$page
	Current page is use. More...

	$mode
	Current admin mode. More...

	$page_id
	Current page id. More...

	$config
	Module configuration. More...

Public Attributes inherited from Module
	$type
	Module type, can be admin or content. More...

	$title
	Module title. More...

	$libdesc
	Module library description. More...

	$theme
	Theme applied to the Module. More...

	$languages
	Module available locale files. More...

	$rights = array()
	Module permissions. More...

	$selected_layout = ''
	Module layout to use. More...

	$selected_layout_location = 'module'
	Module layout location, can be module or camyks. More...

	$help = null
	Module help files. More...

	$is_editable = true
	Module has editable content. More...

Public Attributes inherited from Plugin
	$name
	Plugin name. More...

	$version
	Plugin version. More...

	$active = false
	Plugin installation status. More...

	$plugin_package = ''
	Plugin package. More...

	$plugin_type
	Plugin type. More...

	$object_type
	Plugin type. More...

	$plugin_path
	Plugin path. More...

	$plugin_site_path
	Plugin site path (for element overwriting). More...

	$plugin_var_path
	Plugin var path. More...

	$plugin_url
	Plugin URL. More...

	$plugin_site_url
	Plugin site URL (for element overwriting). More...

	$plugin_var_url
	Plugin var URL. More...

	$path_type
	Plugin path type. More...

	$author_name
	Plugin author name. More...

	$author_mail
	Plugin author email. More...

	$author_group
	Plugin author group. More...

	$plugin_dependencies = array()
	Plugin dependencies. More...

Protected Attributes
	$htmlcols
	HTML code for page tree. More...

	$opened
	Opened page path. More...

Protected Attributes inherited from Module
	$libs = array()
	Module libraries to load. More...

	$text = ''
	Module admin message. More...

Private Member Functions
	init_admin_finder ()

	init_admin_modify ()

	init_admin_save ()

	init_admin_delete ()

	init_admin_move ()

	init_admin_moveup ()

	init_admin_movedown ()

	init_admin_edit_config ()

	init_admin_save_config ()

	get_adminPages ()

	check_pageRights ($page)

	get_sitePagesHtmlCols ()

	build_sitePagesHtmlCols ($children, $level, $root, $visible, $parent_id)

	get_openedPages ()

	execute_request_get_headerValues ()

	initialise_finderMode ()

	update_toVersion1_1 ()

Private Attributes
	$available_modes = array('finder','modify', 'save', 'delete', 'moveup', 'movedown', 'move', 'edit_config', 'save_config')
	List of all available modes. More...

Additional Inherited Members
Protected Member Functions inherited from Module
	init_admin_accessDenied ()

	init_admin_pageAccessDenied ()

	init_admin_actionNotAllowed ()

	init_admin_missingPlugin ($type, $name)

	disable_adminEngineMenus ()

	add_moduleContentToPage ($pageId, $moduleIndex, $contentId)

	get_PHPLibs ()

Protected Member Functions inherited from Plugin
	set_redirect ($time, $url='')

	add_meta ($name, $content, $method='name')

	add_toHtaccess ($content='')

	add_dependency ($plugin, $type, $version='1.0', $mandatory=false)

	set_dependencies ()

	register_asSharedObject ($name)

&	get_sharedObject ($name)

	register_asExtension ($plugin)

	get_registeredExtensions ()

	register_asCaMykSEventHandler ($event)

Detailed Description

Admin_ContentPage Module.
Administration module to manage website pages.

Plugin / Module Engine

Author: CaMykS Team camyk.nosp@m.s.co.nosp@m.ntact.nosp@m.@gma.nosp@m.il.co.nosp@m.m

Version: 1.1.3.2

Date: Creation: Jun 2005; Modification: Jul 2025

Copyright: 2005 - 2025 CaMykS Team

Note: This program is distributed as is - WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

Todo:: other page type (folder, ...)
cut/paste actions
rights propagation
workflow

Admin_ContentPage class.

Constructor & Destructor Documentation

◆ __construct()

Admin_ContentPage::__construct ( $path_type )

Class constructor.

Parameters

string $path_type

Member Function Documentation

◆ install()

Admin_ContentPage::install ( )

Install module.

Returns: boolean success

Reimplemented from Plugin.

◆ uninstall()

Admin_ContentPage::uninstall ( )

Uninstall module.

Returns: boolean success

Reimplemented from Plugin.

◆ is_installed()

Admin_ContentPage::is_installed ( )

Check module installation.

Returns: boolean result

Reimplemented from Plugin.

◆ update()

Admin_ContentPage::update	(	$version,
		$more = `''`
	)

Update plugin.

Returns: boolean

Reimplemented from Plugin.

◆ get_adminStatisticsValueTitles()

Admin_ContentPage::get_adminStatisticsValueTitles	(	$pages,
		$type = `null`
	)

Return statistic titles.

Parameters

array	$pages
string	$type

Returns: array

Reimplemented from Module.

◆ get_rights()

Admin_ContentPage::get_rights ( )

Define module rights

Returns: void

Reimplemented from Module.

◆ get_adminEngineSpecificMenus()

Admin_ContentPage::get_adminEngineSpecificMenus ( )

Build admin menu object.

Returns: array

Reimplemented from Module.

◆ get_adminEngineSpecificMenuItems()

Admin_ContentPage::get_adminEngineSpecificMenuItems ( )

Build admin menu items.

Returns: array

Reimplemented from Module.

◆ init_admin()

Admin_ContentPage::init_admin ( )

Initialise module object in admin mode.

Returns: void

Reimplemented from Module.

◆ execute_request()

Admin_ContentPage::execute_request ( )

Execute module object as a request.

Returns: void

Reimplemented from Plugin.

◆ init_admin_finder()

Admin_ContentPage::init_admin_finder ( )

private

Initialise module object in admin/finder mode.

Returns: void

◆ init_admin_modify()

Admin_ContentPage::init_admin_modify ( )

private

Initialise module object in admin/modify mode.

Returns: void

◆ init_admin_save()

Admin_ContentPage::init_admin_save ( )

private

Initialise module object in admin/save mode.

Returns: void

◆ init_admin_delete()

Admin_ContentPage::init_admin_delete ( )

private

Initialise module object in admin/delete mode.

Returns: void

◆ init_admin_move()

Admin_ContentPage::init_admin_move ( )

private

Initialise module object in admin/move mode.

Returns: void

◆ init_admin_moveup()

Admin_ContentPage::init_admin_moveup ( )

private

Initialise module object in admin/move up mode.

Returns: void

◆ init_admin_movedown()

Admin_ContentPage::init_admin_movedown ( )

private

Initialise module object in admin/move up mode.

Returns: void

◆ init_admin_edit_config()

Admin_ContentPage::init_admin_edit_config ( )

private

Initialise module object in admin/edit_config mode.

Returns: void

◆ init_admin_save_config()

Admin_ContentPage::init_admin_save_config ( )

private

Initialise module object in admin/save_config mode.

Returns: void

◆ get_adminPages()

Admin_ContentPage::get_adminPages ( )

private

Return all pages in admin mode.

Returns: void

◆ get_sitePages()

Admin_ContentPage::get_sitePages	(	$lg = `null`,
		$where = `''`
	)

Return all pages in visit mode.

Parameters

string	$lg
string	$where

◆ get_sitePageLink()

Admin_ContentPage::get_sitePageLink	(	$page = `''`,
		$lg = `''`,
		$params = `array()`
	)

Return page link.

Parameters

mixed	$page
string	$lg
array	$params

Returns: string

◆ get_siteKeyPageLink()

Admin_ContentPage::get_siteKeyPageLink	(	$key = `''`,
		$lg = `''`,
		$params = `array()`
	)

Return key page link.

Parameters

string	$key
string	$lg
array	$params

Returns: string

◆ get_siteHomePageLink()

Admin_ContentPage::get_siteHomePageLink ( )

Return homepage link.

Returns: string

◆ set_siteHomePage()

Admin_ContentPage::set_siteHomePage ( $pId )

Store homepage.

Returns: string

◆ get_newPage()

Admin_ContentPage::get_newPage ( )

Return a new ContentPage object.

Returns: ContentPage Object

◆ check_pageRights()

Admin_ContentPage::check_pageRights ( $page )

private

Check current admin user right on given page.

Parameters

mixed $page

Returns: boolean result

◆ get_sitePagesHtmlCols()

Admin_ContentPage::get_sitePagesHtmlCols ( )

private

Build HTML admin page tree.

Returns: string

◆ build_sitePagesHtmlCols()

Admin_ContentPage::build_sitePagesHtmlCols	(	$children,
		$level,
		$root,
		$visible,
		$parent_id
	)

private

Build HTML admin page tree columns.

Parameters

array	$children
int	$level
string	$root
boolean	$visible
int	$parent_id

Returns: string

◆ get_openedPages()

Admin_ContentPage::get_openedPages ( )

private

Extract open pages from header opened value.

Returns: void

◆ execute_request_get_headerValues()

Admin_ContentPage::execute_request_get_headerValues ( )

private

Load header values in execute request mode.

Returns: void

◆ get_adminSearchEngineResultsInfos()

Admin_ContentPage::get_adminSearchEngineResultsInfos	(	$lib = `''`,
		$ids = `array()`
	)

Return search results data

Parameters

array	$lib
array	$ids

Returns: array

◆ get_configValue()

Admin_ContentPage::get_configValue	(	$param,
		$default = `false`
	)

Return config value.

Parameters

string	$param
mixed	$default

Returns: mixed

◆ get_keyPage()

Admin_ContentPage::get_keyPage ( $key )

Return key page from config.

Parameters

string $key

Returns: mixed

◆ set_keyPage()

Admin_ContentPage::set_keyPage	(	$key,
		$value = `null`
	)

Update key page in config.

Parameters

string	$key
mixed	$value

Returns: void

◆ get_navigationRoot()

Admin_ContentPage::get_navigationRoot ( $key )

Return navigation root from config.

Parameters

string $key

Returns: mixed

◆ initialise_finderMode()

Admin_ContentPage::initialise_finderMode ( )

private

Initialise finder mode.

Returns: void

◆ update_toVersion1_1()

Admin_ContentPage::update_toVersion1_1 ( )

private

Apply version 1.1 update.

Returns: boolean success

◆ initialise_configDisplay()

Admin_ContentPage::initialise_configDisplay ( )

Initialise object in Admin_Site, view configuration mode.

Returns: void

◆ display_configDisplay()

Admin_ContentPage::display_configDisplay ( )

Display object in Admin_Site, view configuration mode.

Returns: void

◆ initialise_configEdition()

Admin_ContentPage::initialise_configEdition ( $form )

Initialise object in Admin_Site, edit configuration mode.

Parameters

Object $form

Returns: void

◆ display_configEdition()

Admin_ContentPage::display_configEdition ( )

Display object in Admin_Site, edit configuration mode

Returns: void

◆ save_configuration()

Admin_ContentPage::save_configuration ( )

Execute object in Admin_Site, save configuration mode

Returns: void

◆ get_sitemapLinks()

Admin_ContentPage::get_sitemapLinks ( )

Return links for site map.

Returns: array

Member Data Documentation

◆ $page

Admin_ContentPage::$page

Current page is use.

var Object $page

◆ $mode

Admin_ContentPage::$mode

Current admin mode.

var string $mode

◆ $available_modes

Admin_ContentPage::$available_modes = array('finder','modify', 'save', 'delete', 'moveup', 'movedown', 'move', 'edit_config', 'save_config')

private

List of all available modes.

var array $available_modes

◆ $page_id

Admin_ContentPage::$page_id

Current page id.

var integer $page_id

◆ $htmlcols

Admin_ContentPage::$htmlcols

protected

HTML code for page tree.

var string $htmlcols

◆ $opened

Admin_ContentPage::$opened

protected

Opened page path.

var array $opened

◆ $config

Admin_ContentPage::$config

Module configuration.

var Object $config

The documentation for this class was generated from the following file:

CaMykS/plugin/module/Admin_ContentPage/Admin_ContentPage.php.inc

Public Member Functions

Public Attributes

Protected Attributes

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ install()

◆ uninstall()

◆ is_installed()

◆ update()

◆ get_adminStatisticsValueTitles()

◆ get_rights()

◆ get_adminEngineSpecificMenus()

◆ get_adminEngineSpecificMenuItems()

◆ init_admin()

◆ execute_request()

◆ init_admin_finder()

◆ init_admin_modify()

◆ init_admin_save()

◆ init_admin_delete()

◆ init_admin_move()

◆ init_admin_moveup()

◆ init_admin_movedown()

◆ init_admin_edit_config()

◆ init_admin_save_config()

◆ get_adminPages()

◆ get_sitePages()

◆ get_sitePageLink()

◆ get_siteKeyPageLink()

◆ get_siteHomePageLink()

◆ set_siteHomePage()

◆ get_newPage()

◆ check_pageRights()

◆ get_sitePagesHtmlCols()

◆ build_sitePagesHtmlCols()

◆ get_openedPages()

◆ execute_request_get_headerValues()

◆ get_adminSearchEngineResultsInfos()

◆ get_configValue()

◆ get_keyPage()

◆ set_keyPage()

◆ get_navigationRoot()

◆ initialise_finderMode()

◆ update_toVersion1_1()

◆ initialise_configDisplay()

◆ display_configDisplay()

◆ initialise_configEdition()

◆ display_configEdition()

◆ save_configuration()

◆ get_sitemapLinks()

Member Data Documentation

◆ $page

◆ $mode

◆ $available_modes

◆ $page_id

◆ $htmlcols

◆ $opened

◆ $config