Plugin / BetterPress

Silas Katzenbach

Description

Description

This is a Plugin for integrationing a charity project of the platform betterplace.org to a WordPress site.

The plugin includes a Widget for displaying different project data.
You can choose the static mode to display one betterplace.org project on every page that displays the choosen widget area.
Also the widget comes along with a dynamic mode in order to display different projects on different pages in the same widget area.

There are sereval display options. It is posible to display just the project and a link to the donation screen or you can display a list of all or a number of needs that belong to the project.

Feature List

  • Display project and project need details of betterplace.org projects
  • Output project and project need progress in sereval ways
  • Add direct links to the donate screen of the project on betterplace.org
  • Easy to use widget
  • Use one widget to display different projects on different pages
  • Progress display (per cent & progress bar)

Upcoming Features

  • Shortcode support
  • Picture display of betterplace.org pictures
  • Multi language support

Arbitrary section

Better Press API Documentation

am_bpProjectController

The am_bpProjectController is the main Object for displaying betterplace.org data. To use it in custom template files just create a new instance, add a betterplace.org ID and use the get methods.

Example:
$bp_projectObject = new am_bpProjectController();
$bp_projectObject->addProject(7910);
echo $bp_projectObject->getProjectTitle();

This will display the Title of the project that has the ID 7910.

You are able to display project needs in the same way.

Example:
$bp_projectObject = new am_bpProjectController();
$bp_projectObject->addProject(7910);
echo $bp_projectObject->getNeedTitle();

This will display the title of the first need of the project that have the ID 7910.

In order to display more than one need you can use the nextProject() method to switch needs. It returns false when no more needs are left:

Example:
$bp_projectObject = new am_bpProjectController();
$bp_projectObject->addProject(7910);
echo ‘

‘.$bp_projectObject->getNeedTitle().’

‘;
do{
echo ‘

‘.$bp_projectObject->getNeedTitle().’

‘;
}while($bp_projectObject->nextProject());

This will display all titles of needs of the project that have the ID 7910.

In order to display more than one project use the method nextProject() in the same way. First you have to add all projects and after that you are able to switch projects:

Example:
$bp_projectObject = new am_bpProjectController();
$bp_projectObject->addProject(7910);
$bp_projectObject->addProject(932);
$bp_projectObject->addProject(1032);
do{
echo ‘

<

h3>’.$bp_projectObject->getProjectTitle().’

<

h3>’;
}while($bp_projectObject->nextProject());

This will display the titles of the Projects that got the ID 768, 932, 1032.

All methods of am_bpProjectController

addProject($id)

Add a betterplace.org project to the stack.

nextProject()

Moves the project pointer to the next project. Returns false if no more projects are on stack.

nextNeed()

Moves the need pointer of the pointed project to the next need. Returns false if no more projects are on stack.

firstProject()

Moves the pointer to the first project on the stack.

getProjectID()

Returns the betterplace.org ID of the project that is pointed.

getProjectTitle()

Returns the title of the pointed project.

getProjectDescription($maxnumber, $option)

Returns the description of the project that is pointed. It acepts two arguments to limitade the description. $option = 0 will limit count of letters that is specified in $maxnumber, $option = 1 limits $maxnumber words.

getProjectAmount($option, $format)

Returns money amounts of the project. If $option = 0 it returns the amount of money that is still needed to fulfil the project. $option = 1 returns the monay that is already donated and $option = 2 is the complete amount that has been requested. The argument $format specified the display of the amount. $format = 1 returns the amount in Euro formated as usual in Europe. If $format = 0 the method returns the complete amount unformated in Cents. $format = 2 returns only the amount of Euros without cent amounts. $format = 3 returns only the amount of Cents like if you would cut the full Euro amounts away.

getProjectProgress()

Returns the progress of the project in per cent.

getProjectLink($option)

Returns links belonging to the project that is pointed. $option = 0 will return the link to the project page. $option = 1 will the link that leds directly to the donation page of the project.

getProjectOpinions($option)

Returns the number of opinions about the project on betterplace.org. If the argument is set to $option = 0 you will get the total number of opinions. If $option is set to 1 you’ll get the number of positive opions, if it is set to 2 you’ll get the count of negative opinions.

getProjectDonors()

Returns the total number of donors which have already donated the pointed project.

getProjectNeedCount()

Returns the number of needs of the project that is pointed.

getNeedID()

Returns the ID of the need that is pointed.

getNeedDate($option)

If $option = 0 this method will return the date of creation of the need. If $option = 1 it will return the date of the last update of the need.

getNeedTitle()

This method returns the title of the pointed need.

getNeedDescription($maxnumber, $option)

Returns the description of the need that is pointed. It acepts two arguments to limitade the description. $option = 0 will limit count of letters that is specified in $maxnumber, $option = 1 limits $maxnumber words of the need.

getNeedProgress()

Returns the progress of the pointed need in per cent.

getNeedAmount($option, $format)

Returns money amounts of the need. If $option = 0 it returns the amount of money that is still needed to fulfil the need. $option = 1 returns the monay that is already donated and $option = 2 is the complete amount that has been requested. The argument $format specified the display of the amount. $format = 1 returns the amount in Euro formated as usual in Europe. If $format = 0 the method returns the complete amount unformated in Cents. $format = 2 returns only the amount of Euros without cent amounts. $format = 3 returns only the amount of Cents like if you would cut the full Euro amounts away.

iscompletedNeed()

This method returns true, if the need is already completed.

DIRECTORY DISCLAIMER

The information provided in this THEME/PLUGIN DIRECTORY is made available for information purposes only, and intended to serve as a resource to enable visitors to select a relevant theme or plugin. wpSocket gives no warranty of any kind, express or implied with regard to the information, including without limitation any warranty that the particular theme or plugin that you select is qualified on your situation.

The information in the individual theme or plugin displayed in the Directory is provided by the owners and contributors themselves. wpSocket gives no warranty as to the accuracy of the information and will not be liable to you for any loss or damage suffered by you as a consequence of your reliance on the information.

Links to respective sites are offered to assist in accessing additional information. The links may be outdated or broken. Connect to outside sites at your own risk. The Theme/Plugin Directory does not endorse the content or accuracy of any listing or external website.

While information is made available, no guarantee is given that the details provided are correct, complete or up-to-date.

wpSocket is not related to the theme or plugin, and also not responsible and expressly disclaims all liability for, damages of any kind, arising out of the use, reference to, or reliance on, any information or business listed throughout our site.

Keep Leading Your Followers!
Share it for them.