Jump to content
kongondo

Menu Builder

Recommended Posts

On 3/24/2020 at 4:03 PM, maddmac said:

Just a question that might be answered in a previous post. If I want to apply a class to the <a> tag how would I do this using the module options?

See the two posts above yours 😀. Currently, this is not possible if using the render() method but I have added it to my todo list.

  • Like 2

Share this post


Link to post
Share on other sites
7 hours ago, kongondo said:

Actually, this is not true 😀.

I don't know what version you are using but there has always been a save as unpublished or published during menu creation and an unpublish/publish action that can be applied to existing menu items in the menus list/table. See the big green shiny buttons 😁.

Am I missing something?

You're right, It just wasn't obvious at the time, now that I create another menu it's fine, i must have been smoking something.. 🚬🍀

Thanks for this great module!!

Share this post


Link to post
Share on other sites

Hey,

I searched the forum, but I couldn't find any post with a topic of the problem that I am facing with the module. 

I setup multilingual menues nd have different roles which have the menu-builder permission. As soon as Editors save a Menu, the custom title translations of the menu are gone. Menu Item titles of the default language are editable as a non-admin user, but all other language titles are ignored / deleted on save.

Are only admin users allowed to edit title translations?

Thanks for a short hint on that.

Share this post


Link to post
Share on other sites

Hi,

I am using Menu builder on a new multi-language web site. It's a simple use case : only on level on the main menu.
It'is working fine. Thanks again for the module.
However I have one issue. the class for the current item is not rendered in the html.

My code is like this

$menu = $modules->get('MarkupMenuBuilder');
$options = array(
                                            'current_class' => 'active',
                                                                         );

echo $menu->render('MainMenu', $options);

One point though : each menu item is a "custom item" with a url to the page and url segments (2 or 3) and all the menu item points to the same page (with different url segment).

Do you think this is the reason why the current class is not present in the html ? If so is there any workaround ?

Thanks a lot

Share this post


Link to post
Share on other sites
1 hour ago, antpre said:

It'is working fine. Thanks again for the module.

Glad you find the module useful.

1 hour ago, antpre said:

One point though : each menu item is a "custom item" with a url to the page and url segments (2 or 3) and all the menu item points to the same page (with different url segment).

I am not sure I understand this statement. By, "custom item", do you mean external links? (e.g., processwire.com). If not, please explain.

Thanks.

Share this post


Link to post
Share on other sites

Kongondo,

I am refering to the 3 choices you have to add a menu item in the admin interface of the module : Pages / Custom /selector.

Each of the menu item are using the custom option. here are 2 items of this menu

1534615158_Screenshot2020-06-25at11_33_06.png.936ea634153b4a01e4060a7e4f626e05.png1738638171_Screenshot2020-06-25at11_32_46.png.744dd42d6bfbd8075ae16ada3224cd47.png

The base url is the same, cause this a single process wire page, and the 2 last bit of the url are the url segments (ie /type/talk or /type/cours).
 

Share this post


Link to post
Share on other sites
Posted (edited)
2 hours ago, antpre said:

