-
-
Save totten/7c7ddd229962d49f5138 to your computer and use it in GitHub Desktop.
CiviCRM Code Style Example
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
<?php | |
/* | |
+--------------------------------------------------------------------+ | |
| CiviCRM version 4.6 | | |
+--------------------------------------------------------------------+ | |
| Copyright CiviCRM LLC (c) 2004-2014 | | |
+--------------------------------------------------------------------+ | |
| This file is a part of CiviCRM. | | |
| | | |
| CiviCRM is free software; you can copy, modify, and distribute it | | |
| under the terms of the GNU Affero General Public License | | |
| Version 3, 19 November 2007 and the CiviCRM Licensing Exception. | | |
| | | |
| CiviCRM is distributed in the hope that it will be useful, but | | |
| WITHOUT ANY WARRANTY; without even the implied warranty of | | |
| MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. | | |
| See the GNU Affero General Public License for more details. | | |
| | | |
| You should have received a copy of the GNU Affero General Public | | |
| License and the CiviCRM Licensing Exception along | | |
| with this program; if not, contact CiviCRM LLC | | |
| at info[AT]civicrm[DOT]org. If you have questions about the | | |
| GNU Affero General Public License or the licensing of CiviCRM, | | |
| see the CiviCRM license FAQ at http://civicrm.org/licensing | | |
+--------------------------------------------------------------------+ | |
*/ | |
/** | |
* About the class. | |
*/ | |
class CRM_Example_Class { | |
/** | |
* An example property. | |
* | |
* @var int | |
*/ | |
private $property; | |
/** | |
* Do something. | |
* | |
* @param int $whimsy | |
* The amount of whimsy to support. Greater whismy is more random. | |
* | |
* @return int | |
* The whimsically selected value. | |
*/ | |
public function updatePropertyWhimsically($whimsy) { | |
if (rand(0, 100) > 33) { | |
$this->property = rand(0, $whimsy); | |
} | |
else { | |
$this->property = 5 + rand(0, 2 * $whimsy); | |
} | |
return $this->property; | |
} | |
} |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Note: There should be one "\n" at the very end, but this is not apparent in gist.