PHPLeague for WP – Documentation

Welcome on the PHPLeague’s Documentation…

Introduction

First of all, you are strongly recommended to install the latest version of PHPLeague for WordPress. As we speak, the version tagged 1.2.5 is the latest available.

How to create a League?

Once you’ve installed and activated the Plugin, you’ll see a new menu called PHPLeague in your back-end. That menu has 4 sub-menus in the Core Edition. We’ll discuss about each of those sub-menus later.

Now, we want to create our first league so let’s do it! Go on the PHPLeague’s dashboard and his tab “New League”. You have 2 options in front of you. PHPLeague for WP is smart enough to detect duplicate in the database, so, don’t worry if you try to create twice the exact same league by mistake, you would not be authorized to save it.

Make sure that your league’s name follow the required pattern which is a name longer than 3 characters and only alphanumeric (spaces, dot and dashes are authorized as well). Concerning the year, you have no choice. It must absolutely follow the 4 figures (2008 for 2008/09) rule in order to create your league.

If you follow those rules, your league must be now created and available in your dashboard.

How to create a Club?

We got our first league, so, now it is time to add some clubs inside, don’t you think? In order to do that, you must go in the Clubs sub-menu and his tab “New Club”.

Same procedure than before, you need to respect the pattern to save your club successfully. Your club will now be available in the “Overview” tab. To edit any club, simply click on his name to get the club’s edition mode. You might receive an error message when you’re trying to save the club’s information concerning the coach or venue names. It’s normal…if you let those inputs empty. If you want to make any changes here, you’re required to fill in those inputs with the traditional pattern (alphanumeric and at least 3 characters).

Are you done with the club’s creation? Let’s move on to the next step…

How to add my club in a league?

Comeback to your dashboard and click on “Teams”. All clubs will appear at the top. Select every club (individually) you want to incorpore in your league and click on send. Once the club has been added in the league, you’ll see him at the bottom in a table.

Be aware that you can’t add the same club twice in a league! In order to help you, a pagination system is available and will be displayed if you got more than 10 teams in your league. Nobody likes scrolling down.

Next to your send button, the number of teams currently in your league will be displayed. This might be helpful if you’ve a league with many teams.

You made a mistake and want to remove a club from a league? Don’t worry! Select your club(s) through the corresponding checkbox and click on the “Remove” button. You club’s counter will instantly be updated with the new figure.

You can have an odd or an even numbers of teams, PHPLeague should be smart enough to deal with it…or not.

Last but not least, don’t comeback in here to remove club(s) once you’ve started to insert matches and results in your league. It might broke your data and you won’t that…

How to add Fixtures?

Now that we got all the teams in our league, we need to add the fixtures’ dates. At the moment, the system don’t compare your data, so, if you don’t order the date yourself, don’t expect that PHPLeague will do it for you…yet.

By default, PHPLeague thinks that every team is playing each others twice. If you want to modify this behavior, you must go in the league’s “Settings” section to change the corresponding option.

How to add our Matches?

Now that our fixtures are set up, we need to fill in our matches database. According to what I’ve observed, you must be fine with the auto-generated inputs. If you encounter anything unusual, let me know.

If you’re trying to add a team both in home and away, the system will detect it and give you a notice. The same will happen if you add twice a team in a fixture. There is no possibility to add a team twice by fixture. Sorry, that’s the way it is…

If you have an odd number of teams, the system will automatically remove an input in order to reduce the number of matches by one. Every fixture, a team won’t be playing.

How to add our Results?

Be aware that if you don’t insert any data in the previous section, you won’t be able to add any results. How would it be possible to add a result into a non-existing match…

You don’t have to add all the matches in once but as long as you want to add the results, you’ll be required to have the corresponding matches created in your database.

Almost done, let’s have a look to the Settings

In here, you can change the name or the year of your league. You can also modify the default value entered when the league was created.

It’s very important that you don’t forget to add a favorite team in your league especially if you want to display the fixtures. Without any “id_team” in your shortcode, PHPLeague assume that you want to display the fixtures of your favorite team. If it doesn’t exist, nothing will be returned and showed in your front-end.

If you need to add or remove some points in a team, you can do that in the Bonus/Malus section. If you need to add 3 bonus points, add those “3″ points in the corresponding box. If you need to remove 3 points, do it by adding “-3″ in the box.

I’m done, how to show it to the world?

Before going to the editor mode to add your league, you’ll be required to generate the ranking table. To do it, go back in your dashboard and click on the “Generate” link. Your table will be generated with all the data you filled in previously (even the bonus/malus). The table will be displayed on your screen with – hopefully – a little message saying that everything went fine…or not.

Last step! Go to your post editor and you’ll see a new button if you’ve the permission (everybody should be able to do it). Click on the PHPLeague button, select the data you want to add in the post and you’re done!

More information about the different options in the editor mode are available in your “About” sub-menu. If by any chance, you discover a bug or something unusual during any steps of the process, please, let me know.

Last update: 22/09/2011

One thought on “PHPLeague for WP – Documentation

  1. Pingback: PHPLeague for WP - A Release and a new Documentation - Mikaweb Design, Ltd

Leave a Reply