OC 3.0.x Events System: How to modify twig template file?

madimar wrote: ↑

Tue Dec 22, 2020 2:04 am

straightlight wrote: ↑

Mon Dec 21, 2020 8:40 am

Directly into the install.xml file to search for lines and alter them.

DO YOU MEAN OCMOD ?!?

straightlight wrote: ↑

Tue Dec 22, 2020 2:15 am

madimar wrote: ↑

Tue Dec 22, 2020 2:04 am

straightlight wrote: ↑

Mon Dec 21, 2020 8:40 am

Directly into the install.xml file to search for lines and alter them.

DO YOU MEAN OCMOD ?!?

Yes and please don't use caps when posting.

As of OpenCart 3.1.0.0+ OCMOD will be removed from the OpenCart source code. Only the event system will be used for modifications.

Looking at all of that, it makes me wonder why a replacement via the install.xml (which still exists and is used further) is recommended, because it won't work anymore.

Well, thanks for your confirmation. Regarding the caps it was just a few words and in this specific case they were used intentionally to shout my wonder!

JNeuhoff wrote: ↑

Tue Dec 22, 2020 9:01 pm

I think all the install.xml will do is to describe the extension, e.g. name, version, author, and link. No more core file modifications.

'extension_id'          => 0,
'extension_download_id' => 0,
'name'                  => $name,
'code'              	=> basename($filename, '.ocmod.zip'),
'version'               => $version,
'author'                => $author,
'link'                  => $link

madimar wrote: ↑

Tue Dec 22, 2020 2:04 am

straightlight wrote: ↑

Mon Dec 21, 2020 8:40 am

Directly into the install.xml file to search for lines and alter them.

DO YOU MEAN OCMOD ?!?

kestas wrote: ↑

Sat Jan 30, 2021 9:35 pm

.. OCMOD has been removed from OC4.x.x.x...
Can anybody explain.

OCMod (therefore also the function modification(..) as sometimes used since OC 2.x) is OBSOLETE!

I do not understand something... @Straightlight always talking to use events everywhere and what is it? OCMOD again? And OCMOD has been removed from OC4.x.x.x... Can anybody explain. I'm confused

kestas wrote: ↑

Sat Jan 30, 2021 9:35 pm

madimar wrote: ↑

Tue Dec 22, 2020 2:04 am

straightlight wrote: ↑

Mon Dec 21, 2020 8:40 am

Directly into the install.xml file to search for lines and alter them.

DO YOU MEAN OCMOD ?!?

I do not understand something... @Straightlight always talking to use events everywhere and what is it? OCMOD again? And OCMOD has been removed from OC4.x.x.x... Can anybody explain. I'm confused

Exel wrote: ↑

Sat Feb 13, 2021 5:30 pm

I've been looking into code injection into the template files and came across this thread. Lots of good ideas and talk here.

I came up with a simpler solution (I think) than what's been posted here. It works in the same principal as some of the other posts online but it has the nice added bonus that the only thing you need to worry about is finding the html line of what you want to either find / replace ($find var below).

straightlight wrote: ↑

Fri Mar 04, 2022 1:04 am

The /before and /after triggers are already explained on the Wiki documentation on anyhow.

OSWorX wrote: ↑

Fri Mar 04, 2022 1:33 am

straightlight wrote: ↑

Fri Mar 04, 2022 1:04 am

The /before and /after triggers are already explained on the Wiki documentation on anyhow.

Correct .. but who is reading it?
And (btw.), this "Wiki" must be found to be able to read it.
And "error free" is something else, also wether complete nor easy to understand sometimes ..

Just for those, who want to read more: https://github.com/opencart/opencart/wiki/Events-System

straightlight wrote: ↑

Fri Mar 04, 2022 3:31 am

Simple, it's to those who can. That's what true developers are about.

OSWorX wrote: ↑

Fri Mar 04, 2022 4:55 am

straightlight wrote: ↑

Fri Mar 04, 2022 3:31 am

Simple, it's to those who can. That's what true developers are about.

Yes (who can read), but don't forget, this here aims to be a user forum, not a developers discussion board (that's what GH is for).

straightlight wrote: ↑

Fri Mar 04, 2022 5:51 am

one of my extensions that does show how to use Events on the same location.

JNeuhoff wrote: ↑

Fri Dec 11, 2020 8:55 pm

It can be done with a before-event handler, though it's a bit convoluted:

