This module aims to provide quick access to most common tasks of the application platform. +
This module (library) is required and installed by default with the core modules. +
Permissions can be extended to trusted user groups. + +
Next we will give an overview of some common tasks you can do with the Administration. + Each task will be used to highlight a particular function within the module. +
creation of custom blocks (HTML, PHP and BBCode), modules block management, + advanced templates design, customization, translations and localization. +
The building blocks of your site are single components of content like business information, + advertisements, contact forms, images or media embeds from other platforms.
+ +Each block has the following default properties :
+The block "side"" is just a legacy code convention to identify areas in the theme and organize the layout. + Blocks are modular units of content that can be positioned almost anywhere on the page.
+For example, a theme can place the block-left "Main Menu" at the top of the page to create a navigation bar.
+ +A Custom block can be built with HTML, CSS, JavaScript, PHP and Smarty variables. + Thus allowing to create reusable Components to create an effective website layout.
+It can also embed code or integrate with third-party features specific to a site's unique needs.
+ +Modules have several pre-built blocks that offer specific functionality and favor composition over inheritance. + These blocks are made available in Block Management by enabling modules. + Each module block has its own settings and customization options.
+ + + +Templates of modules and blocks shape content. While the frontend and backend Themes define the general appearance.
+A custom template can be created with HTML, CSS, JavaScript, PHP and Smarty variables to make a single file component.
+ +The list of Template Sets can be found in Template Management of module Renderer. + When modules are installed, their templates become part of the Default Template Set.
+ +1. First, make a copy of the Default Template Set ( Base-File )
+2. Browse to templates »» Module
+3. Click "edit" next to the template of the new Set
+4. Make the changes you want
+5. Save the template
+ +The template naming convention is a systematic method for naming files + written in all-lowercase ASCII letters. The name specs might include the package name, action, event.
+Learn more about Naming Convention ⭢
+ +1. Create a custom template
+2. Add some content
+3. Name the template eg.: mycustom_template.html
+4. Save the custom template
+ +Then, you can create a custom block and load your custom template
+
+$xoopsTpl = new XoopsTpl();
+$test = $xoopsTpl->fetch('myblock_custom.html');
+echo $test;
+ The Renderer uses Smarty Template Engine —one of the most popular and mature template engines— with custom delimiters + similar to HTML markup language that make easier to design and develop components for templates.
+From template Management you can enable a Set and check the list of templates that you can edit, copy, download or delete.
+ + + +These features allow you to insert ruler guides and logic to collect template variables + in order to help designers identify components during the design process.
+ +The default distribution comes with English, French, Japanese and Portuguese translations.
+ You can change the 'Default Language' in
+
Other local languages translations are available that you can download from the + GitHub repository - i18n-language ⭧
+ +
If your language files are not available, you’ll need to translate the files located in modules directories + e.g. “/language/english/”
+ +1. Click the module to translate +
2. Select the local language, e.g. english
+3. Select the file to translate
+4. Add a new Custom Value
+5. Update to save the constants translated into your language
+This will save into the database and in a file under TRUST_PATH/cache/....
+ +Localisation (l10n) is the process of customizing your app and + adapting your product's translation to a specific country or region.
+ +It is the second phase of a larger process of product translation and cultural adaptation to account for + differences in distinct markets, a process known as internationalisation and localisation.
+ +| Module name | +Altsys | +
|---|---|
| Type | +Trust Module [ D3 library ] | +
| Version | +2.31 | +
| Level | +Required | +
| 🌐 Repository URL | +https://github.com/xoopscube/altsys ⭧ | +
This module aims to provide quick access to most common tasks of the application platform. +
This module (library) is required and installed by default with the core modules. +
Permissions can be extended to trusted user groups. + +
Next we will give an overview of some common tasks you can do with the Administration. + Each task will be used to highlight a particular function within the module. +
creation of custom blocks (HTML, PHP and BBCode), modules block management, + advanced templates design, customization, translations and localization. +
The building blocks of your site are single components of content like business information, + advertisements, contact forms, images or media embeds from other platforms.
+ +Each block has the following default properties :
+The block "side"" is just a legacy code convention to identify areas in the theme and organize the layout. + Blocks are modular units of content that can be positioned almost anywhere on the page.
+For example, a theme can place the block-left "Main Menu" at the top of the page to create a navigation bar.
+ +A Custom block can be built with HTML, CSS, JavaScript, PHP and Smarty variables. + Thus allowing to create reusable Components to create an effective website layout.
+It can also embed code or integrate with third-party features specific to a site's unique needs.
+ +Modules have several pre-built blocks that offer specific functionality and favor composition over inheritance. + These blocks are made available in Block Management by enabling modules. + Each module block has its own settings and customization options.
+ + + +Templates of modules and blocks shape content. While the frontend and backend Themes define the general appearance.
+A custom template can be created with HTML, CSS, JavaScript, PHP and Smarty variables to make a single file component.
+ +The list of Template Sets can be found in Template Management of module Renderer. + When modules are installed, their templates become part of the Default Template Set.
+ +1. First, make a copy of the Default Template Set ( Base-File )
+2. Browse to templates »» Module
+3. Click "edit" next to the template of the new Set
+4. Make the changes you want
+5. Save the template
+ +The template naming convention is a systematic method for naming files + written in all-lowercase ASCII letters. The name specs might include the package name, action, event.
+Learn more about Naming Convention ⭢
+ +1. Create a custom template
+2. Add some content
+3. Name the template eg.: mycustom_template.html
+4. Save the custom template
+ +Then, you can create a custom block and load your custom template
+
+$xoopsTpl = new XoopsTpl();
+$test = $xoopsTpl->fetch('myblock_custom.html');
+echo $test;
+ The Renderer uses Smarty Template Engine —one of the most popular and mature template engines— with custom delimiters + similar to HTML markup language that make easier to design and develop components for templates.
+From template Management you can enable a Set and check the list of templates that you can edit, copy, download or delete.
+ + + +These features allow you to insert ruler guides and logic to collect template variables + in order to help designers identify components during the design process.
+ +The default distribution comes with English, French, Japanese and Portuguese translations.
+ You can change the 'Default Language' in
+
Other local languages translations are available that you can download from the + GitHub repository - i18n-language ⭧
+ +
If your language files are not available, you’ll need to translate the files located in modules directories + e.g. “/language/english/”
+ +1. Click the module to translate +
2. Select the local language, e.g. english
+3. Select the file to translate
+4. Add a new Custom Value
+5. Update to save the constants translated into your language
+This will save into the database and in a file under TRUST_PATH/cache/....
+ +Localisation (l10n) is the process of customizing your app and + adapting your product's translation to a specific country or region.
+ +It is the second phase of a larger process of product translation and cultural adaptation to account for + differences in distinct markets, a process known as internationalisation and localisation.
+ +| Module name | +Altsys | +
|---|---|
| Type | +Trust Module [ D3 library ] | +
| Version | +2.31 | +
| Level | +Required | +
| 🌐 Repository URL | +https://github.com/xoopscube/altsys ⭧ | +
This module aims to provide quick access to most common tasks of the application platform. +
This module (library) is required and installed by default with the core modules. +
Permissions can be extended to trusted user groups. + +
Next we will give an overview of some common tasks you can do with the Administration. + Each task will be used to highlight a particular function within the module. +
creation of custom blocks (HTML, PHP and BBCode), modules block management, + advanced templates design, customization, translations and localization. +
The building blocks of your site are single components of content like business information, + advertisements, contact forms, images or media embeds from other platforms.
+ +Each block has the following default properties :
+The block "side"" is just a legacy code convention to identify areas in the theme and organize the layout. + Blocks are modular units of content that can be positioned almost anywhere on the page.
+For example, a theme can place the block-left "Main Menu" at the top of the page to create a navigation bar.
+ +A Custom block can be built with HTML, CSS, JavaScript, PHP and Smarty variables. + Thus allowing to create reusable Components to create an effective website layout.
+It can also embed code or integrate with third-party features specific to a site's unique needs.
+ +Modules have several pre-built blocks that offer specific functionality and favor composition over inheritance. + These blocks are made available in Block Management by enabling modules. + Each module block has its own settings and customization options.
+ + + +Templates of modules and blocks shape content. While the frontend and backend Themes define the general appearance.
+A custom template can be created with HTML, CSS, JavaScript, PHP and Smarty variables to make a single file component.
+ +The list of Template Sets can be found in Template Management of module Renderer. + When modules are installed, their templates become part of the Default Template Set.
+ +1. First, make a copy of the Default Template Set ( Base-File )
+2. Browse to templates »» Module
+3. Click "edit" next to the template of the new Set
+4. Make the changes you want
+5. Save the template
+ +The template naming convention is a systematic method for naming files + written in all-lowercase ASCII letters. The name specs might include the package name, action, event.
+Learn more about Naming Convention ⭢
+ +1. Create a custom template
+2. Add some content
+3. Name the template eg.: mycustom_template.html
+4. Save the custom template
+ +Then, you can create a custom block and load your custom template
+
+$xoopsTpl = new XoopsTpl();
+$test = $xoopsTpl->fetch('myblock_custom.html');
+echo $test;
+ The Renderer uses Smarty Template Engine —one of the most popular and mature template engines— with custom delimiters + similar to HTML markup language that make easier to design and develop components for templates.
+From template Management you can enable a Set and check the list of templates that you can edit, copy, download or delete.
+ + + +These features allow you to insert ruler guides and logic to collect template variables + in order to help designers identify components during the design process.
+ +The default distribution comes with English, French, Japanese and Portuguese translations.
+ You can change the 'Default Language' in
+
Other local languages translations are available that you can download from the + GitHub repository - i18n-language ⭧
+ +
If your language files are not available, you’ll need to translate the files located in modules directories + e.g. “/language/english/”
+ +1. Click the module to translate +
2. Select the local language, e.g. english
+3. Select the file to translate
+4. Add a new Custom Value
+5. Update to save the constants translated into your language
+This will save into the database and in a file under TRUST_PATH/cache/....
+ +Localisation (l10n) is the process of customizing your app and + adapting your product's translation to a specific country or region.
+ +It is the second phase of a larger process of product translation and cultural adaptation to account for + differences in distinct markets, a process known as internationalisation and localisation.
+ +| Module name | +Altsys | +
|---|---|
| Type | +Trust Module [ D3 library ] | +
| Version | +2.31 | +
| Level | +Required | +
| 🌐 Repository URL | +https://github.com/xoopscube/altsys ⭧ | +
This module aims to provide quick access to most common tasks of the application platform. +
This module (library) is required and installed by default with the core modules. +
Permissions can be extended to trusted user groups. + +
Next we will give an overview of some common tasks you can do with the Administration. + Each task will be used to highlight a particular function within the module. +
creation of custom blocks (HTML, PHP and BBCode), modules block management, + advanced templates design, customization, translations and localization. +
The building blocks of your site are single components of content like business information, + advertisements, contact forms, images or media embeds from other platforms.
+ +Each block has the following default properties :
+The block "side"" is just a legacy code convention to identify areas in the theme and organize the layout. + Blocks are modular units of content that can be positioned almost anywhere on the page.
+For example, a theme can place the block-left "Main Menu" at the top of the page to create a navigation bar.
+ +A Custom block can be built with HTML, CSS, JavaScript, PHP and Smarty variables. + Thus allowing to create reusable Components to create an effective website layout.
+It can also embed code or integrate with third-party features specific to a site's unique needs.
+ +Modules have several pre-built blocks that offer specific functionality and favor composition over inheritance. + These blocks are made available in Block Management by enabling modules. + Each module block has its own settings and customization options.
+ + + +Templates of modules and blocks shape content. While the frontend and backend Themes define the general appearance.
+A custom template can be created with HTML, CSS, JavaScript, PHP and Smarty variables to make a single file component.
+ +The list of Template Sets can be found in Template Management of module Renderer. + When modules are installed, their templates become part of the Default Template Set.
+ +1. First, make a copy of the Default Template Set ( Base-File )
+2. Browse to templates »» Module
+3. Click "edit" next to the template of the new Set
+4. Make the changes you want
+5. Save the template
+ +The template naming convention is a systematic method for naming files + written in all-lowercase ASCII letters. The name specs might include the package name, action, event.
+Learn more about Naming Convention ⭢
+ +1. Create a custom template
+2. Add some content
+3. Name the template eg.: mycustom_template.html
+4. Save the custom template
+ +Then, you can create a custom block and load your custom template
+
+$xoopsTpl = new XoopsTpl();
+$test = $xoopsTpl->fetch('myblock_custom.html');
+echo $test;
+ The Renderer uses Smarty Template Engine —one of the most popular and mature template engines— with custom delimiters + similar to HTML markup language that make easier to design and develop components for templates.
+From template Management you can enable a Set and check the list of templates that you can edit, copy, download or delete.
+ + + +These features allow you to insert ruler guides and logic to collect template variables + in order to help designers identify components during the design process.
+ +The default distribution comes with English, French, Japanese and Portuguese translations.
+ You can change the 'Default Language' in
+
Other local languages translations are available that you can download from the + GitHub repository - i18n-language ⭧
+ +
If your language files are not available, you’ll need to translate the files located in modules directories + e.g. “/language/english/”
+ +1. Click the module to translate +
2. Select the local language, e.g. english
+3. Select the file to translate
+4. Add a new Custom Value
+5. Update to save the constants translated into your language
+This will save into the database and in a file under TRUST_PATH/cache/....
+ +Localisation (l10n) is the process of customizing your app and + adapting your product's translation to a specific country or region.
+ +It is the second phase of a larger process of product translation and cultural adaptation to account for + differences in distinct markets, a process known as internationalisation and localisation.
+ +| Module name | +Altsys | +
|---|---|
| Type | +Trust Module [ D3 library ] | +
| Version | +2.31 | +
| Level | +Required | +
| 🌐 Repository URL | +https://github.com/xoopscube/altsys ⭧ | +
';
+ $modinfo = $mod->getInfo();
+
+ $submenus4assign = [];
+
+ $adminmenu = [];
+
+ $adminmenu4altsys = [];
+
+ unset($adminmenu_use_altsys);
+
+ @include XOOPS_ROOT_PATH . '/modules/' . $dirname . '/' . @$modinfo['adminmenu'];
// from admin_menu.php etc.
- $adminmenu = array_merge($adminmenu, $adminmenu4altsys) ;
+
+ $adminmenu = array_merge($adminmenu, $adminmenu4altsys);
+
foreach ($adminmenu as $sub) {
- $link = empty($sub['altsys_link']) ? $sub['link'] : $sub['altsys_link'] ;
- if (isset($sub['show']) && $sub['show'] === false) {
- continue ;
+ $link = empty($sub['altsys_link']) ? $sub['link'] : $sub['altsys_link'];
+ if (isset($sub['show']) && false === $sub['show']) {
+ continue;
}
- $submenus4assign[] = array(
- 'title' => $myts->makeTboxData4Show($sub['title']) ,
- 'url' => XOOPS_URL.'/modules/'.$dirname.'/'.htmlspecialchars($link, ENT_QUOTES) ,
- ) ;
+ $submenus4assign[] = [
+ 'title' => $myts->makeTboxData4Show($sub['title']),
+ 'url' => XOOPS_URL . '/modules/' . $dirname . '/' . htmlspecialchars($link, ENT_QUOTES),
+ ];
}
// for modules overriding Module.class.php (eg. Analyzer for XC)
- if (empty($submenus4assign) && defined('XOOPS_CUBE_LEGACY') && ! empty($modinfo['cube_style'])) {
+ if (empty($submenus4assign) && defined('XOOPS_CUBE_LEGACY') && !empty($modinfo['cube_style'])) {
+
$module_handler =& xoops_gethandler('module');
+
$module =& $module_handler->get($mid);
+
$moduleObj =& Legacy_Utils::createModule($module);
- $modinfo['adminindex'] = $moduleObj->getAdminIndex() ;
- $modinfo['adminindex_absolute'] = true ;
+
+ $modinfo['adminindex'] = $moduleObj->getAdminIndex();
+
+ $modinfo['adminindex_absolute'] = true;
+
foreach ($moduleObj->getAdminMenu() as $sub) {
- if (@$sub['show'] === false) {
- continue ;
+ if (false === @$sub['show']) {
+ continue;
}
- $submenus4assign[] = array(
- 'title' => $myts->makeTboxData4Show($sub['title']) ,
- 'url' => strncmp($sub['link'], 'http', 4) === 0 ? htmlspecialchars($sub['link'], ENT_QUOTES) : XOOPS_URL.'/modules/'.$dirname.'/'.htmlspecialchars($sub['link'], ENT_QUOTES) ,
- ) ;
+ $submenus4assign[] = [
+ 'title' => $myts->makeTboxData4Show($sub['title']),
+ 'url' => 0 === strncmp($sub['link'], 'http', 4) ? htmlspecialchars($sub['link'], ENT_QUOTES) : XOOPS_URL . '/modules/' . $dirname . '/' . htmlspecialchars($sub['link'], ENT_QUOTES),
+ ];
}
} elseif (empty($adminmenu4altsys)) {
// add preferences
- if ($mod->getVar('hasconfig') && ! in_array($mod->getVar('dirname'), array( 'system', 'legacy' ))) {
- $submenus4assign[] = array(
- 'title' => _PREFERENCES ,
- 'url' => htmlspecialchars(altsys_get_link2modpreferences($mid, $coretype), ENT_QUOTES) ,
- ) ;
+ if ($mod->getVar('hasconfig') && !in_array($mod->getVar('dirname'), ['system', 'legacy'])) {
+ $submenus4assign[] = [
+ 'title' => _PREFERENCES,
+ 'url' => htmlspecialchars(altsys_get_link2modpreferences($mid, $coretype), ENT_QUOTES),
+ ];
}
// add help
- if (defined('XOOPS_CUBE_LEGACY') && ! empty($modinfo['help'])) {
- $submenus4assign[] = array(
- 'title' => _HELP ,
- 'url' => XOOPS_URL.'/modules/legacy/admin/index.php?action=Help&dirname='.$dirname ,
- ) ;
+ if (defined('XOOPS_CUBE_LEGACY') && !empty($modinfo['help'])) {
+ $submenus4assign[] = [
+ 'title' => _HELP,
+ 'url' => XOOPS_URL . '/modules/legacy/admin/index.php?action=Help&dirname=' . $dirname,
+ ];
}
}
-
- $module4assign = array(
- 'mid' => $mid ,
- 'dirname' => $dirname ,
- 'name' => $mod->getVar('name') ,
- 'version_in_db' => sprintf('%.2f', $mod->getVar('version') / 100.0) ,
- 'version_in_file' => sprintf('%.2f', $modinfo['version']) ,
- 'description' => htmlspecialchars(@$modinfo['description'], ENT_QUOTES) ,
- 'image' => htmlspecialchars($modinfo['image'], ENT_QUOTES) ,
- 'isactive' => $mod->getVar('isactive') ,
- 'hasmain' => $mod->getVar('hasmain') ,
- 'hasadmin' => $mod->getVar('hasadmin') ,
- 'hasconfig' => $mod->getVar('hasconfig') ,
- 'weight' => $mod->getVar('weight') ,
- 'adminindex' => htmlspecialchars(@$modinfo['adminindex'], ENT_QUOTES) ,
- 'adminindex_absolute' => @$modinfo['adminindex_absolute'] ,
- 'submenu' => $submenus4assign ,
- 'selected' => $mid == $mid_selected ? true : false ,
- 'dot_suffix' => $mid == $mid_selected ? 'selected_opened' : 'closed' ,
- ) ;
- $block['modules'][] = $module4assign ;
+ // TODO gigamaster add module icon
+ $module4assign = [
+ 'mid' => $mid,
+ 'dirname' => $dirname,
+ 'name' => $mod->getVar('name'),
+ 'icon' => $moduleIcon,
+ 'version_in_db' => sprintf('%.2f', $mod->getVar('version') / 100.0),
+ 'version_in_file' => sprintf('%.2f', $modinfo['version']),
+ 'description' => htmlspecialchars(@$modinfo['description'], ENT_QUOTES),
+// 'image' => htmlspecialchars($modinfo['image'], ENT_QUOTES),
+ 'isactive' => $mod->getVar('isactive'),
+ 'hasmain' => $mod->getVar('hasmain'),
+ 'hasadmin' => $mod->getVar('hasadmin'),
+ 'hasconfig' => $mod->getVar('hasconfig'),
+ 'weight' => $mod->getVar('weight'),
+ 'adminindex' => htmlspecialchars(@$modinfo['adminindex'], ENT_QUOTES),
+ 'adminindex_absolute' => @$modinfo['adminindex_absolute'],
+ 'submenu' => $submenus4assign,
+ //'selected' => $mid == $mid_selected ? true : false, TODO gigamaster check
+ 'selected' => $mid == $mid_selected,
+ 'dot_suffix' => $mid == $mid_selected ? 'selected_opened' : 'closed',
+ ];
+ $block['modules'][] = $module4assign;
}
- require_once XOOPS_TRUST_PATH.'/libs/altsys/class/D3Tpl.class.php' ;
- $tpl = new D3Tpl() ;
- $tpl->assign('block', $block) ;
- $ret['content'] = $tpl->fetch($this_template) ;
- return $ret ;
+ require_once XOOPS_TRUST_PATH . '/libs/altsys/class/D3Tpl.class.php';
+
+ $tpl = new D3Tpl();
+
+ $tpl->assign('block', $block);
+
+ $ret['content'] = $tpl->fetch($this_template);
+
+ return $ret;
}
function b_altsys_admin_menu_edit($options)
{
- $mydirname = empty($options[0]) ? 'd3forum' : $options[0] ;
- $this_template = empty($options[1]) ? 'db:'.$mydirname.'_block_admin_menu.html' : trim($options[1]) ;
+ $mydirname = empty($options[0]) ? 'd3forum' : $options[0];
+
+ $this_template = empty($options[1]) ? 'db:' . $mydirname . '_block_admin_menu.html' : trim($options[1]);
if (preg_match('/[^0-9a-zA-Z_-]/', $mydirname)) {
- die('Invalid mydirname') ;
+ die('Invalid mydirname');
}
$form = "
-
- :
-
- | ".$this->renderRadio4BlockPosition(1, $block_data)." | -".$this->renderRadio4BlockPosition(3, $block_data)." | -".$this->renderRadio4BlockPosition(4, $block_data)." | -".$this->renderRadio4BlockPosition(5, $block_data)." | -".$this->renderRadio4BlockPosition(2, $block_data)." | -
| ".$this->renderRadio4BlockPosition(6, $block_data)." | -".$this->renderRadio4BlockPosition(7, $block_data)." | -".$this->renderRadio4BlockPosition(8, $block_data)." | -||
| ".$this->renderRadio4BlockPositions($block_data, array(1, 2, 3, 4, 5, 6, 7, 8))." | -||||
| ".$this->renderRadio4BlockPosition(0, $block_data)." | -".$this->renderRadio4BlockPosition(3, $block_data)." | -".$this->renderRadio4BlockPosition(5, $block_data)." | -".$this->renderRadio4BlockPosition(4, $block_data)." | -".$this->renderRadio4BlockPosition(1, $block_data)." | -
| ".$this->renderRadio4BlockPosition(7, $block_data)." | -".$this->renderRadio4BlockPosition(9, $block_data)." | -".$this->renderRadio4BlockPosition(8, $block_data)." | -||
| ".$this->renderRadio4BlockPosition(-1, $block_data)._NONE." | -||||
|
-
-
-
- -
- |
-
-
-
-
- |
-
-
-
-
- |
-
-
-
-
- |
-
- -
-
-
-
- |
-
|
-
-
-
- |
-
-
-
-
- |
-
-
-
-
-
- |
- ||
|
-
-
-
-
-
-
- "._NONE."
- |
- ||||
- * $diff = new Text_Diff($lines1, $lines2);
- * $rev = $diff->reverse();
- *
- *
- * @return Text_Diff A Diff object representing the inverse of the
- * original diff. Note that we purposely don't return a
- * reference here, since this essentially is a clone()
- * method.
- */
- public function reverse()
- {
- if (version_compare(zend_version(), '2', '>')) {
- $rev = clone($obj);
- } else {
- $rev = $this;
- }
- $rev->_edits = array();
- foreach ($this->_edits as $edit) {
- $rev->_edits[] = $edit->reverse();
- }
- return $rev;
- }
-
- /**
- * Checks for an empty diff.
- *
- * @return boolean True if two sequences were identical.
- */
- public function isEmpty()
- {
- foreach ($this->_edits as $edit) {
- if (!is_a($edit, 'Text_Diff_Op_copy')) {
- return false;
- }
- }
- return true;
- }
-
- /**
- * Computes the length of the Longest Common Subsequence (LCS).
- *
- * This is mostly for diagnostic purposes.
- *
- * @return integer The length of the LCS.
- */
- public function lcs()
- {
- $lcs = 0;
- foreach ($this->_edits as $edit) {
- if (is_a($edit, 'Text_Diff_Op_copy')) {
- $lcs += count($edit->orig);
- }
- }
- return $lcs;
- }
-
- /**
- * Gets the original set of lines.
- *
- * This reconstructs the $from_lines parameter passed to the constructor.
- *
- * @return array The original sequence of strings.
- */
- public function getOriginal()
- {
- $lines = array();
- foreach ($this->_edits as $edit) {
- if ($edit->orig) {
- array_splice($lines, count($lines), 0, $edit->orig);
- }
- }
- return $lines;
- }
-
- /**
- * Gets the final set of lines.
- *
- * This reconstructs the $to_lines parameter passed to the constructor.
- *
- * @return array The sequence of strings.
- */
- public function getFinal()
- {
- $lines = array();
- foreach ($this->_edits as $edit) {
- if ($edit->final) {
- array_splice($lines, count($lines), 0, $edit->final);
- }
- }
- return $lines;
- }
-
- /**
- * Removes trailing newlines from a line of text. This is meant to be used
- * with array_walk().
- *
- * @param string $line The line to trim.
- * @param integer $key The index of the line in the array. Not used.
- */
- public function _trimNewlines(&$line, $key)
- {
- $line = str_replace(array("\n", "\r"), '', $line);
- }
-
- /**
- * Checks a diff for validity.
- *
- * This is here only for debugging purposes.
- */
- public function _check($from_lines, $to_lines)
- {
- if (serialize($from_lines) != serialize($this->getOriginal())) {
- trigger_error("Reconstructed original doesn't match", E_USER_ERROR);
- }
- if (serialize($to_lines) != serialize($this->getFinal())) {
- trigger_error("Reconstructed final doesn't match", E_USER_ERROR);
- }
-
- $rev = $this->reverse();
- if (serialize($to_lines) != serialize($rev->getOriginal())) {
- trigger_error("Reversed original doesn't match", E_USER_ERROR);
- }
- if (serialize($from_lines) != serialize($rev->getFinal())) {
- trigger_error("Reversed final doesn't match", E_USER_ERROR);
- }
-
- $prevtype = null;
- foreach ($this->_edits as $edit) {
- if ($prevtype == get_class($edit)) {
- trigger_error("Edit sequence is non-optimal", E_USER_ERROR);
- }
- $prevtype = get_class($edit);
- }
-
- return true;
- }
+ public function __construct( $from_lines, $to_lines ) {
+ array_walk( $from_lines, [ $this, '_trimNewlines' ] );
+ array_walk( $to_lines, [ $this, '_trimNewlines' ] );
+
+ if ( extension_loaded( 'xdiff' ) ) {
+ $engine = new Text_Diff_Engine_xdiff();
+ } else {
+ $engine = new Text_Diff_Engine_native();
+ }
+
+ $this->_edits = $engine->diff( $from_lines, $to_lines );
+ }
+
+ /**
+ * Returns the array of differences.
+ */
+ public function getDiff() {
+ return $this->_edits;
+ }
+
+ /**
+ * Computes a reversed diff.
+ *
+ * Example:
+ *
+ * $diff = new Text_Diff($lines1, $lines2);
+ * $rev = $diff->reverse();
+ *
+ *
+ * @return Text_Diff A Diff object representing the inverse of the
+ * original diff. Note that we purposely don't return a
+ * reference here, since this essentially is a clone()
+ * method.
+ */
+ public function reverse() {
+ if ( version_compare( zend_version(), '2', '>' ) ) {
+ $rev = clone( $obj );
+ } else {
+ $rev = $this;
+ }
+ $rev->_edits = [];
+ foreach ( $this->_edits as $edit ) {
+ $rev->_edits[] = $edit->reverse();
+ }
+
+ return $rev;
+ }
+
+ /**
+ * Checks for an empty diff.
+ *
+ * @return bool True if two sequences were identical.
+ */
+ public function isEmpty() {
+ foreach ( $this->_edits as $edit ) {
+ if ( ! is_a( $edit, 'Text_Diff_Op_copy' ) ) {
+ return false;
+ }
+ }
+
+ return true;
+ }
+
+ /**
+ * Computes the length of the Longest Common Subsequence (LCS).
+ *
+ * This is mostly for diagnostic purposes.
+ *
+ * @return int The length of the LCS.
+ */
+ public function lcs() {
+ $lcs = 0;
+ foreach ( $this->_edits as $edit ) {
+ if ( is_a( $edit, 'Text_Diff_Op_copy' ) ) {
+ $lcs += count( $edit->orig );
+ }
+ }
+
+ return $lcs;
+ }
+
+ /**
+ * Gets the original set of lines.
+ *
+ * This reconstructs the $from_lines parameter passed to the constructor.
+ *
+ * @return array The original sequence of strings.
+ */
+ public function getOriginal() {
+ $lines = [];
+ foreach ( $this->_edits as $edit ) {
+ if ( $edit->orig ) {
+ array_splice( $lines, count( $lines ), 0, $edit->orig );
+ }
+ }
+
+ return $lines;
+ }
+
+ /**
+ * Gets the final set of lines.
+ *
+ * This reconstructs the $to_lines parameter passed to the constructor.
+ *
+ * @return array The sequence of strings.
+ */
+ public function getFinal() {
+ $lines = [];
+ foreach ( $this->_edits as $edit ) {
+ if ( $edit->final ) {
+ array_splice( $lines, count( $lines ), 0, $edit->final );
+ }
+ }
+
+ return $lines;
+ }
+
+ /**
+ * Removes trailing newlines from a line of text. This is meant to be used
+ * with array_walk().
+ *
+ * @param string $line The line to trim.
+ * @param int $key The index of the line in the array. Not used.
+ */
+ public function _trimNewlines( &$line, $key ) {
+ $line = str_replace( [ "\n", "\r" ], '', $line );
+ }
+
+ /**
+ * Checks a diff for validity.
+ *
+ * This is here only for debugging purposes.
+ *
+ * @param $from_lines
+ * @param $to_lines
+ *
+ * @return bool
+ */
+ public function _check( $from_lines, $to_lines ) {
+ if ( serialize( $from_lines ) != serialize( $this->getOriginal() ) ) {
+ trigger_error( "Reconstructed original doesn't match", E_USER_ERROR );
+ }
+ if ( serialize( $to_lines ) != serialize( $this->getFinal() ) ) {
+ trigger_error( "Reconstructed final doesn't match", E_USER_ERROR );
+ }
+
+ $rev = $this->reverse();
+ if ( serialize( $to_lines ) != serialize( $rev->getOriginal() ) ) {
+ trigger_error( "Reversed original doesn't match", E_USER_ERROR );
+ }
+ if ( serialize( $from_lines ) != serialize( $rev->getFinal() ) ) {
+ trigger_error( "Reversed final doesn't match", E_USER_ERROR );
+ }
+
+ $prevtype = null;
+ foreach ( $this->_edits as $edit ) {
+ if ( $prevtype == get_class( $edit ) ) {
+ trigger_error( 'Edit sequence is non-optimal', E_USER_ERROR );
+ }
+ $prevtype = get_class( $edit );
+ }
+
+ return true;
+ }
}
/**
@@ -203,53 +205,56 @@ public function _check($from_lines, $to_lines)
* @package Text_Diff
* @author Geoffrey T. Dairiki