Server Manager extension documentation

[boxbilling]

Server Manager extension documentation

Which server manager are you trying to implement?

[bpadmin]

ISPCP. (NOT ISPConfig). It does not have an official API yet. What directory do I manage event processing against? Do you have any code examples to look at?

This guide will help you develop your own server manager extension.

Server manager extension consists of one php class. Your server manager class has to extend Server_Manger abstract class. To find out what methods must be implemented in your new extension examine Server_Manager class located at bb-library/Server/Manager.php file

Almost all class methods receives Server_Account parameter. Examine bb-library/Server/Account.php file to see what methods are available for the Server_Account object.

This code https://gist.github.com/1801871 will help you understand the concept of server manager class. Read methods comments for detailed description.

[bpadmin]

What directory do i put event listeners in?

[bpadmin]

when using hooks what functions/events can I use? The documentation refers to old events for the previous release. What are the new naming standards for this release?

[bpadmin]

Can you provide a example hook to email admin when a new client signs up, please?

These are the new hook events. Just copied from upcoming documentation. Currently without descriptions, but should be self explanatory.

onAfterAdminCloseTicket
onAfterAdminInvoiceDelete
onAfterAdminInvoiceRefund
onAfterAdminInvoiceUpdate
onAfterAdminLogin
onAfterAdminOpenTicket
onAfterAdminPublicTicketClose
onAfterAdminPublicTicketOpen
onAfterAdminPublicTicketReply
onAfterAdminReplyTicket
onAfterAdminSubscriptionCreate
onAfterAdminSubscriptionDelete
onAfterClientCloseTicket
onAfterClientCreateForumTopic
onAfterClientLogin
onAfterClientOpenTicket
onAfterClientPasswordResetConfirm
onAfterClientPasswordResetRequest
onAfterClientProfileUpdate
onAfterClientPublicTicketClose
onAfterClientPublicTicketOpen
onAfterClientPublicTicketReply
onAfterClientReplyTicket
onAfterClientSignUp
onBeforeAdminClientDelete
onBeforeAdminClientPasswordChange
onBeforeAdminClientUpdate
onBeforeAdminDeleteCurrency
onBeforeAdminInvoiceApprove
onBeforeAdminInvoiceDelete
onBeforeAdminInvoiceRefund
onBeforeAdminInvoiceSendReminders
onBeforeAdminInvoiceUpdate
onBeforeAdminOpenTicket
onBeforeAdminPublicTicketOpen
onBeforeAdminSettingsUpdate
onBeforeAdminStaffApiKeyChange
onBeforeAdminStaffCreate
onBeforeAdminStaffDelete
onBeforeAdminStaffPasswordChange
onBeforeAdminStaffProfilePasswordChange
onBeforeAdminStaffProfileUpdate
onBeforeAdminStaffUpdate
onBeforeClientCheckout
onBeforeClientOpenTicket
onBeforeClientProfilePasswordChange
onBeforeClientProfileUpdate
onBeforeClientPublicTicketOpen
onBeforeClientSignUp

Your hook to email admin when client signs up could look like this:

<?php
class Hook_Bpadmin
{
    public static function onAfterClientSignUp(Box_Event $event)
    {
        mail('[email protected]', 'New client signed up', 'I have received new client signup');
    }
}

Place it to bb-library/Hook/Bpadmin.php