Code: Select all

	// event handler for admin/view/catalog/product_form/before
	public function eventViewCatalogProductFormBefore( &$route, &$data, &$template_code=null ) {

		$template_buffer = $this->getTemplateBuffer( $route, $template_code );

		$search  = '{% if customer_group.customer_group_id == product_special.customer_group_id %}';
		$replace = '{% if customer_group.customer_group_id == product_special.customer_group_id and some_new_variable_equal_true %}';
		$template_buffer = str_replace( $search, $replace, $template_buffer );

		$template_code = $template_buffer;

		return null;
	}


	// return template file contents as a string
	protected function getTemplateBuffer( $route, $event_template_buffer ) {
		// if there already is a modified template from view/*/before events use that one
		if ($event_template_buffer) {
			return $event_template_buffer;
		}

		// load the template file (possibly modified by ocmod and vqmod) into a string buffer
		if ($this->isAdmin()) {
			$dir_template = DIR_TEMPLATE;
		} else {
			if ($this->config->get('config_theme') == 'default') {
				$theme = $this->config->get('theme_default_directory');
			} else {
				$theme = $this->config->get('config_theme');
			}
			$dir_template = DIR_TEMPLATE . $theme . '/template/';
		}
		$template_file = $dir_template . $route . '.twig';
		if (file_exists( $template_file ) && is_file( $template_file )) {
			$template_file = $this->modCheck( $template_file );
			return file_get_contents( $template_file );
		}
		if ($this->isAdmin()) {
			trigger_error("Cannot find template file for route '$route'");
			exit;
		}
		$dir_template = DIR_TEMPLATE . 'default/template/';
		$template_file = $dir_template . $route . '.twig';
		if (file_exists( $template_file ) && is_file( $template_file )) {
			$template_file = $this->modCheck( $template_file );
			return file_get_contents( $template_file );
		}
		trigger_error("Cannot find template file for route '$route'");
		exit;
	}


	protected function isAdmin() {
		return defined( 'DIR_CATALOG' ) ? true : false;
	}


	protected function modCheck( $file ) {
		// return a PHP file possibly modified by OpenCart's system/storage/modification,
		//   and then possibly modified by vqmod (see also https://github.com/vqmod/vqmod)

		// Use OpenCart's modified file is available
		$original_file = $file;
		if (defined('DIR_MODIFICATION')) {
			if ($this->startsWith($file,DIR_APPLICATION)) {
				if ($this->isAdmin()) {
					if (file_exists( DIR_MODIFICATION . 'admin/' . substr($file,strlen(DIR_APPLICATION)) )) {
						$file = DIR_MODIFICATION . 'admin/' . substr($file,strlen(DIR_APPLICATION));
					}
				} else {
					if (file_exists( DIR_MODIFICATION . 'catalog/' . substr($file,strlen(DIR_APPLICATION)) )) {
						$file = DIR_MODIFICATION . 'catalog/' . substr($file,strlen(DIR_APPLICATION));
					}
				}
			} else if ($this->startsWith($file,DIR_SYSTEM)) {
				if (file_exists( DIR_MODIFICATION . 'system/' . substr($file,strlen(DIR_SYSTEM)) )) {
					$file = DIR_MODIFICATION . 'system/' . substr($file,strlen(DIR_SYSTEM));
				}
			}
		}

		// Don't use VQmod 2.3.2 or earlier if available
		if (array_key_exists('vqmod', get_defined_vars())) {
			trigger_error( "You are using an old VQMod version '2.3.2' or earlier, please upgrade your VQMod!" );
			exit;
		}

		// Use modification through VQmod 2.4.0 or later if available
		if (class_exists('VQMod',false)) {
			if (VQMod::$directorySeparator) {
				if (strpos($file,'vq2-')!==FALSE) {
					return $file;
				}
				if (version_compare(VQMod::$_vqversion,'2.5.0','<')) {
					trigger_error( "You are using an old VQMod version '".VQMod::$_vqversion."', please upgrade your VQMod!" );
					exit;
				}
				if ($original_file != $file) {
					return VQMod::modCheck($file,$original_file);
				}
				return VQMod::modCheck($original_file);
			}
		}

		// no VQmod
		return $file;
	}


	protected function startsWith( $haystack, $needle ) {
		if (strlen( $haystack ) < strlen( $needle )) {
			return false;
		}
		return (substr( $haystack, 0, strlen($needle) ) == $needle);
	}

The basic idea is to use a simple str_replace call in the event handler.