Ok, in working on the Accounts addon after the addition of the menu login, I noticed that when I'm not in an accounts page on the roster, my locale strings are not parsed, causing the User Name wording to disappear and a undefined index notice to appear. Do we have a roster function to get a specific addon's locale strings that I haven't seen? If not can we add one? Or will I have to include my locale files in the getMenuLoginForm function?

Hmm, I'd guess you can probably still pull it out of the $roster->locale->wordings['locale'] strings, but I'm not certain about that...

No, there is no way currently to get a certain string from an addon when the addon is not active in Roster
We could probably include this ability

$roster->locale->getString('key','basename');

How does that sound other devs?

That function would work perfectly. I hope the other devs think it would be a good addition. I could think of other uses for this, like grabbing the locale strings from the memberslist addon.

Sounds like a good idea to me

To be added in the next svn commit

Code: Select all

    /**
     * Method to get a locale string using the passed key/addonname/locale
     * Pass a key to return the desired locale string
     * If addonname is not passed, it will return $roster->locale->wordings[$locale][$key]
     * If locale is not passed, it will default to the current locale setting
     *
     * @param string $key | Locale string to return
     * @param string $addon | Addon to search key
     * @param string $locale | Locale to search key
     * @return string
     */
    function get_string( $key , $addon='' , $locale='' )
    {
        if( $locale == '' )
        {
            $locale = $this->curlocale;
        }

        $lang = '';
        if( $addon != '' )
        {
            $localefile = ROSTER_ADDONS . $addon . DIR_SEP . 'locale' . DIR_SEP . $locale . '.php';

            if( file_exists($localefile) )
            {
                include($localefile);
            }
            else
            {
                $enUSfile = str_replace($locale . '.php','enUS.php',$localefile);
                if( file_exists($enUSfile) )
                {
                    include($enUSfile);
                }
            }
        }

        if( isset($lang[$key]) )
        {
            return $lang[$key];
        }
        elseif( isset($this->wordings[$locale][$key]) )
        {
            return $this->wordings[$locale][$key];
        }
        elseif( isset($this->act[$key]) )
        {
            return $this->act[$key];
        }
        else
        {
            return '';
        }
    } 

suggested: $lang = array(); instead of $lang = '', to prevent a notice error when loading roster strings.

Return $key rather than '' if the string isn't found at all (This is default behaviour in memberslist).

Good idea

The new function works beautifully! Thanks guys! I hope the rest of the developer community here finds this useful too.