2 last bit of the url are the url segments (

My hunch is that this is the reason. I don't think I ever tested MB with url segments. I'll have to look into this. Not sure when though, sorry.

By the way, although the option to use HTML in the title is available, I'd encourage you to use the method getMenuItems() instead (in your template file). It is much more powerful and will give you full control over the markup.

Edited by kongondo

Share this post


Link to post
Share on other sites

Hello,

Im kinda lost here, can't make it work, what am I doing wrong here. It kinda work but not the way it should it looks messy.

HTML:

<nav class="collapse">
  <ul class="nav nav-pills" id="mainNav">
    <li class="dropdown"><a class="dropdown-item dropdown-toggle" href="#">Features</a>
      <ul class="dropdown-menu">
        <li class="dropdown-submenu">
          <a class="dropdown-item" href="#">Headers</a>
            <ul class="dropdown-menu">
            	<li><a class="dropdown-item" href="feature-headers-overview.html">Overview</a></li>
            </ul>
        </li>
      </ul>
    </li>
  </ul>
</nav>
												<?php 
												$menu = $modules->get('MarkupMenuBuilder');
												$options = array(
													'wrapper_list_type' => 'ul',// ul, ol, nav, div, etc.
													'list_type' => 'li',// li, a, span, etc.
													'menu_css_id' => 'mainNav',// a CSS ID for the menu
													'menu_css_class' => 'nav nav-pills',// a CSS Class for the menu
													'submenu_css_class' => 'dropdown dropdown-menu dropdown-item',// CSS Class for sub-menus
													'has_children_class' => 'dropdown dropdown-submenu',// CSS Class for any menu item that has children
													'first_class'=>'',// CSS Class for the first item in 
													'last_class' => '',
													'current_class' => 'active',
													'default_title' => 0,// 0=show saved titles;1=show actual/current titles
													'include_children' => 4,// show 'natural' MB non-native descendant items as part of navigation
													'm_max_level' => 5,// how deep to fetch 'include_children'
													'current_class_level' => 1,// how high up the ancestral tree to apply 'current_class'
													'default_class' => '',// a CSS class to apply to all menu items
												);
												echo $menu->render(1022, $options);
												?>

This is the best combination I could found that doesn't look totaly broken.

Any help appreciated

thank you

R

Share this post


Link to post
Share on other sites
1 hour ago, Roych said:

Im kinda lost here, can't make it work

How should it work? What is not working? 😊

1 hour ago, Roych said:

what am I doing wrong here

Impossible to tell since we don't know what is not working and what you mean by 'working'.

1 hour ago, Roych said:

It kinda work but not the way it should it looks messy.

No idea what this means. What do you mean messy? Maybe show us what you are trying to replicate first.

1 hour ago, Roych said:

I could found that doesn't look totaly broken.

Is it broken or does it look broken? What is broken? Looks like valid HTML to me.

@Roych, please give a better description and/or illustration of how you want the menu output to appear. Thanks.

Share this post


Link to post
Share on other sites

Sorry for beeing so unclear.

So the menu doesnt look like it should. The main menu looks ok, but the submenu looks messy. It does not work as in normal html. I guess my classes in code are not in the right place.

posting gifs below

Looking good: (original HTML)

Working.gif.a732f35b18a017a9fd8c6684b9f19f95.gif

 

Not looking good (my code)

Not-Working.gif.08a9c1c6a3d9b1abe815a3873ec17f46.gif

 

I hope Im making more sense now

Thank you

R

Share this post


Link to post
Share on other sites
1 hour ago, Roych said:

I guess my classes in code are not in the right place.

Probably. Please copy paste here the original menu HTML that you are trying to replicate.

Share this post


Link to post
Share on other sites
19 minutes ago, kongondo said:

Probably. Please copy paste here the original menu HTML that you are trying to replicate.

here is my original html (already posted above) 😉

<nav class="collapse">
  <ul class="nav nav-pills" id="mainNav">
    <li class="dropdown"><a class="dropdown-item dropdown-toggle" href="#">Features</a>
      <ul class="dropdown-menu">
        <li class="dropdown-submenu">
          <a class="dropdown-item" href="#">Headers</a>
            <ul class="dropdown-menu">
            	<li><a class="dropdown-item" href="feature-headers-overview.html">Overview</a></li>
            </ul>
        </li>
      </ul>
    </li>
  </ul>
</nav>

Thank you

R

Share this post


Link to post
Share on other sites
2 minutes ago, Roych said:

here is my original html (already posted above) 😉

I thought this was the output from echo $menu->render(1022, $options);, hence the confusion. In that case then, please post the 'messy/broken' output that results from echo $menu->render()....

Share this post


Link to post
Share on other sites
1 hour ago, kongondo said:

I thought this was the output from echo $menu->render(1022, $options);, hence the confusion. In that case then, please post the 'messy/broken' output that results from echo $menu->render()....

Here it is:

<ul id="mainNav" class="nav nav-pills">
	<li class="active">
		<a href='/'>Domov</a>
	</li>
	<li class="dropdown dropdown-submenu">
		<a href='/about/'>Mladi</a>
		<ul class="dropdown dropdown-menu dropdown-item">
			<li class="dropdown dropdown-submenu">
				<a href='/site-map/'>Site Map</a>
				<ul class="dropdown dropdown-menu dropdown-item">
					<li class="dropdown dropdown-submenu">
						<a href='#'>Test 1</a>
						<ul class="dropdown dropdown-menu dropdown-item">
							<li>
								<a href='#'>Test 2</a>
							</li>
						</ul>
					</li>
				</ul>
			</li>
		</ul>
	</li>
	<li>
		<a href='#'>Test 3</a>
	</li>
</ul>

Thank you

R

Share this post


Link to post
Share on other sites

@Roych

The menu you want cannot presently be achieved by using the render() method. For instance, looking at your <li> tags, going down the levels/depth, they have different classes. This is currently not possible in MB but I will add it to my todo list, e.g. a 'levels class'.

For custom menus such as yours, it is better to use the getMenuItems() method together with a custom recursive function. Below is an example recursive function that will output the example menu you provided. You can adapt it to your needs if you find it useful. It might need a bit of polishing.

Spoiler

<?php namespace ProcessWire;

function buildMenuFromObject($parent = 0, $menu, $first = 0, $level = 0) {
 if (!is_object($menu)) return;

 $level += 1;

 //------- LEVELS CLASSES -------
 //
 $liLevelClasses = '';
 $aLevelClasses = 'dropdown-item';
 if ($level === 1) {
  $liLevelClasses = 'dropdown';
  $aLevelClasses .= ' dropdown-toggle';
 } elseif ($level === 2) $liLevelClasses = 'dropdown-submenu';
 
 //----------

 $out = '';
 $hasChild = false;
 foreach ($menu as $m) {
  // if this menu item is a parent; create the sub-items/child-menu-items
  if ($m->parentID == $parent) {

   // if this is the first child
   if ($hasChild === false) {
    $hasChild = true; // is a parent
    // top/outer <ul></ul>
    if ($first == 0) {
     $out .= "<ul id='mainNav' class='nav nav-pills'>\n";
     $first = 1;
    }
    // submenu/inner <ul></ul>
    else $out .= "\n<ul class='dropdown-menu'>\n";
   }

   // CLASSES FINAL
   // ** li classes **
   // current class
   if ($m->isCurrent) $liLevelClasses .= ' active';
   $liClasses = $liLevelClasses ? " class='{$liLevelClasses}'" : '';

   // ** anchor classes **
   $aClasses = $aLevelClasses ? " class='{$aLevelClasses}'" : '';

   // anchor link (hash for top 2, else real URL)
   $href = $level < 3 ? '#' : $m->url;
   //---------
   // single menu item
   $out .= "<li$liClasses><a$aClasses href='$href'>{$m->title}</a>";

   // call function again to generate nested list for sub-menu items belonging to this menu item.
   $out .= buildMenuFromObject($m->id, $menu, $first, $level);
   $out .= "</li>\n";

  } // end if parent

 } // end foreach

 if ($hasChild === true) {
  $out .= "</ul>\n";
 }
 return $out;

}

//---------------- END FUNCTIONS -------------
$options = array('include_children' => 1, 'm_max_level' => 3);
$mb = $modules->get('MarkupMenuBuilder');
/* grab menu items as a WireArray with Menu objects */
$menuItems = $mb->getMenuItems(1022, 2, $options);
// render custom menu
echo '<nav class="collapse">' . buildMenuFromObject(0, $menuItems) . '</nav>';

 

 

  • Like 1

Share this post


Link to post
Share on other sites

Yes, it would be a great feature for the module. Im mostly using MB. 😉 Thank you for the code I'll try to addapt it to my needs 😉 

Thank you very much

R

Share this post


Link to post
Share on other sites

Hey @kongondo

I've found a PHP warning, i guess, when there a no items assigned to a menu, have a look at the screenshot:

2030783994_2020-10-2310_28_39.thumb.jpg.e1fe166db791c872be35b47765491ced.jpg

Latest Version of PW 3.0.167 / Menu Builder 0.2.5 / PHP 7.2.34

Share this post


Link to post
Share on other sites
10 hours ago, DV-JF said:

I've found a PHP warning,

Thanks for reporting this @DV-JF. Incidentally, @Ivan Gretsky reported the same warning yesterday in the GitHub repo 😀.

  • Like 1

Share this post


Link to post
Share on other sites

Good day, @kongondo!

I can see some great features (like extra_fields option) on a dev branch (added in version 0.2.7). Is there a reason for not releasing it yet for everyone to enjoy on a master branch, which is being installed by default?

  • Like 1

Share this post


Link to post
Share on other sites
3 hours ago, Ivan Gretsky said:

Is there a reason for not releasing it yet for everyone to enjoy on a master branch,

@Ivan Gretsky  Thank you for reminding me about this! Not only are there new features, but the dev version already has fixes for the issue you filed recently! I note that I added these features way back in January 2020! For now, I'll just blame the pandemic/isolation for my forgetfulness 😀.

I'll merge to master asap. Thanks.

  • Like 1

Share this post


Link to post
Share on other sites

Hey @kongondo

I've read the docs and tried to find some hints here in the forum, but couldn't find anything regarding to my problem:

I need some menus only be displayed on the frontend when they are filled in the backend.

When I try to render a menu

<?=$menus->render('footer-3', $scnd_options);?>

with no items in it I get an error:

597270331_2020-10-2911_44_12.thumb.jpg.af5d2aedf0c61cf51ea40ca7349a0326.jpg

Even if i try to count the items before with

<?php bd($menus->getMenuItems('footer-3'));?>

I get this error.

So how can I check, if a specific menu has some items, is not empty or is unpublished and render it only if these conditions match?

Many greets.

Share this post


Link to post
Share on other sites

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now

  • Recently Browsing   0 members

    No registered users viewing this page.

  • Similar Content

    • By hellerdruck
      Hi all
      I need to export all the texts from a website to a translation company (as json or csv or txt...). How can this be done? Of course manually, but this website is huge and it would take me years...
      Also, as a second step, importing the translation ...
      Any ideas anyone? Tutorials? Plugins?
      Thanks for your help.
    • By joshua
      As we often use Matomo (former known as Piwik) instead of Google Analytics we wanted to embed Matomo not only in the template code but also via the ProcessWire backend.
      That's why I developed a tiny module for the implementation.
      Right now it's not heavily tested, so I would call it an "alpha" status.
      The module provides the possibility to connect to an existing Matomo installation with the classical site tracking and also via the Matomo Tag Manager.
      If you have also PrivacyWire installed, you can tell MatomoWire to only load the script, if the user has accepted cookies via PrivacyWire.
      To offer an Opt-Out solution you can choose between the simple Opt-Out iFrame, delivered by your Matomo installation, or a button to choose cookies via PrivacyWire.
      You'll find the current (alpha) state in this git repo: https://github.com/blaueQuelle/matomowire
      As soon as it's better tested, I'll add it to the module repo.
      I'm looking forward to hear your feedback!
    • By FireWire
      Hello community!

      I want to share a new module I've been working on that I think could be a big boost for multi-language ProcessWire sites.

      Some background, I was looking for a way for our company website to be efficiently translated as working with human translators was pretty laborious and a lack of updating content created a divergence between languages. I, and several other devs here, have talked about translation integrations and have recognized the power that DeepL has. DeepL is an AI deep learning powered service that delivers translation quality beyond any automated service available. After access to the API was opened up to the US, I built Fluency, a DeepL translation integration for ProcessWire.
      Fluency brings automated translation to every multi-language field in the admin, and also provides a translation tool allowing the user to translate their text to any language without it being inside a template's field. With Fluency you can:
      Translate any plain textarea or text input Translate any CKEditor content (yes, with markup) Translate page names for fully localized URLs on every page Translate your in-template translation function wrapped strings Translate modules DeepL offers translations to the following languages: English (US), English (UK), German, French, Spanish, Portuguese (EU), Portuguese (Brazil, Italian, Dutch, Polish, Russian, Japanese, Chinese (Simplified)
      Installation and usage is completely plug and play. Whether you're building a new multi-language site, need to update a site to multi-language, or simply want to stop manually translating a site and make any language a one-click deal, it could not be easier to do it. Fluency works by having you match the languages configured in ProcessWIre to DeepL's. You can have your site translating to any or all of the languages DeepL translates to in minutes (quite literally).
      Let's break out the screenshots...
      When the default language tab is shown, a message is displayed to let users know that translation is available. Clicking on each tab shows a link that says "Translate from English". Clicking it shows an animated overlay with the word "Translating..." cycling through each language and a light gradient shift. Have a CKEditor field? All good. Fluency will translated it and use DeepL's ability to translate text within HTML tags. CKEditor fields can be translated as easily and accurately as text/textarea fields.

      Repeaters and AJAX created fields also have translation enabled thanks to a JavaScript MutationObserver that searches for multi-language fields and adds translation as they're inserted into the DOM. If there's a multi-language field on the page, it will have translation added.

      Same goes for image description fields. Multi-language SEO friendly images are good to go.

      Creating a new page from one of your templates? Translate your title, and also translate your page name for native language URLs. (Not available for Russian, Chinese, or Japanese languages due to URL limitations). These can be changed in the "Settings" tab for any page as well so whether you're translating new pages or existing pages, you control the URLs everywhere.

      Language configuration pages are no different. Translate the names of your languages and search for both Site Translation Files (including all of your modules)

      Translate all of the static text in your templates as well. Notice that the placeholders are retained. DeepL is pretty good at recognizing and keeping non-translatable strings like that. If it is changed, it's easy to fix manually.

      Fluency adds a "Translate" item to the CMS header. When clicked this opens up a modal with a full translation tool that lets the user translate any language to any language. No need to leave the admin if you need to translate content from a secondary language back to the default ProcessWire language. There is also a button to get the current API usage statistics. DeepL account owners can set billing limitations via character count to control costs. This may help larger sites or sites being retrofitted keep an eye on their usage. This tool is available for all users with the page-edit permission.

      It couldn't be easier to add Fluency to your new or existing website. Simply add your API key and you're shown what languages are currently available for translation from/to as provided by DeepL. This list and all configuration options are taken live from the API so when DeepL releases new languages you can add them to your site without any work. No module updates, just an easy configuration. Just match the language you configured in ProcessWire to the DeepL language you want it to be associated with and you're done. Fluency also allows you to create a list of words/phrases that will not be translated which can prevent items such as brands and company names from being translated when they shouldn't

       
      Limitations:
      No "translate page" - Translating multiple fields can be done by clicking multiple translation links on multiple fields at once but engineering a "one click page translate" is not feasible from a user experience standpoint. The time it takes to translate one field can be a second or two, but cumulatively that may take much longer (CKEditor fields are slower than plain text fields). There may be a workaround in the future but it isn't currently on the roadmap. No "translate site" - Same thing goes for translating an entire website at once. It would be great, but it would be a very intense process and take a very (very) long time. There may be a workaround in the future but it isn't on the roadmap. No current support for Inline CKEditor fields - Handling for CKEditor on-demand hasn't been implemented yet, this is planned for a future release though and can be done. I just forgot about it because I've never really used that feature personally.. Alpha release - This module is in alpha. Releases should be stable and usable, but there may be edge case issues. Test the module thoroughly and please report any bugs via a Gitlab issue on the repository or respond here. Please note that the browser plugin for Grammarly conflicts with Fluency (as it does with many web applications). To address this issue it is recommended that you disable Grammarly when using Fluency, or open the admin to edit pages in a private window where Grammarly may not be loaded. This is an issue that may not have a resolution as creating a workaround may not be possible. If you have insight as to how this may be solved please visit the Gitlab page and file a bugfix ticket.
      Requirements:
      ProcessWire  3.0+ UIKit Admin Theme That's Fluency in a nutshell. A core effort in this module is to create it so that there is nothing DeepL related hard-coded in that would require updating it when DeepL offers new languages. I would like this to be a future-friendly module that doesn't require developer work to keep it up-to-date.
      It's Free
      This is my first real module and I want to give it back to the community as thanks. This is the best CMS I've worked with (thank you Ryan & contributors) and a great community (thank you dear reader). The only cost to use this is a subscription fee for the DeepL Pro API. Find out more and sign up here.
      Download & Feedback
      Download the latest version here
      https://gitlab.com/SkyLundy/fluency-processwire/-/archive/master/fluency-processwire-master.zip
      Gitlab repository:
      https://gitlab.com/SkyLundy/fluency-processwire
      File issues and feature requests here (your feedback and testing is greatly appreciated):
      https://gitlab.com/SkyLundy/fluency-processwire/-/issues
       
      Thank you! ¡Gracias! Ich danke Ihnen! Merci! Obrigado! Grazie! Dank u wel! Dziękuję! Спасибо! ありがとうございます! 谢谢你!

    • By horst
      ---------------------------------------------------------------------------------------------------------------------------------
        when working with PW version 2.6+, please use Pim2, not Pim!
        read more here  on how to change from the older to the newer version in existing sites
      ---------------------------------------------------------------------------------------------------------------------------------
      PageImage Manipulator, API for version 1 & 2

      The Page Image Manipulator is a module that let you in a first place do ImageManipulations with your PageImages. - And in a second place there is the possibility to let it work on any imagefile that exists in your servers filesystem, regardless if it is a 'known PW-image'.

      The Page Image Manipulator is a Toolbox for Users and Moduledevelopers. It is written to be as close to the Core ImageSizer as possible. Besides the GD-filterfunctions it contains resize, crop, canvas, rotate, flip, sharpen, unsharpMask and 3 watermark methods.



      How does it work?

      You can enter the ImageManipulator by calling the method pim2Load(). After that you can chain together how many actions in what ever order you like. If your manipulation is finished, you call pimSave() to write the memory Image into a diskfile. pimSave() returns the PageImage-Object of the new written file so we are able to further use any known PW-image property or method. This way it integrates best into the ProcessWire flow.

      The three examples above put out the same visual result: a grayscale image with a width of 240px. Only the filenames will slightly differ.

      You have to define a name-prefix that you pass with the pimLoad() method. If the file with that prefix already exists, all operations are skipped and only the desired PageImage-Object gets returned by pimSave(). If you want to force recreation of the file, you can pass as second param a boolean true: pim2Load('myPrefix', true).

      You may also want to get rid of all variations at once? Than you can call $pageimage->pim2Load('myPrefix')->removePimVariations()!

      A complete list of all methods and actions are at the end of this post.
       
      You may also visit the post with tips & examples for users and module developers.


      How to Install
      Download the module Place the module files in /site/modules/PageImageManipulator/ In your admin, click Modules > Check for new modules Click "install" for PageImageManipulator Done! There are no configuration settings needed, just install and use it. Download    (version 0.2.0)
      get it from the Modules Directory History of origins

      http://processwire.com/talk/topic/3278-core-imagemanipulation/


      ----------------------------------------------------------------------------------------------------------


      Page Image Manipulator - Methods

      * pimLoad  or  pim2Load, depends on the version you use!

      pimLoad($prefix, $param2=optional, $param3=optional)
      param 1: $prefix - (string) = mandatory! param 2: mixed, $forceRecreation or $options param 3: mixed, $forceRecreation or $options return: pim - (class handle) $options - (array) default is empty, see the next method for a list of valid options! $forceRecreation - (bool) default is false It check if the desired image variation exists, if not or if forceRecreation is set to true, it prepares all settings to get ready for image manipulation
      -------------------------------------------------------------------

      * setOptions

      setOptions(array $options)
      param: $options - (array) default is empty return: pim - (class handle) Takes an array with any number valid options / properties and set them by replacing the class-defaults and / or the global config defaults optionally set in the site/config.php under imageSizerOptions or imageManipulatorOptions.

      valid options are:
      quality = 1 - 100 (integer) upscaling = true | false (boolean) cropping = true | false (boolean) autoRotation =true | false (boolean) sharpening = 'none' | 'soft' | 'medium' | 'strong' (string) bgcolor = (array) css rgb or css rgba, first three values are integer 0-255 and optional 4 value is float 0-1, - default is array(255,255,255,0) thumbnailColorizeCustom = (array) rgb with values for colorize, integer -255 - 255 (this can be used to set a custom color when working together with Thumbnails-Module)
        outputFormat = 'gif' | 'jpg' | 'png' (Attention: outputFormat cannot be specified as global option in $config->imageManipulatorOptions!) set {singleOption} ($value)
      For every valid option there is also a single method that you can call, like setQuality(90), setUpscaling(false), etc.
      -------------------------------------------------------------------

      * pimSave

      pimSave()
      return: PageImage-Object If a new image is hold in memory, it saves the current content into a diskfile, according to the settings of filename, imagetype, targetFilename and outputFormat. Returns a PageImage-Object!
      -------------------------------------------------------------------

      * release

      release()
      return: void (nothing) if you, for what ever reason, first load image into memory but than do not save it, you should call release() to do the dishes! 😉 If you use pimSave() to leave the ImageManipulator, release() is called automatically.
      -------------------------------------------------------------------

      * getOptions

      getOptions()
      return: associative array with all final option values example:
      ["autoRotation"] bool(true) ["upscaling"] bool(false) ["cropping"] bool(true) ["quality"] int(90) ["sharpening"] string(6) "medium" ["targetFilename"] string(96) "/htdocs/site/assets/files/1124/pim_prefix_filename.jpg" ["outputFormat"] string(3) "jpg" get {singleOption} ()
      For every valid option there is also a single method that you can call, like getQuality(), getUpscaling(), etc. See method setOptions for a list of valid options!
      -------------------------------------------------------------------

      * getImageInfo

      getImageInfo()
      return: associative array with useful informations of source imagefile example:
      ["type"] string(3) "jpg" ["imageType"] int(2) ["mimetype"] string(10) "image/jpeg" ["width"] int(500) ["height"] int(331) ["landscape"] bool(true) ["ratio"] float(1.5105740181269) ["bits"] int(8) ["channels"] int(3) ["colspace"] string(9) "DeviceRGB" -------------------------------------------------------------------

      * getPimVariations

      getPimVariations()
      return: array of Pageimages Collect all pimVariations of this Pageimage as a Pageimages array of Pageimage objects. All variations created by the core ImageSizer are not included in the collection.
      -------------------------------------------------------------------

      * removePimVariations

      removePimVariations()
      return: pim - (class handle) Removes all image variations that was created using the PIM, all variations that are created by the core ImageSizer are left untouched!
      -------------------------------------------------------------------
      * width

      width($dst_width, $sharpen_mode=null)
      param: $dst_width - (integer) param: $auto_sharpen - (boolean) default is true was deleted with version 0.0.8, - sorry for breaking compatibility param: $sharpen_mode - (string) possible: 'none' | 'soft' | 'medium' | 'strong', default is 'soft' return: pim - (class handle) Is a call to resize where you prioritize the width, like with pageimage. Additionally, after resizing, an automatic sharpening can be done with one of the three modes.
      -------------------------------------------------------------------

      * height

      height($dst_height, $sharpen_mode=null)
      param: $dst_height - (integer) param: $auto_sharpen - (boolean) default is true was deleted with version 0.0.8, - sorry for breaking compatibility param: $sharpen_mode - (string) possible: 'none' | 'soft' | 'medium' | 'strong', default is 'soft' return: pim - (class handle) Is a call to resize where you prioritize the height, like with pageimage. Additionally, after resizing, an automatic sharpening can be done with one of the three modes.
      -------------------------------------------------------------------

      * resize

      resize($dst_width=0, $dst_height=0, $sharpen_mode=null)
      param: $dst_width - (integer) default is 0 param: $dst_height - (integer) default is 0 param: $auto_sharpen - (boolean) default is true was deleted with version 0.0.8, - sorry for breaking compatibility param: $sharpen_mode - (string) possible: 'none' | 'soft' | 'medium' | 'strong', default is 'soft' return: pim - (class handle) Is a call to resize where you have to set width and / or height, like with pageimage size(). Additionally, after resizing, an automatic sharpening can be done with one of the three modes.
      -------------------------------------------------------------------

      * stepResize

      stepResize($dst_width=0, $dst_height=0)
      param: $dst_width - (integer) default is 0 param: $dst_height - (integer) default is 0 return: pim - (class handle) this performs a resizing but with multiple little steps, each step followed by a soft sharpening. That way you can get better result of sharpened images.
      -------------------------------------------------------------------

      * sharpen

      sharpen($mode='soft')
      param: $mode - (string) possible values 'none' | 'soft'| 'medium'| 'strong' return: pim - (class handle) Applys sharpening to the current memory image. You can call it with one of the three predefined pattern, or you can pass an array with your own pattern.
      -------------------------------------------------------------------

      * unsharpMask

      unsharpMask($amount, $radius, $threshold)
      param: $amount - (integer) 0 - 500, default is 100 param: $radius - (float) 0.1 - 50, default is 0.5 param: $threshold - (integer) 0 - 255, default is 3 return: pim - (class handle) Applys sharpening to the current memory image like the equal named filter in photoshop.
      Credit for the used unsharp mask algorithm goes to Torstein Hønsi who has created the function back in 2003.
      -------------------------------------------------------------------

      * smooth

      smooth($level=127)
      param: $level - (integer) 1 - 255, default is 127 return: pim - (class handle) Smooth is the opposite of sharpen. You can define how strong it should be applied, 1 is low and 255 is strong.
      -------------------------------------------------------------------

      * blur

      blur()
      return: pim - (class handle) Blur is like smooth, but cannot called with a value. It seems to be similar like a result of smooth with a value greater than 200.
      -------------------------------------------------------------------

      * crop

      crop($pos_x, $pos_y, $width, $height)
      param: $pos_x - (integer) start position left param: $pos_y - (integer) start position top param: $width - (integer) horizontal length of desired image part param: $height - (integer) vertical length of desired image part return: pim - (class handle) This method cut out a part of the memory image.
      -------------------------------------------------------------------

      * canvas

      canvas($width, $height, $bgcolor, $position, $padding)
      param: $width = mixed, associative array with options or integer, - mandatory! param: $height = integer, - mandatory if $width is integer! param: $bgcolor = array with rgb or rgba, - default is array(255, 255, 255, 0) param: $position = one out of north, northwest, center, etc, - default is center param: $padding = integer as percent of canvas length, - default is 0 return: pim - (class handle) This method creates a canvas according to the given width and height and position the memory image onto it.
      You can pass an associative options array as the first and only param. With it you have to set width and height and optionally any other valid param. Or you have to set at least width and height as integers.
      Hint: If you want use transparency with rgba and your sourceImage isn't of type PNG, you have to define 'png' as outputFormat with your initially options array or, for example, like this: $image->pimLoad('prefix')->setOutputFormat('png')->canvas(300, 300, array(210,233,238,0.5), 'c', 5)->pimSave()
      -------------------------------------------------------------------

      * flip

      flip($vertical=false)
      param: $vertical - (boolean) default is false return: pim - (class handle) This flips the image horizontal by default. (mirroring)
      If the boolean param is set to true, it flips the image vertical instead.
      -------------------------------------------------------------------

      * rotate

      rotate($degree, $backgroundColor=127)
      param: $degree - (integer) valid is -360 0 360 param: $backgroundColor - (integer) valid is 0 - 255, default is 127 return: pim - (class handle) This rotates the image. Positive values for degree rotates clockwise, negative values counter clockwise. If you use other values than 90, 180, 270, the additional space gets filled with the defined background color.
      -------------------------------------------------------------------

      * brightness

      brightness($level)
      param: $level - (integer) -255 0 255 return: pim - (class handle) You can adjust brightness by defining a value between -255 and +255. Zero lets it unchanged, negative values results in darker images and positive values in lighter images.
      -------------------------------------------------------------------

      * contrast

      contrast($level)
      param: $level - (integer) -255 0 255 return: pim - (class handle) You can adjust contrast by defining a value between -255 and +255. Zero lets it unchanged, negative values results in lesser contrast and positive values in higher contrast.
      -------------------------------------------------------------------

      * grayscale

      grayscale()
      return: pim - (class handle) Turns an image into grayscale. Remove all colors.
      -------------------------------------------------------------------

      * sepia

      sepia()
      return: pim - (class handle) Turns the memory image into a colorized grayscale image with a predefined rgb-color that is known as "sepia".
      -------------------------------------------------------------------

      * colorize

      colorize($anyColor)
      param: $anyColor - (array) like css rgb or css rgba - but with values for rgb -255 - +255,  - value for alpha is float 0 - 1, 0 = transparent  1 = opaque return: pim - (class handle) Here you can adjust each of the RGB colors and optionally the alpha channel. Zero lets the channel unchanged whereas negative values results in lesser / darker parts of that channel and higher values in stronger saturisation of that channel.
      -------------------------------------------------------------------

      * negate

      negate()
      return: pim - (class handle) Turns an image into a "negative".
      -------------------------------------------------------------------

      * pixelate

      pixelate($blockSize=3)
      param: $blockSize - (integer) 1 - ??, default is 3 return: pim - (class handle) This apply the well known PixelLook to the memory image. It is stronger with higher values for blockSize.
      -------------------------------------------------------------------

      * emboss

      emboss()
      return: pim - (class handle) This apply the emboss effect to the memory image.
      -------------------------------------------------------------------

      * edgedetect

      edgedetect()
      return: pim - (class handle) This apply the edge-detect effect to the memory image.
      -------------------------------------------------------------------

      * getMemoryImage

      getMemoryImage()
      return: memoryimage - (GD-Resource) If you want apply something that isn't available with that class, you simply can check out the current memory image and apply your image - voodoo - stuff
      -------------------------------------------------------------------

      * setMemoryImage

      setMemoryImage($memoryImage)
      param: $memoryImage - (GD-Resource) return: pim - (class handle) If you are ready with your own image stuff, you can check in the memory image for further use with the class.
      -------------------------------------------------------------------

      * watermarkLogo

      watermarkLogo($pngAlphaImage, $position='center', $padding=2)
      param: $pngAlphaImage - mixed [systemfilepath or PageImageObject] to/from a PNG with transparency param: $position - (string) is one out of: N, E, S, W, C, NE, SE, SW, NW,
      - or: north, east, south, west, center, northeast, southeast, southwest, northwest
      default is 'center' param: $padding - (integer) 0 - 25, default is 5, padding to the borders in percent of the images length! return: pim - (class handle) You can pass a transparent image with its filename or as a PageImage to the method. If the watermark is bigger than the destination-image, it gets shrinked to fit into the targetimage. If it is a small watermark image you can define the position of it:
      NW - N - NE | | | W - C - E | | | SW - S - SE  
      The easiest and best way I have discovered to apply a big transparency watermark to an image is as follows:
      create a square transparent png image of e.g. 2000 x 2000 px, place your mark into the center with enough (percent) of space to the borders. You can see an example here! The $pngAlphaImage get centered and shrinked to fit into the memory image. No hassle with what width and / or height should I use?, how many space for the borders?, etc.
      -------------------------------------------------------------------

      * watermarkLogoTiled

      watermarkLogoTiled($pngAlphaImage)
      param: $pngAlphaImage - mixed [systemfilepath or PageImageObject] to/from a PNG with transparency return: pim - (class handle) Here you have to pass a tile png with transparency (e.g. something between 150-300 px?) to your bigger images. It got repeated all over the memory image starting at the top left corner.
      -------------------------------------------------------------------

      * watermarkText

      watermarkText($text, $size=10, $position='center', $padding=2, $opacity=50, $trueTypeFont=null)
      param: $text - (string) the text that you want to display on the image param: $size - (integer) 1 - 100, unit = points, good value seems to be around 10 to 15 param: $position - (string) is one out of: N, E, S, W, C, NE, SE, SW, NW,
      - or: north, east, south, west, center, northeast, southeast, southwest, northwest
      default is 'center' param: $padding - (integer) 0 - 25, default is 2, padding to the borders in percent of the images length! param: $opacity- (integer) 1 - 100, default is 50 param: $trueTypeFont - (string) systemfilepath to a TrueTypeFont, default is freesansbold.ttf (is GPL & comes with the module) return: pim - (class handle) Here you can display (dynamic) text with transparency over the memory image. You have to define your text, and optionally size, position, padding, opacity for it. And if you don't like the default font, freesansbold, you have to point to a TrueTypeFont-File of your choice.
      Please have a look to example output: http://processwire.com/talk/topic/4264-release-page-image-manipulator/page-2#entry41989
      -------------------------------------------------------------------





      PageImage Manipulator - Example Output


×
×
  • Create New...