tonyair/silverstripe-framework
1
0
Fork 0
mirror of https://github.com/silverstripe/silverstripe-framework synced 2024-10-22 14:05:37 +02:00
Code Issues Projects Releases Wiki Activity

converted TODO into @todo for better PHPDocumentor support

Browse Source 
git-svn-id: svn://svn.silverstripe.com/silverstripe/open/modules/sapphire/trunk@47884 467b73ca-7a2a-4603-9d3b-597d59a354a9
This commit is contained in:
Ingo Schommer 2008-01-11 01:49:50 +00:00
parent 2427c0c50c
commit 9a36047021
16 changed files with 31 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
api/RestfulService.php
View File

@ -44,7 +44,7 @@ class RestfulService extends ViewableData {
/**
* Connects to the RESTful service and gets its response.
* TODO implement authentication via cURL for
* @todo implement authentication via cURL for
*/
function connect(){

2
core/ArrayData.php
View File

@ -56,7 +56,7 @@ class ArrayData extends ViewableData {
* Converts an object with simple properties to
* an associative array.
*
* TODO Allow for recursive creation of DataObjectSets when property value is an object/array
* @todo Allow for recursive creation of DataObjectSets when property value is an object/array
*
* @param obj $obj
* @return array

8
core/control/FormResponse.php
View File

@ -25,8 +25,8 @@
* - Please DON'T escape literal parameters which are passed to FormResponse, they are escaped automatically.
* - Some functions assume a {LeftAndMain}-based environment (e.g. load_form())
*
* TODO Force a specific execution order ($forceTop, $forceBottom)Ω
* TODO Extension to return different formats, e.g. JSON or XML
* @todo Force a specific execution order ($forceTop, $forceBottom)Ω
* @todo Extension to return different formats, e.g. JSON or XML
*
* @package forms
* @subpackage core
@ -107,7 +107,7 @@ class FormResponse {
*
* @param $scriptContent string
*
* TODO Should this content be escaped?
* @todo Should this content be escaped?
*/
static function add($scriptContent, $uniquenessID = null) {
if(isset($uniquenessID)) {
@ -219,7 +219,7 @@ class FormResponse {
* @param $replaceMethod string Method for replacing - either 'replace' (=outerHTML) or 'update' (=innerHTML)
* (Caution: "outerHTML" might cause problems on the client-side, e.g. on table-tags)
*
* TODO More fancy replacing with loading-wheel etc.
* @todo More fancy replacing with loading-wheel etc.
*/
static function update_dom_id($domID, $domContent, $reapplyBehaviour = true, $replaceMethod = 'replace', $uniquenessID = null) {
//self::$non_ajax_content = $domContent;

2
core/model/DataObject.php
View File

@ -861,7 +861,7 @@ class DataObject extends Controller implements DataObjectInterface {
* @param string $componentName Name of the many-many component
* @return ComponentSet The set of components
*
* TODO Implement query-params
* @todo Implement query-params
*/
public function getManyManyComponents($componentName, $filter = "", $sort = "", $join = "", $limit = "", $having = "") {
if(isset($this->components[$componentName])) return $this->components[$componentName];

4
core/model/DataObjectSet.php
View File

@ -64,7 +64,7 @@ class DataObjectSet extends ViewableData implements Iterator {
/**
* Create a new DataObjectSet. If you pass one or more arguments, it will try to convert them into {@link ArrayData} objects.
* TODO Does NOT automatically convert objects with complex datatypes (e.g. converting arrays within an objects to its own DataObjectSet)
* @todo Does NOT automatically convert objects with complex datatypes (e.g. converting arrays within an objects to its own DataObjectSet)
*
* @param ViewableData|array|mixed $items Parameters to use in this set, either as an associative array, object with simple properties, or as multiple parameters.
*/
@ -643,7 +643,7 @@ class DataObjectSet extends ViewableData implements Iterator {
/**
* Returns the dataset as an array of ID => Title.
*
* TODO Duplication from toDropdownMap()
* @todo Duplication from toDropdownMap()
*
* @param string $key The field you wish to use as a key for the array
* @param string $value The field or method you wish to use to get values for the map

2
core/model/Hierarchy.php
View File

@ -524,7 +524,7 @@ class Hierarchy extends DataObjectDecorator {
* Get the next node in the tree of the type. If there is no instance of the className descended from this node,
* then search the parents.
*
* TODO Write!
* @todo Write!
*/
public function naturalPrev( $className, $afterNode = null ) {
return null;

4
forms/BankAccountField.php
View File

@ -79,7 +79,7 @@ class BankAccountField extends FormField {
}
/**
* TODO Very basic validation at the moment
* @todo Very basic validation at the moment
*/
function jsValidation() {
$formID = $this->form->FormName();
@ -133,7 +133,7 @@ JS;
}
/**
* TODO Very basic validation at the moment
* @todo Very basic validation at the moment
*/
function validate($validator){
$valid = preg_match(

2
forms/ComplexTableField.php
View File

@ -183,7 +183,7 @@ JS;
* so even if a single record is displayed in a popup, we need the results
* to make pagination work.
*
* TODO Merge with more efficient querying of TableListField
* @todo Merge with more efficient querying of TableListField
*/
function sourceItems() {
if($this->sourceItems) {

14
forms/DataReport.php
View File

@ -95,7 +95,7 @@ class DataReport extends FormField {
}*/
/**
* Todo: to set export flag to be $export
* @todo: to set export flag to be $export
*/
public function setExport($export){
$this->export = $export;
@ -110,7 +110,7 @@ class DataReport extends FormField {
}
/**
* Todo: to overwrite its parent's FieldHolder, the returned HTML <div> section contains the reported Table and a export button.
* @todo: to overwrite its parent's FieldHolder, the returned HTML <div> section contains the reported Table and a export button.
*/
function FieldHolder() {
//Requirements::javascript( "sapphire/javascript/DataReport.js" );
@ -129,7 +129,7 @@ HTML
}
/**
* Todo: to return a export button in HTML Style if $this->export flag is true (it defaults as true)
* @todo: to return a export button in HTML Style if $this->export flag is true (it defaults as true)
*/
protected function htmlExportButton(){
$idexport = $this->id() . '_exportToCSV';
@ -187,7 +187,7 @@ HTML
/**
* Todo: Returns the HTML for the headers of the columns.
* @todo: Returns the HTML for the headers of the columns.
*/
protected function columnheaders( $rowCallBack = 'htmlTableRow', $cellCallBack = 'htmlTableHeadCell' ) {
$html = "";
@ -229,21 +229,21 @@ HTML
}
/**
* Todo: Return the HTML for one cell of the table header
* @todo: Return the HTML for one cell of the table header
*/
function htmlTableHeadCell($value) {
return "<th>" . htmlentities( $value ) . "</th>";
}
/**
* Todo: Return one cell of the table header in csv format
* @todo: Return one cell of the table header in csv format
*/
function csvHeadCell($value) {
return $this->csvCell( $value );
}
/**
* Todo: Return the HTML for one cell of one row of the table
* @todo: Return the HTML for one cell of one row of the table
*/
function htmlTableDataCell($record, $field, $fieldIndex=null){
$value = $this->getRecordFieldValue($record, $field);

2
forms/EditableFormField.php
View File

@ -141,7 +141,7 @@ class EditableFormField extends DataObject {
/**
* Return an evaluation appropriate for a filter clause
* TODO: escape the string
* @todo: escape the string
*/
function filterClause( $value ) {
// Not filtering on this field

2
forms/FieldGroup.php
View File

@ -59,7 +59,7 @@ class FieldGroup extends CompositeField {
* Returns a set of <span class="subfield"> tags, each containing a sub-field.
* You can also use <% control FieldSet %>, if you'd like more control over the generated HTML
*
* TODO Shouldn't use SmallFieldHolder() (very difficult to style),
* @todo Shouldn't use SmallFieldHolder() (very difficult to style),
* it is easier to overwrite the <div class="field"> behaviour in a more specific class
*/
function Field() {

4
forms/FormField.php
View File

@ -19,7 +19,7 @@ class FormField extends ViewableData {
/**
* @var $description string Adds a "title"-attribute to the markup.
* TODO Implement in all subclasses
* @todo Implement in all subclasses
*/
protected $description;
@ -245,7 +245,7 @@ class FormField extends ViewableData {
* is the DefaultFieldHolder template. This lets you override the HTML for specific sites, if it's
* necessary.
*
* TODO Add "validationError" if needed.
* @todo Add "validationError" if needed.
*/
function FieldHolder() {
$Title = $this->XML_val('Title');

4
forms/PhoneNumberField.php
View File

@ -110,7 +110,7 @@ class PhoneNumberField extends FormField {
}
/**
* TODO Very basic validation at the moment
* @todo Very basic validation at the moment
*/
function jsValidation() {
$formID = $this->form->FormName();
@ -155,7 +155,7 @@ JS;
}
/**
* TODO Very basic validation at the moment
* @todo Very basic validation at the moment
*/
function validate($validator){
$valid = preg_match(

6
forms/TableListField.php
View File

@ -110,7 +110,7 @@ class TableListField extends FormField {
* @var $customSourceItems DataObjectSet Use the manual setting of a result-set only as a last-resort
* for sets which can't be resolved in a single query.
*
* TODO: Add pagination support for customSourceItems.
* @todo: Add pagination support for customSourceItems.
*/
protected $customSourceItems;
@ -734,7 +734,7 @@ JS
* Search
* #################################
*
* TODO Not fully implemented at the moment
* @todo Not fully implemented at the moment
*/
/**
@ -776,7 +776,7 @@ JS
* Exports a given set of comma-separated IDs (from a previous search-query, stored in a HiddenField).
* Uses {$csv_columns} if present, and falls back to {$result_columns}.
*
* TODO Make relation-syntax available (at the moment you'll have to use custom sql)
* @todo Make relation-syntax available (at the moment you'll have to use custom sql)
*/
function export() {

2
forms/Validator.php
View File

@ -10,7 +10,7 @@
* the use of Required fields.
* Relies on javascript for client-side validation, and marking fields after serverside validation.
*
* TODO Automatically mark fields after serverside validation and replace the form through
* @todo Automatically mark fields after serverside validation and replace the form through
* FormResponse if the request was made by ajax.
*
* @package forms

2
parsers/HTML/HTMLBBCodeParser.php
View File

@ -327,7 +327,7 @@ class SSHTMLBBCodeParser
* $_preparsed variable. The method uses _buildTag() to check if a tag is
* valid and to build the actual tag to be added to the tag array.
*
* TODO: - rewrite whole method, as this one is old and probably slow
* @todo: - rewrite whole method, as this one is old and probably slow
* - see if a recursive method would be better than an iterative one
*
* @return none