phpDocumentor GalleryCore
PHPUnit
[ class tree: GalleryCore ] [ index: GalleryCore ] [ all elements ]

Class: CodeAuditTest

Source Location: /modules/core/test/phpunit/CodeAuditTest.class

Class CodeAuditTest

Class Overview

Scan through all of our source code and verify that we're not doing anything \"bad\".

Checks for style guidelines too.

Located in /modules/core/test/phpunit/CodeAuditTest.class [line 37]

TestCase
   |
   --GalleryTestCase
      |
      --CodeAuditTestCase
         |
         --CodeAuditTest

Methods

[ Top ]
Inherited Properties, Constants, and Methods
Inherited Properties Inherited Methods Inherited Constants

Inherited From GalleryTestCase

GalleryTestCase::$_cleanup

Inherited From CodeAuditTestCase

CodeAuditTestCase::CodeAuditTestCase()
CodeAuditTestCase::checkFile()
Overload this method in subclasses to audit the file.
CodeAuditTestCase::finishScan()
Overload this method in subclasses to run any tasks after the scan is complete.
CodeAuditTestCase::getFunctionCalls()
Extract function calls from a php snippet.
CodeAuditTestCase::getFunctionParameters()
Parse a function call into parameters.
CodeAuditTestCase::halt()
Subclasses can call this to stop scanning.
CodeAuditTestCase::shouldCheckFile()
Overload this method in subclasses. If this method returns true, we'll call checkFile on it.
CodeAuditTestCase::testCodeAudit()
CodeAuditTestCase::_getNextTokenIndex()
Get the next PHP token omitting whitespace tokens.
CodeAuditTestCase::_scanDir()
CodeAuditTestCase::_scanNonXmlDir()
CodeAuditTestCase::_scanXmlDir()
CodeAuditTestCase::_timeCheck()
Keep this test running.

Inherited From GalleryTestCase

GalleryTestCase::GalleryTestCase()
GalleryTestCase::assert()
GalleryTestCase::assertEquals()
GalleryTestCase::assertErrorEquals()
Fail if the provided GalleryStatus object does not contain the given error code.
GalleryTestCase::assertEventFired()
Fail if the provided event name was not fired.
GalleryTestCase::assertEventNotFired()
Fail if the provided event name was fired
GalleryTestCase::DeepCompare()
GalleryTestCase::failWithStatus()
This is deprecated in Gallery 2.3 -- now tests should just return $ret and let the framework generate the right failure message.
GalleryTestCase::getEntityCounter()
Get the entity counter listener which contains the types and number of elements deleted.
GalleryTestCase::setUp()
GalleryTestCase::tearDown()
GalleryTestCase::_array_unshift_key_value()
Utility method to array_unshift a single key => value pair.
GalleryTestCase::_becomeGuestUser()
GalleryTestCase::_createDerivative()
GalleryTestCase::_createLinkedItem()
Create a random link item
GalleryTestCase::_createRandomAlbum()
Create a random album
GalleryTestCase::_createRandomDataItem()
Create a random data item
GalleryTestCase::_createRandomGroup()
Create a random group
GalleryTestCase::_createRandomUser()
Create a random user
GalleryTestCase::_createUser()
GalleryTestCase::_deleteAndVerifyEntity()
GalleryTestCase::_disableUserName()
Convenience method to mark a username as disabled.
GalleryTestCase::_getRootId()
GalleryTestCase::_getUnusedId()
Get an id that is not used for anything.
GalleryTestCase::_initEventListenersForTest()
Disable all but some core event listeners by default.
GalleryTestCase::_markEventListenersForCleanup()
Create a backup of the registered event listeners which will be restored in tearDown.
GalleryTestCase::_markFactoryForCleanup()
Create a backup of the factory data which will be restored in tearDown.
GalleryTestCase::_markFactoryModuleForCleanup()
GalleryTestCase::_markForCleanup()
GalleryTestCase::_markPluginParametersForCleanup()
Store plugin parameters to be restored in tearDown
GalleryTestCase::_markToolkitForCleanup()
GalleryTestCase::_registerEventListener()
Register a The NullEventListener for a test
GalleryTestCase::_registerFactoryImplementationForTest()
Register a factory implementation temporarily for this test.
GalleryTestCase::_registerTestEventListener()
Register and event name and associated listener (deprecated).
GalleryTestCase::_setMarkupType()
Set core parameter for markup type.
GalleryTestCase::_signUrl()
Adds an authToken to the given URL
GalleryTestCase::_unregisterFactoryImplementationForTest()
Unregister a specific factory implementation or all implementations of a spefific type temporarily for this test.
GalleryTestCase::_verifyEntity()
GalleryTestCase::_verifyFields()
GalleryTestCase::_verifyMissing()

[ Top ]
Method Summary
CodeAuditTest   CodeAuditTest()  
void   checkFile()  
void   checkPreamble()  
void   getPreamble()  
void   shouldCheckFile()  
void   testCodeAudit()  

[ Top ]
Methods
Constructor CodeAuditTest  [line 39]

  CodeAuditTest CodeAuditTest( $methodName  )

Parameters:
   $methodName: 


[ Top ]
checkFile  [line 182]

  void checkFile( $fileName, $buffer  )

Parameters:
   $fileName: 
   $buffer: 

API Tags:
See:  CodeAuditTestCase::checkFile


Redefinition of:
CodeAuditTestCase::checkFile()
Overload this method in subclasses to audit the file.

[ Top ]
checkPreamble  [line 404]

  void checkPreamble( $fileName, $buffer, $lines  )

Parameters:
   $fileName: 
   $buffer: 
   $lines: 


[ Top ]
getPreamble  [line 431]

  void getPreamble( $lines  )

Parameters:
   $lines: 


[ Top ]
shouldCheckFile  [line 135]

  void shouldCheckFile( $fileName  )

Parameters:
   $fileName: 

API Tags:
See:  CodeAuditTestCase::shouldCheckFile


Redefinition of:
CodeAuditTestCase::shouldCheckFile()
Overload this method in subclasses. If this method returns true, we'll call checkFile on it.

[ Top ]
testCodeAudit  [line 447]

  void testCodeAudit( )


API Tags:
See:  CodeAuditTestCase::testCodeAudit


Redefinition of:
CodeAuditTestCase::testCodeAudit()

[ Top ]

Documentation generated on Fri, 08 Oct 2010 04:41:48 -0700 by phpDocumentor 1.3.0RC6