Remerciez-le!

Remerciez @Admin pour avoir partagé cet document gratuitement, de la manière la plus simple, en partageant sur les réseaux sociaux.

P H PA D S N E W / D E V E L O P E R G U I D E 1 D E V E L O P E R G U I D E ph

P H PA D S N E W / D E V E L O P E R G U I D E 1 D E V E L O P E R G U I D E phpAdsNew P H PA D S N E W / D E V E L O P E R G U I D E 2 Contributing ....................................................................................................................................................... 3 Extending phpAdsNew Coding style ................................................................................................................................................. 5 Database abstraction ................................................................................................................................. 6 File naming .................................................................................................................................................. 7 Translating phpAdsNew Introduction ............................................................................................................................................... 10 I N D E X P H PA D S N E W / D E V E L O P E R G U I D E 3 C O N T R I B U T I N G If you don’t have write access to the CVS and still want to contribute code, you can create an new entry in the Patches tracker. If you want to have write access to the CVS, please contact the project admin. All developers are encouraged to track and fix bugs. If you want to fix a specific bug listed in the Bug Tracker or forum, please assign the bug to yourself or post a comment simi- lar to this: “I’ll look into it”. This prevents that multiple people are working on the same problem and doing the same thing twice. If you want to create a new feature, please con- tact the project admin first or post a message in one of the forums. Perhaps somebody is already working on the same feature and it would be a shame if the same feature gets implemented twice. When creating new features, please take the following in mind: phpAdsNew can’t please everybody and doesn’t try to please everybody. If a certain feature is created for a spe- cific situation it isn’t likely to be included. If the feature only pleases a small group of users and causes a lot of problems for the majority it will be less likely this feature will be included in the main distribution. However if you feel the feature will benefit a lot of users we are more than happy to include it. Using the CVS If you made a change in the CVS, please also add an entry to the Changelog file. Don’t forget to add your name and the date of the change. If you commit a new feature, and find a bug in it, you don’t need to add the bugfix to the Changelog, unless the bug already existed in a previous release or development build. The Changelog is used to document the changes between releases and is not intended as a complete log of all CVS operations. P H PA D S N E W / D E V E L O P E R G U I D E 4 E X T E N D I N G P H PA D S N E W P H PA D S N E W / D E V E L O P E R G U I D E 5 C O D I N G S T Y L E PHP code All PHP code should be placed between <?php and ?> tags. Do not use the short version <? ?>, because this isn’t supported by every installation of PHP. If you want to print a variable inside of plain HTML, use <?php echo $var; ?> instead of <?= $var ?>. phpAdsNew should be PHP3 compatible, if you are not sure a function is available in PHP 3, please check the manual: http://www.php.net/manual/en Function and variable naming All functions, defines and global variables should use the phpAds_ prefix. This will pre- vent problems with duplicate names if phpAdsNew is used in combination with another product. Variables which are only used inside the scope of a function can use any name and should NOT use the phpAds_ prefix. $i = 0; ý used in global scope, so use prefix $phpAds_link = 0; þ function doSomething () ý used in global scope, so use prefix { } function phpAds_doSomething () þ { global $phpAds_link; $i = 0; þ $phpAds_i = 0; ý only used in function, don’t use prefix $phpAds_link = 0; þ used in global scope, so use prefix } P H PA D S N E W / D E V E L O P E R G U I D E 6 D ATA B A S E A B S T R A C T I O N phpAdsNew will open the database connection automatically. It is not needed to use the phpAds_dbConnect() function or mysql_connect(). It is also not needed to close the data- base connection, phpAdsNew will take care of this as well. To make porting to other databases easier all MySQL specific functions are replaced by small functions with the same functionality: mysql_query phpAds_dbQuery mysql_num_rows phpAds_dbNumRows mysql_fetch_array phpAds_dbFetchArray mysql_fetch_row phpAds_dbFetchRow mysql_result phpAds_dbResult mysql_free_result phpAds_dbFreeResult mysql_affected_rows phpAds_dbAffectedRows mysql_data_seek phpAds_dbSeekRow mysql_insert_id phpAds_dbInsertID * mysql_error phpAds_dbError * * Functionality has changed. You don’t need to specify the link identifier. phpAdsNew will store the link identifier when it created the connection and will automatically use this link identifier when calling these functions. P H PA D S N E W / D E V E L O P E R G U I D E 7 F I L E N A M I N G Filenames It is also important to make sure the files is named correctly. File naming will make it easier for other users to determine the function of the file. Instead of using myfile.php use a descriptive name using the following conventions: adxxx.php Files directly called during invocation. For example: adview.php, adjs.php and adframe.php lib-xxx.inc.php Library files used by other scripts. For example: lib-gui.inc.php, lib-ftp.inc.php, lib-sessions.inc.php xxx-xxx.php Files directly called in the admin interface. These files should be grouped, for example all files dealing with zones use the zone- prefix, all files dealing with statistics use the stats- prefix. If the file is a general file, can’t be easily placed in a group it should use the admin- prefix. For example: banner-edit.php, banner-delete.php, banner-acl.php. xxx.plugin.php Plugins used by the report engine. For example: campaignoverview.plugin.php, campaignhistory.plugin.php xxx.lang.php Files containing translated strings. These files are stored inside a different directory for each supported language. For example: default.lang.php, settings.lang.php All files which include PHP code, should have the .php extention. 8 P H PA D S N E W / D E V E L O P E R G U I D E Locations If you need to create a new file, you need to make sure it is stored in the right location with the correct name. Currently there are a couple of important locations: / Only files needed during invocation should be placed in the main directory. This includes main libraries and invocation files. /admin All files which are needed only for the admin interface should be placed in the admin directory (excluding images). If your file is used by both the admin interface and during invocation it should be placed in the main directory. /admin/images All generic images should be placed inside the images directory. Do not place any other files in this directory. /admin/images/rtl All images which are created for right-to-left languages are stored inside this directory. /admin/images/ltr All images which are created for left-to-right languages are stored inside this directory. /admin/report-plugins All plugins used by the report engine should be stored in this directory. /admin/templates Small HTML files which can be edited by the user, for example the welcome message for advertisers. /documentation Storage for the documentation /language This directory contains a directory for each different language phpAdsNew supports. In each language specific directory the main language file is called default.lang.php. Installation translations are stored inside settings.lang.php. /maintenance All files used by the maintenance task should be placed inside the maintenance directory, excluding any libraries used by the maintenance task. /misc This directory contains the default configuration file template and the database structure. P H PA D S N E W / D E V E L O P E R G U I D E 9 T R A N S L AT I N G P H PA D S N E W P H PA D S N E W / D E V E L O P E R G U I D E 1 0 I N T R O D U C T I O N phpAdsNew includes support for many languages. All of the language are supplied by users of phpAdsNew who have translated it themselves. If you speak a language which isn’t yet supported by phpAdsNew we would greatly appriciate it if you could translate phpAdsNew in your native language. All language specific files are location in the language directory and are located in seper- ated sub directories. Currently there are three files which contain language specific strings and each file targets a specific section of phpAdsNew. Requirements uploads/S4/ developer-guide 1 .pdf