Icy Phoenix

     
 

ACP - How To Easily Add A Configuration Entry / Value To ACP

ACP - How To Easily Add A Configuration Entry / Value To ACP

Article
Reply with quote    Download Post  
Post ACP - How To Easily Add A Configuration Entry / Value To ACP 
 
Hi,
I'll make a short example on how you can easily add your own configuration section to ACP => Configuration => Icy Phoenix.

  1. First step create a new empty file into includes/mods_settings and call it as you like (you just need to make sure to have the prefix mod_ in front of it). For the benefit of this tutorial we will call it mod_my_brand_new_config_section.php.
  2. Fill the file with the config entries you need, these entries will be inserted automatically into phpbb_config table (of course table prefix may be different for your own configuration). Here is an example which adds two vars one being YES/NO and the other a TEXT one:
    Spoiler: [ Show ]

  3. You will now need to create language entries for all those new vars, and to do that let's create a brand new lang file so to avoid messing with standard Icy Phoenix files. Again the name could be as you like, but you need to pay attention to the prefix which in this case should be lang_extend_. In this example let's suppose we have only English lang installed (if you have more than one lang you need to replicate this for any lang installed) and we will use this filename: lang_extend_my_brand_new_lang_file.php. Of course the file have to be located into language/lang_english/ folder!
  4. The content of the file should be something like this:
    Spoiler: [ Show ]

  5. Now that everything has been created, we are ready to use our own vars everywhere in Icy Phoenix by just using:
    • $board_config['my_yes_no_var']
    • $board_config['my_text_var']

  6. Enjoy your new vars!!!



You have created your own config section and vars without having edited a single Icy Phoenix file, did you expect it could be so easy?



 
Mighty Gorgon - View user's profile Send private message  
Mighty Gorgon [ Sat 12 Sep, 2009 09:40 ]
Icy Phoenix is an open source project, you can show your appreciation and support future development by donating to the project.

Support us


ACP - How To Easily Add A Configuration Entry / Value To ACP

Comments
Reply with quote    Download Post  
Post Re: ACP - How To Easily Add A Configuration Entry / Value To ACP 
 
I forgot to mention that you can use the same procedure to add new profile options for users... but that require some extra editing.

If someone is interested I may create extra instructions in the future... if someone would like to try on is own and report the results, is more than welcome.



 
Mighty Gorgon - View user's profile Send private message  
Mighty Gorgon [ Sat 12 Sep, 2009 09:54 ]
Reply with quote    Download Post  
Post Re: ACP - How To Easily Add A Configuration Entry / Value To ACP 
 
Thank you MG!

I'll be testing this tomorrow to see what I can apply it to.

I hope you've got it right! ROFL!  



 
   
Inactive User [ Sat 12 Sep, 2009 10:23 ]
Reply with quote    Download Post  
Post Re: ACP - How To Easily Add A Configuration Entry / Value To ACP 
 
Fantastic... work around...

I shall be looking at this for future modifications...

   



 
DWho - View user's profile Send private message  
DWho [ Sun 13 Sep, 2009 16:54 ]
Reply with quote    Download Post  
Post Re: ACP - How To Easily Add A Configuration Entry / Value To ACP 
 
Mighty Gorgon wrote: [View Post]
I forgot to mention that you can use the same procedure to add new profile options for users... but that require some extra editing.

If someone is interested I may create extra instructions in the future... if someone would like to try on is own and report the results, is more than welcome.



Can´t wait to see more instructions. Thank´s MG



 
spydie - View user's profile Send private message  
spydie [ Sun 13 Sep, 2009 18:29 ]
Reply with quote    Download Post  
Post Re: ACP - How To Easily Add A Configuration Entry / Value To ACP 
 
Mighty Gorgon wrote: [View Post]
Hi,
I'll make a short example on how you can easily add your own configuration section to ACP => Configuration => Icy Phoenix.

Code: [Download] [Hide] [Select]
$mod_name = '120_My_Own_Mods';


Code: [Download] [Hide] [Select]
$lang = array_merge($lang, array(
    '120_My_Own_Mods' => 'My Own Mods',
    )

Hi,
I'm creating a new simple mod for icy phoenix and i would like to have some parameter to be editable from ACP.
What is unclear to me is the number 120 in the mod's name; i guess it is related to the position of my own configuration section within ACP.
Where can i find any information about it ?

Thanks in advance



 
Jodi - View user's profile Send private message  
Jodi [ Sat 14 Nov, 2009 09:44 ]
Reply with quote    Download Post  
Post Re: ACP - How To Easily Add A Configuration Entry / Value To ACP 
 
Since currently there is no way to sort ACP modules via DB, sorting is performed alphabetically based on the lang var name.

That number is just an example, you can either remove or change it to suit your needs.



 
Mighty Gorgon - View user's profile Send private message  
Mighty Gorgon [ Sun 15 Nov, 2009 11:06 ]
Reply with quote    Download Post  
Post Re: ACP - How To Easily Add A Configuration Entry / Value To ACP 
 
Jodi wrote: [View Post]

Hi,
I'm creating a new simple mod for icy phoenix and i would like to have some parameter to be editable from ACP.
What is unclear to me is the number 120 in the mod's name; i guess it is related to the position of my own configuration section within ACP.
Where can i find any information about it ?

Thanks in advance

I posted the message above because my mod settings doesn't appeared in ACP and I guessed it was related to the number 120 in the mod's name.
To insert my mod settings in ACP has been necessary to remove the following lines from first example (file mod_my_brand_new_config_section.php):

Code: [Download] [Hide] [Select]
$is_allowed = check_acp_module_access();
if ($is_allowed == false)
{
    return;
}

Are these lines related to a previous release of icyphoenix ?

I'm using icyphoenix 1.3.0.53



 
Jodi - View user's profile Send private message  
Jodi [ Sun 15 Nov, 2009 11:12 ]
Reply with quote    Download Post  
Post Re: ACP - How To Easily Add A Configuration Entry / Value To ACP 
 
As I wrote at the beginning of the post, when you create a module using this way, it will be shown in ACP => Configuration => Icy Phoenix.

Try to check there.



 
Mighty Gorgon - View user's profile Send private message  
Mighty Gorgon [ Sun 15 Nov, 2009 11:21 ]
Reply with quote    Download Post  
Post Re: ACP - How To Easily Add A Configuration Entry / Value To ACP 
 
Mighty Gorgon wrote: [View Post]
As I wrote at the beginning of the post, when you create a module using this way, it will be shown in ACP => Configuration => Icy Phoenix.

Try to check there.

My settings are shown in APC->Configuration->Icy Phoenix only if i comment out/remove the code above.



 
Jodi - View user's profile Send private message  
Jodi [ Sun 15 Nov, 2009 11:32 ]
Reply with quote    Download Post  
Post Re: ACP - How To Easily Add A Configuration Entry / Value To ACP 
 
Yes, you are right.

Fixed first post.

Thanks



 
Mighty Gorgon - View user's profile Send private message  
Mighty Gorgon [ Sun 15 Nov, 2009 11:53 ]
Display posts from previous:    

HideWas this topic useful?

Post new topic  Reply to topic  Page 1 of 1