PHPExcel Check if sheet exists

Question

I am using phpExcel, and I can't find anything to check if a sheet exists. What I would like to accomplish is something like this:

if(!$excel->sheetExists(1)){
    $excel->createSheet(1);
    $sheet = $excel->setSheet(1);
}
// Do some stuff with the sheet

So. My question: How can I check if a sheet exists?

Edit

Would this work?

try{
    $sheet = $this->excel->setActiveSheetIndex(1);
}catch(Exception $e){
    $excel->createSheet(1);
    $sheet = $excel->setActiveSheetIndex(1);
}

score 33 · Accepted Answer · answered Mar 12 '13 at 15:47

If you simply want to know whether a sheetexists at index 1, then

$sheetCount = $excel->getSheetCount();

will return a count of the worksheets. As sheets are indexed incrementally from 0, then a sheet at index 1 will only exist if the count is 2 or more.

If you want to know whether a named sheet exists, then

$sheetNames = $excel->getSheetNames();

will return an array of sheet names (indexed by their index position), and you can then test using in_array();

The

$excel->getSheet()

method will throw an exception if the requested sheet (by index) doesn't exist, so wrap it in a try/catch block would be another approach

$excel->getSheetByName()

returns a NULL value if the named worksheet doesn't exist

I updated my question with a try catch. Its not the same as the `getSheet` but it is similar. — Get Off My Lawn, Mar 12 '13 at 15:56
It would work, yes.... one of the great things about open source libraries is that you can actually look at the code and see yourself what it does — Mark Baker, Mar 12 '13 at 15:59

score 3 · Answer 2 · answered Mar 12 '13 at 15:48

3

You can check if a sheet exists by name with the method sheetNameExists($pSheetName).

answered Mar 12 '13 at 15:48

Chris L

616
1
5
11

score 1 · Answer 3 · answered Mar 12 '13 at 15:45

1

getSheet($sheetNumber) is how you check if a sheet exists.

answered Mar 12 '13 at 15:45

Matt

5,315
1
30
57

score 0 · Answer 4 · answered Dec 23 '14 at 20:27

0

Yes your code will also work:

try {
        $objWorksheet =  $objPHPExcel->setActiveSheetIndex(1); 
}
catch (Exception $e) {
    echo 'Sheet is not exists!';
}

answered Dec 23 '14 at 20:27

Biswadeep Sarkar

841
9
17

score 0 · Answer 5 · answered Jun 26 '19 at 08:38

0

$sheet=$excel->getSheet(1);
// or you can get sheet by name $sheet=$excel->getSheetByName("Sheet1");
if(!empty($sheet)&&is_object($sheet)){
      //sheet already exist
}else{
      //sheet does not exist. Write your code here!
}

answered Jun 26 '19 at 08:38

ashraf mohammed

1,322
15
20

score 0 · Answer 6 · answered Mar 09 '20 at 05:46

0

"TO KNOW THE PRESENT ACTIVE SHEET NUMBER(INDEX)" $this->activeSheet->getActiveSheetIndex()

NOTE: $loadExcel=PHPExcel_IOFactory::load("excelSheetName.xlsx"); $this->activeSheet=$loadExcel;

answered Mar 09 '20 at 05:46

pala dattadri

21
2

PHPExcel Check if sheet exists

6 Answers6

Linked